REST Objects Tenant

Tenant Object Format

JSON Format

{
	"EntityId": "",
	"Name": "",
	"Email": "",
	"ExtSysId": "",
	"Desc": "",
	"Active": true,
	"SID": "",
	"Domain": "",
	"CreatedAt": "YYYY-MM-DDTHH:MM:SS.UUUZ",
	"AuthType": ""
}

Tenant Object Properties

Property	Type	Required?
Property	Type	Required?
`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.