Teams Service
Service to manage Users and Teams in TSB
Teams #
The Teams service provides methods to manage the Users and Teams that exist in an Organization.
Users and Teams are periodically synchronized from the Identity Provider (IdP) configured for the Organization, but TSB allows creating local teams to provide extended flexibility in how Users and Teams are grouped, and to provide a comprehensive way of creating more fine-grained access control policies.
GetUser
ListUsers
GenerateTokens
CreateTeam
GetTeam
UpdateTeam
ListTeams
DeleteTeam
CreateServiceAccount
GetServiceAccount
GetServiceAccountJWKS
UpdateServiceAccount
ListServiceAccounts
DeleteServiceAccount
GenerateServiceAccountKey
DeleteServiceAccountKey
CreateServiceAccountRequest #
Request to create a ServiceAccount.
Field | Description | Validation Rule |
---|---|---|
parent | string | string = { |
name | string | string = { |
serviceAccount | tetrateio.api.tsb.v2.ServiceAccount | message = { |
keyEncoding | tetrateio.api.tsb.v2.ServiceAccount.KeyPair.Encoding | – |
CreateTeamRequest #
Request to create a Team.
Field | Description | Validation Rule |
---|---|---|
parent | string | string = { |
name | string | string = { |
team | tetrateio.api.tsb.v2.Team | message = { |
DeleteServiceAccountKeyRequest #
Delete a key-pair associated with the Service Account.
Field | Description | Validation Rule |
---|---|---|
fqn | string | string = { |
id | string | string = { |
DeleteServiceAccountRequest #
Request to delete a ServiceAccount.
Field | Description | Validation Rule |
---|---|---|
fqn | string | string = { |
DeleteTeamRequest #
Request to delete a Team.
Field | Description | Validation Rule |
---|---|---|
fqn | string | string = { |
GenerateServiceAccountKeyRequest #
Request to generate a new key-pair for the Service Account.
Field | Description | Validation Rule |
---|---|---|
fqn | string | string = { |
keyEncoding | tetrateio.api.tsb.v2.ServiceAccount.KeyPair.Encoding | – |
GetServiceAccountJWKSRequest #
Request to retrieve all the public keys under a service account.
Field | Description | Validation Rule |
---|---|---|
fqn | string | string = { |
GetServiceAccountRequest #
Request to retrieve a Service Account.
Field | Description | Validation Rule |
---|---|---|
fqn | string | string = { |
keyEncoding | tetrateio.api.tsb.v2.ServiceAccount.KeyPair.Encoding | – |
GetTeamRequest #
Request to retrieve a Team.
Field | Description | Validation Rule |
---|---|---|
fqn | string | string = { |
GetUserRequest #
Request to retrieve a User.
Field | Description | Validation Rule |
---|---|---|
fqn | string | string = { |
JWKS #
JSON Web Key Set. Refer to https://datatracker.ietf.org/doc/html/rfc7517
Field | Description | Validation Rule |
---|---|---|
keys | List of tetrateio.api.tsb.v2.JWKS.JWK | – |
JWK #
JSON Web Key. Refer to https://datatracker.ietf.org/doc/html/rfc7517
Field | Description | Validation Rule |
---|---|---|
alg | string | – |
kty | string | – |
use | string | – |
n | string | – |
e | string | – |
kid | string | – |
ListServiceAccountsRequest #
Request to list Service Accounts.
Field | Description | Validation Rule |
---|---|---|
parent | string | string = { |
keyEncoding | tetrateio.api.tsb.v2.ServiceAccount.KeyPair.Encoding | – |
ListServiceAccountsResponse #
List of existing Service Accounts.
Field | Description | Validation Rule |
---|---|---|
serviceAccounts | – |
ListTeamsRequest #
Request to list Teams.
Field | Description | Validation Rule |
---|---|---|
parent | string | string = { |
ListTeamsResponse #
List of existing teams.
Field | Description | Validation Rule |
---|---|---|
teams | List of tetrateio.api.tsb.v2.Team | – |
ListUsersRequest #
Request to list Users.
Field | Description | Validation Rule |
---|---|---|
parent | string | string = { |
ListUsersResponse #
List of existing Users.
Field | Description | Validation Rule |
---|---|---|
users | List of tetrateio.api.tsb.v2.User | – |
TokenResponse #
Contains a pair of tokens for a user that can be used to authenticate against TSB.
Field | Description | Validation Rule |
---|---|---|
accessToken | string | – |
refreshToken | string | – |