Tenant Management API
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 |
Response:TenantResponse[]
Security Group:tenants  Permission:custom
GET /auth/tenants/{locator}Request Parameters:
| Name | Position | Type | Required |
|---|---|---|---|
| locator | path | uuid | required |
Response:TenantResponse
Security Group:tenants  Permission:read
TenantResponse
¶requiredlocator uuidname 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 |
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