Tenant Management API

Fetch My Tenants
fetchMyTenants
Returns a list of tenants you have access to.
GET /auth/tenants/mytenants/list
    Request Parameters:
    NamePositionTypeRequired
    offsetqueryint?optional
    countqueryint?optional
    extendedqueryboolean?optional
    Security Group:tenants   Permission:custom
TenantListResponse
required
listCompleted boolean
Fetch Tenant Details
fetchTenant
GET /auth/tenants/{locator}
    Request Parameters:
    NamePositionTypeRequired
    locatorpathuuidrequired
    Security Group:tenants   Permission:read
TenantResponse
required
locator uuid
name string
type Enum test | production | retired | deleted
updatedAt datetime
createdAt datetime
createdBy uuid

optional
description string?
Create a Tenant
createTenant
POST /config/createTenant
    Request Parameters:
    NamePositionTypeRequired
    namequerystring?optional
    descriptionquerystring?optional
    Request with application/zip:ConfigurationRef
    Request with multipart/form-data:ConfigurationRef
    Security Group:tenants   Permission:create-tenant
TenantDeploymentResult
required
locator uuid
name string
bootstrapResult BootstrapResult
deploymentResult ConfigBuilderResult
Fetch all Tenants in the Environment
fetchTenants
GET /auth/tenants/list
    Request Parameters:
    NamePositionTypeRequired
    offsetqueryint?optional
    countqueryint?optional
    typequerystring[]?optional
    extendedqueryboolean?optional
    Security Group:tenants   Permissions:read,list
Update a Tenant
updateTenant
PATCH /auth/tenants/{locator}
TenantUpdateRequest
required
name string
description string
Retire a Tenant
retireTenant
PATCH /auth/tenants/{locator}/retire
    Request Parameters:
    NamePositionTypeRequired
    locatorpathuuidrequired
    Security Group:tenants   Permission:retire