REST Objects Tenant

Tenant Object Format

Unable to render {include} The included page could not be found.

Tenant Object Properties

Property	Type	Required?	Description
Property	Type	Required?	Description	`EntityId`	`string`	No	The GUID string by which the Tenant is identified. The `EntityId` is not a required field, and when a Tenant is created, if not supplied, an `EntityId` will be automatically generated. However, if the Tenant is to be integrated with ServiceMobility, then the `EntityId` field must match the ID of the entity in ServiceMobility with which the Tenant is to be associated.
`Name`	`string`	Yes	A string describing the name of the Tenant.
`Email`	`string`	Yes	An email address which can be used to communicate with the owner(s) of the Tenant.
`ExtSysId`	`string`	No	An optional ID from an external system, if an association between an account in an external system and the Tenant should be noted.
`Desc`	`string`	No	A string describing the Tenant in more detail, if the `Name` field is insufficient.
`Active`	`boolean`	No	Indicates if the Tenant is active or not. Defaults to `true`.
`SID`	`string`	No	A globally unique identifier for the Tenant, which is used internally by ServiceBroker. The `SID` field can not be set on creation/update - it is an internal identifier only.
`Domain`	`string`	No	A short, human readable customer identification string, used when a single customer has multiple Tenants. When multiple Tenants have the same `Domain` field, it allows customers using ServicePower's Next Generation Gantt to switch between associated Tenants.
`CreatedAt`	`datetime`	No	A date/time value representing when the Tenant was created. The CreatedAt field can not be set on creation/update - it is an internal field only.
`AuthType`	`string`	No	Defines the type of authentication for the Tenant. Options are: ClientCredentials: Configured the Tenant to authenticate via JWTs. When not supplied, the Tenant will be configured to authenticate via System Access Tokens. This parameter can only be supplied when creating a new Tenant object via the POST `/up/v5/entity` operation. Once the Tenant object has been created, the authentication method cannot be updated.