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.

Field	Description	Validation 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.

Field	Description	Validation 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.

Field	Description	Validation 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.

Field	Description	Validation Rule
fqn	string REQUIRED Fully-qualified name of the Tenant Setting.	string = {   min_len: 1 }

GetTenantRequest

Request to retrieve a tenant.

Field	Description	Validation Rule
fqn	string REQUIRED Fully-qualified name of the tenant.	string = {   min_len: 1 }

GetTenantSettingRequest

Request to retrieve a Tenant Settings.

Field	Description	Validation Rule
fqn	string REQUIRED Fully-qualified name of the Tenant Setting.	string = {   min_len: 1 }

ListTenantExtensionsRequest

Request to list Tenant extensions.

Field	Description	Validation 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.

Field	Description	Validation Rule
extensions	List of tetrateio.api.tsb.extension.v2.WasmExtension	–

ListTenantSettingsRequest

Request to list Tenant Settings.

Field	Description	Validation 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.

Field	Description	Validation Rule
settings	List of tetrateio.api.tsb.v2.TenantSetting	–

ListTenantsRequest

Request to list tenants.

Field	Description	Validation Rule
parent	string Parent resource to list Tenants from. $only_beta	–
pageSize	int32 Optional. Maximum number of items to return in one page. If zero and page_token is also empty, the response contains the complete, unpaginated list (the behavior prior to pagination support). Values above 1000 are rejected with INVALID_ARGUMENT naming the maximum, rather than being clamped to it — a clamped caller receives a smaller page than it asked for with nothing saying so. A non-empty page_token with a zero page_size uses a default page size of 50. Prefer setting page_size explicitly on every request of a walk: sending only the token falls back to that default rather than reusing the previous page's size. Negative values, and values between 1 and 9, are rejected with INVALID_ARGUMENT — small pages are disproportionately expensive to serve, so request at least 10 items per page.	–
pageToken	string Optional. Opaque continuation token from a previous response's next_page_token. Tokens are bound to the query that issued them: replaying a token with a different parent or against a different List method is rejected with INVALID_ARGUMENT.	–

ListTenantsResponse

List of available tenants.

Field	Description	Validation Rule
tenants	List of tetrateio.api.tsb.v2.Tenant The list of available tenants.	–
nextPageToken	string Opaque token for the next page. Empty when there are no further pages — this is the only end-of-list signal: a page may contain fewer items than page_size (even zero) while more pages remain. Item order is unspecified and not a stable contract.	–
totalSize	int32 Total number of items under parent that match this request and the caller is permitted to see, counted after permission filtering. Set on every response, paged or not, so a client never has to branch on whether it paginated to learn the count. Exact on an unpaged response, where it is simply the number of items returned. On a paged response it is an UPPER BOUND: it counts authorized entries before they are loaded, so it can exceed what a full walk ultimately yields if an item is present in the authorization graph but absent from the store. A zero always means the result is empty. This field is set on every response, so a zero never means the server declined to compute a total.	–