Tenant Management API
Endpoint Index
| Action | Endpoint |
|---|---|
| Fetch My Tenants | GET /auth/tenants/mytenants/list |
| Fetch Tenant Details | GET /auth/tenants/{locator} |
| Create a Tenant | POST /config/createTenant |
| Fetch all Tenants in the Environment | GET /auth/tenants/list |
| Update a Tenant | PATCH /auth/tenants/{locator} |
| Retire a Tenant | PATCH /auth/tenants/{locator}/retire |
| Clone to a Test Tenant | POST /config/{tenantLocator}/deployments/cloneTest |
| Clone to a Production tenant | POST /config/{tenantLocator}/deployments/cloneProduction |
Returns a list of tenants you have access to.
GET /auth/tenants/mytenants/listRequest Parameters:
| Name | Position | Type | Required |
|---|---|---|---|
| offset | query | int? | optional |
| count | query | int? | optional |
| extended | query | boolean? | optional |
Response:TenantListResponse
Security Group:tenants  Permission:custom
TenantListResponse
¶requiredlistCompleted booleanitems TenantResponse[]
GET /auth/tenants/{locator}Request Parameters:
| Name | Position | Type | Required |
|---|---|---|---|
| locator | path | uuid | required |
Response:TenantResponse
Security Group:tenants  Permission:read
TenantResponse
¶requiredlocator uuidname stringbusinessAccount stringtype Enum test | production | retired | deletedupdatedAt datetimecreatedAt datetimecreatedBy uuidoptionaldescription string?
POST /config/createTenantRequest Parameters:
| Name | Position | Type | Required |
|---|---|---|---|
| name | query | string? | optional |
| description | query | string? | optional |
Request with application/zip:ConfigurationRef
Request with multipart/form-data:ConfigurationRef
Response:TenantDeploymentResult
Security Group:tenants  Permission:create-tenant
TenantDeploymentResult
¶requiredlocator uuidname stringbootstrapResult BootstrapResultdeploymentResult ConfigBuilderResult
GET /auth/tenants/listRequest Parameters:
| Name | Position | Type | Required |
|---|---|---|---|
| offset | query | int? | optional |
| count | query | int? | optional |
| type | query | string[]? | optional |
| extended | query | boolean? | optional |
Response:TenantResponse[]
Security Group:tenants  Permissions:read,list
PATCH /auth/tenants/{locator}Request Parameters:
| Name | Position | Type | Required |
|---|---|---|---|
| locator | path | uuid | required |
Request:TenantUpdateRequest
Response:TenantResponse
Security Group:tenants  Permission:write
TenantUpdateRequest
¶requiredname stringdescription string
PATCH /auth/tenants/{locator}/retireRequest Parameters:
| Name | Position | Type | Required |
|---|---|---|---|
| locator | path | uuid | required |
Response:TenantResponse
Security Group:tenants  Permission:retire
Cloning
POST /config/{tenantLocator}/deployments/cloneTestRequest Parameters:
| Name | Position | Type | Required |
|---|---|---|---|
| tenantLocator | path | uuid | required |
| tenantName | query | string? | optional |
| tenantDescription | query | string? | optional |
Response:DeploymentCloneResponse
Security Group:deployments  Permission:cloneTest
POST /config/{tenantLocator}/deployments/cloneProductionRequest Parameters:
| Name | Position | Type | Required |
|---|---|---|---|
| tenantLocator | path | uuid | required |
| tenantName | query | string? | optional |
| tenantDescription | query | string? | optional |
Response:DeploymentCloneResponse
Security Group:deployments  Permission:cloneProduction
DeploymentCloneResponse
¶requiredlocator uuiddeploymentResult ConfigBuilderResultresourceCloneStatus Enum queued | failed