Skip to main content
Version: 0.9.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 detaiuls of the given tenant.

ListTenants

List all tenants that are available.

DeleteTenant

Requires DeleteTenant

Delete a tenant from the paltform. 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.

SyncTenantRequest

Request to synchronize a set of users and teams to TSB.

FieldDescriptionValidation Rule

fqn

string
REQUIRED
Internal use only. Auto populated field.

string = {
  min_len: 1
}

sourceType

tetrateio.api.tsb.v2.SourceType
we cannot use the enum_only validation as protoc-gen-validate does not properly import the enum package in the generated code, and it breaks :(

users

List of tetrateio.api.tsb.v2.SyncTenantRequest.SyncUser
List of users to be synchronized into TSB,

teams

List of tetrateio.api.tsb.v2.SyncTenantRequest.SyncTeam
List of teams to be synchronized into TSB,

SyncTeam

Information of a team as synchronized from the team source. This differs slightly from a TCC user since the fields here are raw info that does not have the context of the TCC hierarchy.

FieldDescriptionValidation Rule

id

string

string = {
  min_len: 1
}

description

string

memberUserIds

List of string

memberGroupIds

List of string

SyncUser

Information of a user as synchronized from the team source. This differs slightly from a TCC user since the fields here are raw info that does not have the context of the TCC hierarchy.

FieldDescriptionValidation Rule

id

string

string = {
  min_len: 1
}

description

string

email

string

SyncTenantResponse

Details about the user and team synchronization operation.

FieldDescriptionValidation Rule

failedUsers

tetrateio.api.tsb.v2.SyncTenantResponse.FailedIds
Details of the users that could not be synchronized.

failedTeams

tetrateio.api.tsb.v2.SyncTenantResponse.FailedIds
Details of the teams that could not be synchronized.

FailedIds

Details of the entities (users/teams) taht failed to be synchronized.

FieldDescriptionValidation Rule

removal

List of string
The identifiers of the users or teams that could not be removed.

addition

List of string
The identifiers of the users or teams that could not be created.

update

List of string
The identifiers of the users or teams that could not be updated.