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

Fetch My Tenants

¶

fetchMyTenants

Returns a list of tenants you have access to.

GET /auth/tenants/mytenants/list

Request 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

¶

required
listCompleted boolean
items TenantResponse[]

Fetch Tenant Details

¶

fetchTenant

GET /auth/tenants/{locator}

Request Parameters:

Name	Position	Type	Required
locator	path	uuid	required

Response:TenantResponse

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:

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

¶

required
locator uuid
name string
bootstrapResult BootstrapResult
deploymentResult ConfigBuilderResult

Fetch all Tenants in the Environment

¶

fetchTenants

GET /auth/tenants/list

Request 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

Update a Tenant

¶

updateTenant

PATCH /auth/tenants/{locator}

Request Parameters:

Name	Position	Type	Required
locator	path	uuid	required

Request:TenantUpdateRequest

Response:TenantResponse

Security Group:tenants Permission:write

TenantUpdateRequest

¶

required
name string
description string

Retire a Tenant

¶

retireTenant

PATCH /auth/tenants/{locator}/retire

Request Parameters:

Name	Position	Type	Required
locator	path	uuid	required

Response:TenantResponse

Security Group:tenants Permission:retire

Cloning

Clone to a Test Tenant

¶

cloneConfigToTest

POST /config/{tenantLocator}/deployments/cloneTest

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
tenantName	query	string?	optional
tenantDescription	query	string?	optional

Response:DeploymentCloneResponse

Security Group:deployments Permission:cloneTest

Clone to a Production tenant

¶

cloneConfigToProduction

POST /config/{tenantLocator}/deployments/cloneProduction

Request 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

¶

required
locator uuid
deploymentResult ConfigBuilderResult
resourceCloneStatus Enum queued | failed