Skip to main content
logoTetrate Service BridgeVersion: next

Tenant Service

Service to manage TSB tenants.

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

GetTenant

UpdateTenant

ListTenants

DeleteTenant

CreateSetting

GetSetting

UpdateSetting

ListSettings

ListWasmExtensions

DeleteSetting

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
  max_len: 63
  pattern: ^[a-z0-9]([a-z0-9-]*[a-z0-9])?$
}

tenant

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

message = {
  required: true
}

CreateTenantSettingRequest #

Request to create a Tenant Setting.

FieldDescriptionValidation Rule

parent

string
REQUIRED
Parent resource where the Tenant Setting will be created.

string = {
  min_len: 1
}

name

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

string = {
  min_len: 1
  max_len: 63
  pattern: ^[a-z0-9]([a-z0-9-]*[a-z0-9])?$
}

setting

tetrateio.api.tsb.v2.TenantSetting
REQUIRED
Details of the Tenant Setting 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
}

force

bool
Force the deletion of the object even if deletion protection is enabled. If this is set, then the object and all its children will be deleted even if any of them has the deletion protection enabled.

DeleteTenantSettingRequest #

Request to delete a Tenant Setting.

FieldDescriptionValidation Rule

fqn

string
REQUIRED
Fully-qualified name of the Tenant Setting.

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
}

GetTenantSettingRequest #

Request to retrieve a Tenant Settings.

FieldDescriptionValidation Rule

fqn

string
REQUIRED
Fully-qualified name of the Tenant Setting.

string = {
  min_len: 1
}

ListTenantExtensionsRequest #

Request to list Tenant extensions.

FieldDescriptionValidation Rule

parent

string
REQUIRED
Parent resource to list Tenant Extensions from.

string = {
  min_len: 1
}

ListTenantExtensionsResponse #

List of all existing WasmExtensions objects assigned to the Tenant.

FieldDescriptionValidation Rule

extensions

List of tetrateio.api.tsb.extension.v2.WasmExtension

ListTenantSettingsRequest #

Request to list Tenant Settings.

FieldDescriptionValidation Rule

parent

string
REQUIRED
Parent resource to list Tenant Settings from.

string = {
  min_len: 1
}

ListTenantSettingsResponse #

List of all existing Tenant settings objects in the Tenant.

FieldDescriptionValidation Rule

settings

List of tetrateio.api.tsb.v2.TenantSetting

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.