Tenant Management API

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

Fetch My TenantsfetchMyTenants

GET/auth/tenants/mytenants/list

Returns a list of tenants you have access to.

Parameters

Name	In	Type	Required	Description
`offset`	query	`integer?`	No
`count`	query	`integer?`	No
`extended`	query	`boolean?`	No	When false, returns a bare array.

Response:TenantListResponse

Security Group:tenants

Permission:

custom

TenantListResponse

Required properties

Property	Type	Description
`listCompleted`	`boolean`
`items`	`TenantResponse[]`

Fetch Tenant Details

Fetch Tenant DetailsfetchTenant

GET/auth/tenants/{locator}

Parameters

Name	In	Type	Required	Description
`locator`	path	`uuid`	Yes

Response:TenantResponse

Security Group:tenants

Permission:

read

TenantResponse

Required properties

Property	Type	Description
`locator`	`uuid`
`name`	`string`
`businessAccount`	`string`
`type`	`Enum test \| production \| retired \| deleted`
`updatedAt`	`datetime`
`createdAt`	`datetime`
`createdBy`	`uuid`

Optional properties

Property	Type	Description
`description`	`string?`

Create a Tenant

Create a TenantcreateTenant

POST/config/createTenant

Parameters

Name	In	Type	Required	Description
`name`	query	`string?`	No
`description`	query	`string?`	No

Request with application/zip:ConfigurationRef

Request with multipart/form-data:ConfigurationRef

Response:TenantDeploymentResult

Security Group:tenants

Permission:

create-tenant

TenantDeploymentResult

Required properties

Property	Type	Description
`locator`	`uuid`
`name`	`string`
`bootstrapResult`	`BootstrapResult`
`deploymentResult`	`ConfigBuilderResult`

Fetch all Tenants in the Environment

Fetch all Tenants in the EnvironmentfetchTenants

GET/auth/tenants/list

Parameters

Name	In	Type	Required
`offset`	query	`integer?`	No
`count`	query	`integer?`	No
`type`	query	`string[]?`	No
`extended`	query	`boolean?`	No

Response:TenantResponse[]

Security Group:tenants

Permissions:

read,list

Update a Tenant

Update a TenantupdateTenant

PATCH/auth/tenants/{locator}

Parameters

Name	In	Type	Required	Description
`locator`	path	`uuid`	Yes

Request:TenantUpdateRequest

Response:TenantResponse

Security Group:tenants

Permission:

write

TenantUpdateRequest

Required properties

Property	Type	Description
`name`	`string`
`description`	`string`

Retire a Tenant

Retire a TenantretireTenant

PATCH/auth/tenants/{locator}/retire

Parameters

Name	In	Type	Required	Description
`locator`	path	`uuid`	Yes

Response:TenantResponse

Security Group:tenants

Permission:

retire

Cloning

Clone to a Test Tenant

Clone to a Test TenantcloneConfigToTest

POST/config/{tenantLocator}/deployments/cloneTest

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`tenantName`	query	`string?`	No
`tenantDescription`	query	`string?`	No

Response:DeploymentCloneResponse

Security Group:deployments

Permission:

cloneTest

Clone to a Production tenant

Clone to a Production tenantcloneConfigToProduction

POST/config/{tenantLocator}/deployments/cloneProduction

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`tenantName`	query	`string?`	No
`tenantDescription`	query	`string?`	No

Response:DeploymentCloneResponse

Security Group:deployments

Permission:

cloneProduction

DeploymentCloneResponse

Required properties

Property	Type	Description
`locator`	`uuid`
`deploymentResult`	`ConfigBuilderResult`
`resourceCloneStatus`	`Enum queued \| failed`

Tenant Management API

On this page