Skip to main content

tcld user command reference

The tcld user commands manage users in Temporal Cloud.

Alias: u

delete​

The tcld user delete command deletes the specified user in Temporal Cloud. You must set either --user-email or --user-id to specify the user to be deleted.

Alias: d

The following modifiers control the behavior of the command.

--user-email​

Specify the email address of the user to delete.

Example

tcld user delete --user-email <test@example.com>

--user-id​

Specify the user identifier of the user to delete.

Example

tcld user delete --user-id <test-user-id>

--request-id​

The request identifier to use for the asynchronous operation.

If not set, the server assigns an identifier.

Alias: -r

--resource-version​

Specify a resource version (ETag) to update from. If not specified, the latest version is used.

Alias: -v

get​

The tcld user get command gets information about the specified user in Temporal Cloud. You must set either --user-email or --user-id.

Alias: g

The following modifiers control the behavior of the command.

--user-email​

Specify the email address of the user to get information about.

Example

tcld user delete --user-email <test@example.com>

--user-id​

Specify the user identifier of the user to get information about.

Example

tcld user delete --user-id <test-user-id>

invite​

The tcld namespace invite command invites the specified user to join Temporal Cloud.

Alias: i

The following modifiers control the behavior of the command.

--user-email​

Required modifier

Specify the email address of the user to be invited. You can supply this modifier multiple times to invite multiple users in a single request.

Alias: -e

--account-role​

Required modifier

Specify the account-level Role for the invited user.

Available account roles: admin | developer | read.

Alias: --ar

--namespace-permission​

Specify the Namespace-level permissions for the invited user. You can supply this modifier multiple times to set multiple Namespace permissions in a single request.

Each value must be in the format of namespace=permission-type.

Available namespace permissions: Admin | Write | Read.

Alias: -p

--request-id​

The request identifier to use for the asynchronous operation.

If not set, the server assigns an identifier.

Alias: -r

tcld user invite --user-email <test@example.com> --account-role developer --namespace-permission ns1=Admin --namespace-permission ns2=Write --request-id <123456>

list​

The tcld user list command returns a paginated list of users in Temporal Cloud.

Alias: l

Example

tcld user list

The following modifiers control the behavior of the command.

--namespace​

List users that have permissions to the Namespace.

Alias: -n

Example

tcld user list --namespace <namespace_id>

--page-token​

Page token for paging list users request.

Alias: -p

--page-size​

Page size for paging list users request.

Defaults to 10.

Alias: -s

resend-invite​

The tcld user resend-invite command resends an invitation to the specified user in Temporal Cloud. You must set either --user-email or --user-id to specify the user to receive another invitation.

Alias: ri

The following modifiers control the behavior of the command.

--user-email​

Specify the email address of the user to resend an invitation to.

Example

tcld user resend-invite --user-email <test@example.com>

--user-id​

Specify the user identifier of the user to resend an invitation to.

Example

tcld user resend-invite --user-id <test-user-id>

--request-id​

The request identifier to use for the asynchronous operation.

If not set, the server assigns an identifier.

Alias: -r

set-account-role​

The tcld user set-account-role command sets an account-level Role for the specified user in Temporal Cloud. You must set either --user-email or --user-id.

Alias: ri

The following modifiers control the behavior of the command.

--account-role​

Required modifier

Specify the account-level Role to assign to the user.

Available account roles: admin | developer | read.

Alias: -ar

--user-email​

Specify the email address of the user to assign an account-level Role to.

Alias: -e

Example

tcld user set-account-role --user-email <test@example.com> --account-role Developer

--user-id​

Specify the user identifier of the user to assign an account-level Role to.

Alias: --id

Example

tcld user set-account-role --user-id <test-user-id> --account-role Developer

--request-id​

The request identifier to use for the asynchronous operation.

If not set, the server assigns an identifier.

Alias: -r

--resource-version​

Specify a resource version (ETag) to update from. If not specified, the latest version is used.

Alias: -v

set-namespace-permissions​

The tcld user set-namespace-permissions command sets Namespace-level permissions for a specified user in Temporal Cloud. You must set either --user-email or --user-id.

Alias: snp

The following modifiers control the behavior of the command.

--user-email​

Specify the email address of the user to assign Namespace-level permissions to.

Example

tcld user set-namespace-permissions --user-email <test@example.com>

--user-id​

Specify the user identifier of the user to assign Namespace-level permissions to.

Example

tcld user set-namespace-permissions --user-id <test-user-id>

--request-id​

The request identifier to use to assign Namespace-level permissions to.

If not set, the server assigns an identifier.

Alias: -r

--resource-version​

Specify a resource version (ETag) to assign Namespace-level permissions to. If not specified, the latest version is used.

Alias: -v

--namespace-permission​

Specify the Namespace-level permissions for the invited user. You can supply this modifier multiple times to set multiple Namespace permissions in a single request.

Each value must be in the format of namespace=permission-type.

Available namespace permissions: Admin | Write | Read.

Alias: -p