Organizations Service

Organizations

CreateOrganization

rpc CreateOrganization (tetrateio.api.tsb.v2.CreateOrganizationRequest) returns (tetrateio.api.tsb.v2.Organization)

Requires CreateOrganization

GetOrganization

rpc GetOrganization (tetrateio.api.tsb.v2.GetOrganizationRequest) returns (tetrateio.api.tsb.v2.Organization)

Requires ReadOrganization

UpdateOrganization

rpc UpdateOrganization (tetrateio.api.tsb.v2.Organization) returns (tetrateio.api.tsb.v2.Organization)

Requires WriteOrganization

ListOrganizations

rpc ListOrganizations (tetrateio.api.tsb.v2.ListOrganizationsRequest) returns (tetrateio.api.tsb.v2.ListOrganizationsResponse)

DeleteOrganization

rpc DeleteOrganization (tetrateio.api.tsb.v2.DeleteOrganizationRequest) returns (google.protobuf.Empty)

Requires DeleteOrganization

SyncOrganization

rpc SyncOrganization (tetrateio.api.tsb.v2.SyncOrganizationRequest) returns (tetrateio.api.tsb.v2.SyncOrganizationResponse)

Requires CreateUser, CreateTeam, DeleteUser, DeleteTeam, WriteTeam

SyncOrganization is used by processes that monitor the identity providers to synchronize the users and teams with the ones in TSB

CreateOrganizationRequest

Request to create a organization.

Field	Description	Validation Rule
name	string REQUIRED The short name for the resource to be created.	string = {   min_len: 1 }
organization	tetrateio.api.tsb.v2.Organization REQUIRED Details of the organization to be created.	message = {   required: true }

DeleteOrganizationRequest

Request to delete a organization.

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

GetOrganizationRequest

Request to retrieve a organization.

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

ListOrganizationsRequest

Request to list organizations.

Name	Number	Description

ListOrganizationsResponse

Field	Description	Validation Rule
organizations	List of tetrateio.api.tsb.v2.Organization	–

SyncOrganizationRequest

Field	Description	Validation 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.SyncOrganizationRequest.SyncUser	–
teams	List of tetrateio.api.tsb.v2.SyncOrganizationRequest.SyncTeam	–

SyncTeam

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

Field	Description	Validation 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 TSB user since the fields here are raw info that does not have the context of the TSB hierarchy.

Field	Description	Validation Rule
id	string	string = {   min_len: 1 }
description	string	–
email	string	–

SyncOrganizationResponse

Field	Description	Validation Rule
failedUsers	tetrateio.api.tsb.v2.SyncOrganizationResponse.FailedIds	–
failedTeams	tetrateio.api.tsb.v2.SyncOrganizationResponse.FailedIds	–

FailedIds

Field	Description	Validation Rule
removal	List of string	–
addition	List of string	–
update	List of string	–