Tenant Management API

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:TenantListResponse

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