Skip to main content
Version: 1.3.x

Tenant Service

Tenants

The Tenant service can be used to manage the tenants in TSB. Tenants can be seen as organization units and line of business that have a set of resources. Every resource in TSB belongs to a tenant, and users can be assigned to tenants to get access to those resources (such as workspaces, traffic settings, etc). This service provides methods to manage the tenants that are available in the platform.

CreateTenant

Requires CreateTenant

Create a new tenant in the platform that will be the home for a set of resources.

GetTenant

Requires ReadTenant

Get the details of an existing tenant.

UpdateTenant

Requires WriteTenant

Modify the details of the given tenant.

ListTenants

List all tenants that are available.

DeleteTenant

Requires DeleteTenant

Delete a tenant from the platform. Deleting a tenant will recursively delete all resources attached to the tenant, so use with caution. It will delete all workspaces and all settings that have been created in that tenant, so this operation should be done carefully, when it's safe to do so.

CreateTenantRequest

Request to create a tenant.

FieldDescriptionValidation Rule

parent

string
Parent resource where the Tenant will be created. $only_beta

name

string
REQUIRED
The short name for the resource to be created.

string = {
  min_len: 1
}

tenant

tetrateio.api.tsb.v2.Tenant
REQUIRED
Details of the tenant to be created.

message = {
  required: true
}

DeleteTenantRequest

Request to delete a tenant.

FieldDescriptionValidation Rule

fqn

string
REQUIRED
Fully-qualified name of the tenant.

string = {
  min_len: 1
}

GetTenantRequest

Request to retrieve a tenant.

FieldDescriptionValidation Rule

fqn

string
REQUIRED
Fully-qualified name of the tenant.

string = {
  min_len: 1
}

ListTenantsRequest

Request to list tenants.

FieldDescriptionValidation Rule

parent

string
Parent resource to list Tenants from. $only_beta

ListTenantsResponse

List of available tenants.

FieldDescriptionValidation Rule

tenants

List of tetrateio.api.tsb.v2.Tenant
The list of available tenants.