Tenant Profile Management¶
Retrieve tenant list with details¶
-
GET/api/v1/tenants/¶ Retrieve the list all tenants, both ServiceProviders and Enterprises.
Additional information:
- Response JSON Object:
type (string) – (Optional) see type from Tenant Detail Attributes.
tenants (array) – A list of tenants. See Tenant Detail Attributes.
Create a tenant¶
-
POST/api/v1/tenants/¶ Add a new tenant.
Additional requirements:
- Request JSON Object:
tenantId (string) – see tenantId from Tenant Detail Attributes.
type (string) – see type from Tenant Detail Attributes.
defaultDomain (string) – see defaultDomain from Tenant Detail Attributes.
useCustomRoutingProfile (boolean) – see useCustomRoutingProfile from Tenant Detail Attributes.
name (string) – see name from Tenant Detail Attributes.
contactInformation (object) – see contactInformation from Tenant Detail Attributes.
addressInformation (object) – see addressInformation from Tenant Detail Attributes.
useTenantLanguages (boolean) – see useTenantLanguages from Tenant Detail Attributes.
Retrieve tenant details¶
-
GET/api/v1/tenants/(string: tenant_id)/¶ Retrieve the tenant details.
Additional information:
- Response JSON Object:
tenantId (string) – see tenantId from Tenant Detail Attributes.
type (string) – see type from Tenant Detail Attributes.
defaultDomain (string) – see defaultDomain from Tenant Detail Attributes.
useCustomRoutingProfile (boolean) – see useCustomRoutingProfile from Tenant Detail Attributes.
name (string) – see name from Tenant Detail Attributes.
contactInformation (object) – see contactInformation from Tenant Detail Attributes.
addressInformation (object) – see addressInformation from Tenant Detail Attributes.
useTenantLanguages (boolean) – see useTenantLanguages from Tenant Detail Attributes.
Update tenant details¶
-
PUT/api/v1/tenants/(string: tenant_id)/¶ Update the tenant details.
Additional requirements:
- Request JSON Object:
defaultDomain (string) – see defaultDomain from Tenant Detail Attributes.
name (string) – see name from Tenant Detail Attributes.
contactInformation (object) – see contactInformation from Tenant Detail Attributes.
addressInformation (object) – see addressInformation from Tenant Detail Attributes.
useTenantLanguages (boolean) – see useTenantLanguages from Tenant Detail Attributes.
Remove a tenant¶
-
DELETE/api/v1/tenants/(string: tenant_id)/¶ Delete a tenant.
Tenant Detail Attributes¶
Name |
Type |
Methods |
Description |
|||
|---|---|---|---|---|---|---|
GET |
POST |
PUT |
DELETE |
|||
tenantId |
String |
A |
R |
R |
R |
The unique id of the tenant. Length in range 1 - 30. |
type |
String |
A |
R |
F |
F |
The type of the tenant. Can be “ServiceProvider” or “Enterprise”. This will be converted to “isEnterprise:Boolean”. |
useCustomRoutingProfile |
Boolean |
C |
C |
F |
F |
If set, the service will synchronize the Service Provider with the Network Server and create a new instance of the routing profile for the Service Provider. Only available with type=”ServiceProvider”. |
defaultDomain |
String |
A |
O |
O |
F |
The default domain of the tenant. Length in range 1 - 80. |
name |
String |
A |
O |
O |
F |
The name of the tenant. Length in range 1 - 80. |
supportEmail |
String |
A |
O |
O |
F |
The support email of the tenant. Length in range 1 - 80. |
contact |
Object |
A |
O |
O |
F |
The main contact information, see Contact Information attributes. |
address |
Object |
A |
O |
O |
F |
The address information, see Contact Information attributes. |
useTenantLanguage |
Boolean |
A |
O |
O |
F |
TODO |