Skip to main content
Version: 1.3.x

Organizations Service

Organizations

The Organizations service exposes methods to manage the organizations that exist in TSB. Organizations are the root of the Service Bridge object hierarchy. Each organization is completely independent of the other with its own set of tenants, users, teams, clusters and workspaces.

GetOrganization

Requires ReadOrganization

Get the details of an organization.

CreateSettings

Requires CreateOrganizationSetting

Create a settings object for the given organization.

GetSettings

Requires ReadOrganizationSetting

Get the details for the given settings object.

UpdateSettings

Requires WriteOrganizationSetting

Modify the given settings in the given Organization.

ListSettings

List all the settings objects that have been attached to the given Organization.

DeleteSettings

Requires DeleteOrganizationSetting

Delete the given settings object from the Organization.

CreateOrganizationSettingsRequest

Request to create a Organization Settings.

FieldDescriptionValidation Rule

parent

string
REQUIRED
Parent resource where the Organization Settings will be created.

string = {
  min_len: 1
}

name

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

string = {
  min_len: 1
}

settings

tetrateio.api.tsb.v2.OrganizationSetting
REQUIRED
Details of the Organization Settings to be created.

message = {
  required: true
}

DeleteOrganizationSettingsRequest

Request to delete a Organization Settings.

FieldDescriptionValidation Rule

fqn

string
REQUIRED
Fully-qualified name of the Organization Settings.

string = {
  min_len: 1
}

GetOrganizationRequest

Request to retrieve a organization.

FieldDescriptionValidation Rule

fqn

string
REQUIRED
Fully-qualified name of the organization.

string = {
  min_len: 1
}

GetOrganizationSettingsRequest

Request to retrieve a Organization Settings.

FieldDescriptionValidation Rule

fqn

string
REQUIRED
Fully-qualified name of the Organization Settings.

string = {
  min_len: 1
}

ListOrganizationSettingsRequest

Request to list Organization Settings.

FieldDescriptionValidation Rule

parent

string
REQUIRED
Parent resource to list Organization Settings from.

string = {
  min_len: 1
}

ListOrganizationSettingsResponse

List of all existing Organization settings objects in the Organization group.

FieldDescriptionValidation Rule

settings

List of tetrateio.api.tsb.v2.OrganizationSetting