TenantDto

The record of one portal: its name, owner, language, time zone and lifecycle state.

Name	Type	Description	Notes
affiliateId	String	The partner the portal was signed up through, empty for a portal that came in directly. It is bookkeeping for the vendor and has no bearing on what the portal may do.	[optional] [example: AFF12345] [nullable]
tenantAlias	String	The portal's own name within the installation, which together with the installation's base domain forms the address it is reached at. A caller without the portal-settings right gets tenantId alone, so an empty value here is the sign that the rest of this object was withheld rather than unset.	[optional] [example: my-company] [nullable]
calls	Boolean	Whether telephony is switched on for the portal. It is carried over from portal registration and stays false on a DocSpace portal, where the feature does not exist.	[optional] [example: true]
campaign	String	The marketing campaign the portal was signed up under, empty for a portal that came in outside one. Like affiliateId, it is bookkeeping only.	[optional] [example: WINTER2024] [nullable]
creationDateTime	Date (date-time)	When the portal was created, in UTC rather than in the portal time zone.	[optional] [example: 2024-01-15T10:30:00Z]
hostedRegion	String	The data-centre region written on the portal record itself, as opposed to region, which is looked up from the hosting service. It is empty on a server installation.	[optional] [example: EU] [nullable]
tenantId	Integer (int32)	The numeric identifier of the portal inside the installation. It is the one field every caller gets, whatever their rights.	[optional] [example: 1]
industry	TenantIndustry	The line of business chosen when the portal was created. It only steers what the vendor suggests and restricts nothing.	[optional] [enum: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16]
language	String	The default language of the portal as a culture name, the same value GET api/2.0/settings reports as culture. A member may have a language of their own, which this does not reflect.	[optional] [example: en-US] [nullable]
lastModified	Date (date-time)	When any field of this record last changed, in UTC. It does not move when portal settings outside this record are changed.	[optional] [example: 2024-02-10T14:20:00Z]
mappedDomain	String	The custom domain the portal answers on in addition to its own address, empty when none has been set up.	[optional] [example: mycompany.example.com] [nullable]
name	String	The portal title as shown to people, which is what GET api/2.0/settings returns as greetingSettings. It is free text, unlike tenantAlias, and empty until someone sets it.	[optional] [example: My Company] [nullable]
ownerId	UUID (uuid)	The portal owner, the one account that cannot be removed or demoted. PUT api/2.0/settings/owner hands the role over.	[optional] [example: 00000000-0000-0000-0000-000000000001]
paymentId	String	The portal's identifier in the billing system, empty for a portal that has never been billed. The subscription itself is read with GET api/2.0/portal/tariff.	[optional] [example: PAY123456789] [nullable]
spam	Boolean	Whether the owner agreed to receive the vendor's newsletter. Despite the name it does not mark the portal as a spammer and affects nothing but marketing mail.	[optional] [example: false]
status	TenantStatus	The lifecycle state of the portal. Anything other than active means most operations are refused for the moment, because the portal is being transferred, restored, encrypted or removed.	[optional] [enum: 0, 1, 2, 3, 4, 5, 6]
statusChangeDate	Date (date-time)	When status last changed, in UTC. For a portal pending removal it is the moment the countdown to deletion started.	[optional] [example: 2024-01-15T10:30:00Z]
timeZone	String	The portal time zone, which is the zone the dates this API calls portal time are expressed in. It may be stored as a Windows identifier here, while GET api/2.0/settings always reports the IANA form.	[optional] [example: America/New_York] [nullable]
trustedDomains	List	The mail domains a new member may register or be invited from without confirming the address. It is empty whenever trustedDomainsType is not Custom.	[optional] [example: [example.com, trusted.com]] [nullable]
trustedDomainsRaw	String	The same domains as the single stored string they are kept in, separated by commas. Read trustedDomains instead; this one exists because it is what the record holds.	[optional] [example: example.com,trusted.com] [nullable]
trustedDomainsType	TenantTrustedDomainsType	How the mail domains are applied: no domain trusted, every domain trusted, or only the listed ones. Only the last of the three makes trustedDomains meaningful.	[optional] [enum: 0, 1, 2]
version	Integer (int32)	The identifier of the portal version the installation pins this portal to, which is an internal number and not the product version string that GET api/2.0/settings reports as version.	[optional] [example: 2]
versionChanged	Date (date-time)	When version last changed, in UTC. It stays at its zero value on a portal whose version has never been switched.	[optional] [example: 2024-02-01T09:00:00Z]
region	String	The data-centre region the portal is actually served from, looked up from the hosting service. It is empty on a server installation and also whenever the installation's portal cache is switched off, so an empty value does not mean the portal has no region - hostedRegion is the value from the record itself.	[optional] [example: us-east-1] [nullable]