Tenant Profiles #
The Tenant Profile resource allows available profiles to be queried. Tenant profiles control the features that will be exposed to the customer.
/{VERSION}/customers/{CUSTOMER_TENANT_ID}/tenantprofiles
Tenant Profile Schema #
Tenant profiles can be used to control the features available to customers.
| Property | Description | Type |
|---|---|---|
| id | The unique identifier for the profile | string |
| name | The short name the profile is referred to in the portal UIs | string |
| description | A longer descriptive name for profile | string |
| default | If true, this is the profile that will be assigned to new customers if no tenant profile is specified | bool |
| allowSelect | Indicates whether the profile is available for use or whether it has been discontinued for new customers. | bool |
| allowChange | Indicates whether customers are allowed to switch to other profiles once this profile is assigned. | bool |
Available Interfaces #
| Interface | Description |
|---|---|
| Get All | Returns a collection of all tenant profiles. |