TenantsApi
| Method | HTTP request | Description |
|---|---|---|
| create_tenant_async_using_post | POST /api/web/v5/async/tenants | Create a tenant asynchronously |
| create_tenant_using_post | POST /api/web/v4/tenants | Create a tenant |
| delete_tenant_entitlement_using_delete | DELETE /api/web/v4/tenants/{tenantid}/entitlements/{type} | Delete an entitlement |
| get_create_tenant_async_result_using_get | GET /api/web/v4/async/tenants/{id}/createresult | Get the result of an asynchronous tenant creation operation |
| get_create_tenant_async_status_using_get | GET /api/web/v4/async/tenants/{id}/createstatus | Get the status of an asynchronous tenant creation operation |
| get_entitlement_usage_info_using_post | POST /api/web/v4/tenants/entitlements/usage | Lists a page of entitlement usage information |
| get_sp_identity_provider_using_get | GET /api/web/v1/tenants/{id}/spidentityprovider | Get Tenant Identity Provider and Service Provider OIDC Application for Tenant Management. |
| get_tenant_entitlement_using_get | GET /api/web/v4/tenants/{tenantid}/entitlements/{type} | Get an entitlement |
| get_tenant_entitlements_using_get | GET /api/web/v4/tenants/{tenantid}/entitlements | Get entitlements for tenant |
| get_tenant_using_get | GET /api/web/v4/tenants/{id} | Get a tenant |
| get_tenants_page_using_post | POST /api/web/v4/tenantspaged | Lists a page of tenants |
| lock_tenant_using_put | PUT /api/web/v4/tenants/{id}/lock | Lock a tenant |
| remove_tenant_using_delete | DELETE /api/web/v4/tenants/{id} | Delete a tenant |
| set_sp_identity_provider_using_put | PUT /api/web/v1/tenants/{id}/spidentityprovider | Set Tenant Identity Provider and Service Provider OIDC Application for Tenant Management |
| set_tenant_entitlement_using_put | PUT /api/web/v4/tenants/{tenantid}/entitlements | Set an entitlement |
| unlock_tenant_using_put | PUT /api/web/v4/tenants/{id}/unlock | Unlock a tenant |
create_tenant_async_using_post
CreateTenantAsyncStatus create_tenant_async_using_post(create_tenant_parms)
Create a tenant asynchronously
Create a new tenant for a service provider. Caller requires the TENANTS:ADD permission from a service provider role.
Notes on CreateTenantParms attributes:
adminUser (UserParms):- The locale attribute is ignored if provided. It defaults to English for the first super administrator.
- The status attributes is ignored if provided. It defaults to ACTIVE for the first super administrator.
- The userId is required.
adminApiApplication (AdminApiApplicationParms):
- The spRoleId attribute is not supported. An error is returned if provided.
entitlements (EntitlementParms):
- The contractMode attribute is required. It must be either TRIAL or PRODUCTION.
- The quantity attribute is required.
- entitlements.issuance (EntitlementParms.IssuanceParms):
- The entitlements.issuance attribute is required if you are creating an Issuance tenant.
- The serviceBundles attribute is required. One service bundle (of those supported by the service provider contract) must be defined.
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| create_tenant_parms | CreateTenantParms |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
create_tenant_using_post
CreateTenantResult create_tenant_using_post(create_tenant_parms)
Create a tenant
Create a new tenant for a service provider. Caller requires the TENANTS:ADD permission from a service provider role.
Notes on CreateTenantParms attributes:
adminUser (UserParms):
- The locale attribute is ignored if provided. It defaults to English for the first super administrator.
- The status attributes is ignored if provided. It defaults to ACTIVE for the first super administrator.
- The userId is required.
adminApiApplication (AdminApiApplicationParms):
- The spRoleId attribute is not supported. An error is returned if provided.
entitlements (EntitlementParms):
- The contractMode attribute is required. It must be either TRIAL or PRODUCTION.
- The quantity attribute is required.
- entitlements.issuance (EntitlementParms.IssuanceParms):
- The entitlements.issuance attribute is required if you are creating an Issuance tenant.
- The serviceBundles attribute is required. One service bundle (of those supported by the service provider contract) must be defined.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| create_tenant_parms | CreateTenantParms |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
delete_tenant_entitlement_using_delete
delete_tenant_entitlement_using_delete(tenantid, type)
Delete an entitlement
Delete the entitlement for the specified tenant. Caller requires the SPENTITLEMENTS:REMOVE permission from a service provider role.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| tenantid | str | The UUID of the tenant whose entitlement is to be deleted. | |
| type | str | The type of entitlement. Allowed values: SMSVOICE. |
Return type
void (empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
get_create_tenant_async_result_using_get
CreateTenantResult get_create_tenant_async_result_using_get(id)
Get the result of an asynchronous tenant creation operation
Get the result of a tenant creation operation for a service provider. The results for a given operation can only be retrieved once. Caller requires the TENANTS:ADD permission from a service provider role.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | The UUID of the create tenant operation whose results are to be fetched. |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
get_create_tenant_async_status_using_get
CreateTenantAsyncStatus get_create_tenant_async_status_using_get(id)
Get the status of an asynchronous tenant creation operation
Get the status of a tenant creation operation for a service provider. Caller requires the TENANTS:VIEW permission from a service provider role.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | The UUID of the create tenant operation whose status is be fetched. |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
get_entitlement_usage_info_using_post
UsageInfoPage get_entitlement_usage_info_using_post(search_parms)
Lists a page of entitlement usage information
Returns tenant usage information for the provided search parameters. Caller requires the TENANTS:VIEW permission. The following searchByAttributes are supported:
- startTime: a mandatory String value representing an ISO-8601 date in UTC time (e.g., 2018-08-04T18:15:30). Allowed operators are: GREATER_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN, LESS_THAN_OR_EQUAL.
- endTime: a String value representing an ISO-8601 date in UTC time (e.g., 2018-08-04T18:15:30). Allowed operators are: GREATER_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN, LESS_THAN_OR_EQUAL.
- tenantId: The UUID of the tenant. Allowed operators are: EQUALS.
- isTrial: true or false. Allowed operator: EQUALS.
- usageType: the type of entitlement: USERS, ISSUANCE. Allowed operator: EQUALS.
The orderByAttribute supports these attribute names: startTime.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| search_parms | SearchParms |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
get_sp_identity_provider_using_get
SpIdentityProvider get_sp_identity_provider_using_get(id)
Get Tenant Identity Provider and Service Provider OIDC Application for Tenant Management.
Get Tenant Identity Provider and Service Provider OIDC Application for Tenant Management. Caller requires the SPIDENTITYPROVIDERS:VIEW permission.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | The UUID of the tenant to be obtained. |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
get_tenant_entitlement_using_get
Entitlement get_tenant_entitlement_using_get(tenantid, type)
Get an entitlement
Get the specified entitlement for a tenant. Caller requires the SPENTITLEMENTS:VIEW permission from a service provider role.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| tenantid | str | The UUID of the tenant whose entitlement is to be fetched. | |
| type | str | The type of entitlement (only USERS is supported). |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
get_tenant_entitlements_using_get
List[Entitlement] get_tenant_entitlements_using_get(tenantid)
Get entitlements for tenant
Get all entitlements for the specified tenant of the current service provider. Caller requires the SPENTITLEMENTS:VIEW permission from a service provider role.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| tenantid | str | The UUID of the tenant whose entitlements are to be fetched. |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
get_tenant_using_get
Tenant get_tenant_using_get(id)
Get a tenant
Get the specified tenant for a service provider. Caller requires the TENANTS:VIEW permission from a service provider role.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | The UUID of the tenant to be fetched. |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
get_tenants_page_using_post
TenantsPage get_tenants_page_using_post(search_parms)
Lists a page of tenants
Returns tenants for the provided search parameters. Caller requires the TENANTS:VIEW permission. The following searchByAttributes are supported:
- hostname: a String up to 100 characters. Allowed operators are: EQUALS, NOT_EQUALS, CONTAINS, NOT_CONTAINS, STARTS_WITH, ENDS_WITH.
- companyName: a String up to 100 characters. Allowed operators are: EQUALS, NOT_EQUALS, CONTAINS, NOT_CONTAINS, STARTS_WITH, ENDS_WITH.
- contractMode: PRODUCTION, TRIAL, UNKNOWN. Allowed operator: EQUALS.
- locked: true or false. Allowed operator: EQUALS.
- serviceProvider: true or false. Allowed operator: EQUALS.
- authenticationAccount: true or false. Allowed operator: EQUALS.
- issuanceAccount: true or false. Allowed operator: EQUALS.
- spIdp: true or false. Allowed operator: EQUALS.
The orderByAttribute supports these attribute names: hostname, companyName, contractMode, locked, serviceProvider, authenticationAccount, issuanceAccount, spIdp.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| search_parms | SearchParms |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
lock_tenant_using_put
lock_tenant_using_put(id)
Lock a tenant
Lock the specified tenant for a service provider. Caller requires the TENANTS:EDIT permission from a service provider role.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | The UUID of the tenant to be locked. |
Return type
void (empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
remove_tenant_using_delete
remove_tenant_using_delete(id)
Delete a tenant
Delete the specified tenant for a service provider. Caller requires the TENANTS:REMOVE permission from a service provider role.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | The UUID of the tenant to be removed. |
Return type
void (empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
set_sp_identity_provider_using_put
SpIdentityProvider set_sp_identity_provider_using_put(id, sp_identity_provider_parms)
Set Tenant Identity Provider and Service Provider OIDC Application for Tenant Management
Set Tenant Identity Provider and Service Provider OIDC Application for Tenant Management. Caller requires the SPIDENTITYPROVIDERS:EDIT permission.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | The UUID of the tenant to be updated. | |
| sp_identity_provider_parms | SpIdentityProviderParms |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
set_tenant_entitlement_using_put
set_tenant_entitlement_using_put(tenantid, entitlement_parms)
Set an entitlement
Set the entitlement for the specified tenant. Caller requires the SPENTITLEMENTS:EDIT permission from a service provider role.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| tenantid | str | The UUID of the tenant whose entitlement is to be set. | |
| entitlement_parms | EntitlementParms |
Return type
void (empty response body)
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
unlock_tenant_using_put
unlock_tenant_using_put(id)
Unlock a tenant
Unlock the specified tenant for a service provider. Caller requires the TENANTS:EDIT permission from a service provider role.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | The UUID of the tenant to be unlocked. |
Return type
void (empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |