Tenant Management API

Endpoint Index

ActionEndpoint
Fetch My TenantsGET /auth/tenants/mytenants/list
Fetch Tenant DetailsGET /auth/tenants/{locator}
Create a TenantPOST /config/createTenant
Fetch all Tenants in the EnvironmentGET /auth/tenants/list
Update a TenantPATCH /auth/tenants/{locator}
Retire a TenantPATCH /auth/tenants/{locator}/retire
Clone to a Test TenantPOST /config/{tenantLocator}/deployments/cloneTest
Clone to a Production tenantPOST /config/{tenantLocator}/deployments/cloneProduction
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

Cloning

Clone to a Test Tenant
cloneConfigToTest
POST /config/{tenantLocator}/deployments/cloneTest
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    tenantNamequerystring?optional
    tenantDescriptionquerystring?optional
    Security Group:deployments   Permission:cloneTest
Clone to a Production tenant
cloneConfigToProduction
POST /config/{tenantLocator}/deployments/cloneProduction
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    tenantNamequerystring?optional
    tenantDescriptionquerystring?optional
    Security Group:deployments   Permission:cloneProduction
DeploymentCloneResponse
required
locator uuid
deploymentResult ConfigBuilderResult
resourceCloneStatus Enum queued | failed