Teams

Deprecated. This method will be removed in future versions of TSB. Use Service Accounts instead.

Modify an existin user.

This operation is expected to be used only for LOCAL users. Users are periodically synchronized from the Identity Provider, and the process may automatically set some properties of the User resource. Modifications made using the TSB APIs may be replaced by the data from the Identity Provider on every synchronization.

$hide_from_docs

put/v2/organizations/{organization}/users/{user}

Request

Base URL
https://docs.tetrate.io (the document declares no server; this is the origin it was published from)
Auth
none declared
TypeScript
https://skmtc.dev/tetrate/apis/tetrate-service-bridge-api/docs/v2/organizations/:organization/users/:user/put.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

organizationstring required

Organization name.

userstring required

User name.

Request body

displayNamestring

emailstring

Email for the user where alerts and other notifications will be sent.

etagstring

firstNamestring

The first name of the user.

lastNamestring

The last name of the user, if any.

loginNamestring required

The username used in the login credentials.

sourceType'INVALID' | 'LDAP' | 'LOCAL' | 'AZURE' | 'MANUAL'

SourceType describes where teams come from. Teams can be synchronized from the Identity Provider but can also be manually created using the Team API to create convenient groupings of users and other teams in order to configure fine-grained permissions in the Management Plane.

LDAP: LDAP is used for users and teams that are automatically synchronized from LDAP.
LOCAL: LOCAL is used for local teams that are manually created using the TSB Team API and do not exist in the Identity Provider. Deprecated. This value is deprecated and will be removed in future releases. Use 'MANUAL' instead.
AZURE: AZURE is used for users synchronized from an Azure Active Directory.
MANUAL: MANUAL is used for users and teams that exist in the Identity Provider that have been manually populated. MANUAL users are deprecated and Service Accounts should be used instead. Support for MANUAL users will be removed in future versions.

Response

A successful response.

fqnstring