Skip to main content

tcb user update

v3.0.0+

The tcb user command has been available since v3.0.0.

Modify user information.

Usage​

tcb user update <uid> [options]

Parameters​

ParameterDescriptionDefault Value
uidUser ID (required)—
-e, --env-id <envId>Environment ID—
--username <name>New username—
--type <type>User type: internalUser / externalUser—
--password <pwd>New password—
--status <status>User status: ACTIVE / BLOCKED—
--nickname <nickname>Nickname—
--jsonOutput JSON—

Examples​

# Block user.
tcb user update user-uid-123 --status BLOCKED -e my-env-id

# Change password.
tcb user update user-uid-123 --password NewSecret456 -e my-env-id

# Change both username and nickname simultaneously.
tcb user update user-uid-123 --username bob --nickname "Bob" -e my-env-id