TenantsApi
| Method | HTTP request | Description |
|---|---|---|
| createTenantAsyncUsingPOST | POST /api/web/v5/async/tenants | Create a tenant asynchronously |
| createTenantUsingPOST | POST /api/web/v4/tenants | Create a tenant |
| deleteTenantEntitlementUsingDELETE | DELETE /api/web/v4/tenants/{tenantid}/entitlements/{type} | Delete an entitlement |
| getCreateTenantAsyncResultUsingGET | GET /api/web/v4/async/tenants/{id}/createresult | Get the result of an asynchronous tenant creation operation |
| getCreateTenantAsyncStatusUsingGET | GET /api/web/v4/async/tenants/{id}/createstatus | Get the status of an asynchronous tenant creation operation |
| getEntitlementUsageInfoUsingPOST | POST /api/web/v4/tenants/entitlements/usage | Lists a page of entitlement usage information |
| getSpIdentityProviderUsingGET | GET /api/web/v1/tenants/{id}/spidentityprovider | Get Tenant Identity Provider and Service Provider OIDC Application for Tenant Management. |
| getTenantEntitlementUsingGET | GET /api/web/v4/tenants/{tenantid}/entitlements/{type} | Get an entitlement |
| getTenantEntitlementsUsingGET | GET /api/web/v4/tenants/{tenantid}/entitlements | Get entitlements for tenant |
| getTenantUsingGET | GET /api/web/v4/tenants/{id} | Get a tenant |
| getTenantsPageUsingPOST | POST /api/web/v4/tenantspaged | Lists a page of tenants |
| lockTenantUsingPUT | PUT /api/web/v4/tenants/{id}/lock | Lock a tenant |
| removeTenantUsingDELETE | DELETE /api/web/v4/tenants/{id} | Delete a tenant |
| setSpIdentityProviderUsingPUT | PUT /api/web/v1/tenants/{id}/spidentityprovider | Set Tenant Identity Provider and Service Provider OIDC Application for Tenant Management |
| setTenantEntitlementUsingPUT | PUT /api/web/v4/tenants/{tenantid}/entitlements | Set an entitlement |
| unlockTenantUsingPUT | PUT /api/web/v4/tenants/{id}/unlock | Unlock a tenant |
createTenantAsyncUsingPOST
CreateTenantAsyncStatus createTenantAsyncUsingPOST(createTenantParms)
Create a tenant asynchronously
<p>Create a new tenant for a service provider. Caller requires the TENANTS:ADD permission from a service provider role.</p><p>Notes on CreateTenantParms attributes: </p><b>adminUser</b> (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.
<b>adminApiApplication</b> (AdminApiApplicationParms):
- The spRoleId attribute is not supported. An error is returned if provided.
<b>entitlements</b> (EntitlementParms):
- The contractMode attribute is required. It must be either TRIAL or PRODUCTION.
- The quantity attribute is required.
- <b>entitlements.issuance</b> (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.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| createTenantParms | 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 | - |
createTenantUsingPOST
CreateTenantResult createTenantUsingPOST(createTenantParms)
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:
<b>adminUser</b> (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.
<b>adminApiApplication</b> (AdminApiApplicationParms):
- The spRoleId attribute is not supported. An error is returned if provided.
<b>entitlements</b> (EntitlementParms):
- The contractMode attribute is required. It must be either TRIAL or PRODUCTION.
- The quantity attribute is required.
- <b>entitlements.issuance</b> (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
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| createTenantParms | 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 | - |
deleteTenantEntitlementUsingDELETE
deleteTenantEntitlementUsingDELETE(tenantid, type)
Delete an entitlement
Delete the entitlement for the specified tenant. Caller requires the SPENTITLEMENTS:REMOVE permission from a service provider role.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| tenantid | String | The UUID of the tenant whose entitlement is to be deleted. | |
| type | String | The type of entitlement. Allowed values: SMSVOICE. |
Return type
null (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 | - |
getCreateTenantAsyncResultUsingGET
CreateTenantResult getCreateTenantAsyncResultUsingGET(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
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | 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 | - |
getCreateTenantAsyncStatusUsingGET
CreateTenantAsyncStatus getCreateTenantAsyncStatusUsingGET(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
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | 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 | - |
getEntitlementUsageInfoUsingPOST
UsageInfoPage getEntitlementUsageInfoUsingPOST(searchParms)
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 <b>mandatory</b> 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
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| searchParms | 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 | - |
getSpIdentityProviderUsingGET
SpIdentityProvider getSpIdentityProviderUsingGET(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
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | 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 | - |
getTenantEntitlementUsingGET
Entitlement getTenantEntitlementUsingGET(tenantid, type)
Get an entitlement
Get the specified entitlement for a tenant. Caller requires the SPENTITLEMENTS:VIEW permission from a service provider role.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| tenantid | String | The UUID of the tenant whose entitlement is to be fetched. | |
| type | String | The type of entitlement (only USERS is supported). | [enum: USERS, TRANSACTIONS] |
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 | - |
getTenantEntitlementsUsingGET
List<Entitlement> getTenantEntitlementsUsingGET(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
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| tenantid | String | 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 | - |
getTenantUsingGET
Tenant getTenantUsingGET(id)
Get a tenant
Get the specified tenant for a service provider. Caller requires the TENANTS:VIEW permission from a service provider role.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | 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 | - |
getTenantsPageUsingPOST
TenantsPage getTenantsPageUsingPOST(searchParms)
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
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| searchParms | 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 | - |
lockTenantUsingPUT
lockTenantUsingPUT(id)
Lock a tenant
Lock the specified tenant for a service provider. Caller requires the TENANTS:EDIT permission from a service provider role.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | The UUID of the tenant to be locked. |
Return type
null (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 | - |
removeTenantUsingDELETE
removeTenantUsingDELETE(id)
Delete a tenant
Delete the specified tenant for a service provider. Caller requires the TENANTS:REMOVE permission from a service provider role.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | The UUID of the tenant to be removed. |
Return type
null (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 | - |
setSpIdentityProviderUsingPUT
SpIdentityProvider setSpIdentityProviderUsingPUT(id, spIdentityProviderParms)
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
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | The UUID of the tenant to be updated. | |
| spIdentityProviderParms | 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 | - |
setTenantEntitlementUsingPUT
setTenantEntitlementUsingPUT(tenantid, entitlementParms)
Set an entitlement
Set the entitlement for the specified tenant. Caller requires the SPENTITLEMENTS:EDIT permission from a service provider role.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| tenantid | String | The UUID of the tenant whose entitlement is to be set. | |
| entitlementParms | EntitlementParms |
Return type
null (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 | - |
unlockTenantUsingPUT
unlockTenantUsingPUT(id)
Unlock a tenant
Unlock the specified tenant for a service provider. Caller requires the TENANTS:EDIT permission from a service provider role.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | The UUID of the tenant to be unlocked. |
Return type
null (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 | - |