Skip to main content

tcb role update

v3.0.0+

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

Update role information (name, description, members, policy).

Usage​

tcb role update --id <roleId> [options]
System Role Modification Restrictions
  • Administrator Role: Can only modify members, cannot modify policies
  • Registered Users/Organization Members/Anonymous Users/All Users: Can only modify policies, cannot modify members
  • All System Roles: Role names cannot be modified
  • Custom Role: All of the above can be modified

Parameters​

ParameterDescription
--id <roleId>role ID (required)
--name <name>Modify the role name (for custom roles only)
--description <desc>Modify the role description
--add-users <uids>Add members, comma-separated UIDs
--remove-users <uids>Remove members, comma-separated UIDs
--add-policies <json>Add policies, same format as role create --policies
--remove-policies <json>Remove policies, pass an array of policy code strings
-e, --env-id <envId>Environment ID

Examples​

# Modifying the Role Name
tcb role update --id 2032299359962361858 --name "Senior Developer" -e my-env-id

# Simultaneously Adding/Removing Members
tcb role update --id 2032299359962361858 \
--add-users "1001,1002" \
--remove-users "1003" \
-e my-env-id

# Modifying Policies
tcb role update --id 2032299359962361858 \
--add-policies '["FunctionsAccess"]' \
--remove-policies '["StoragesDeny"]' \
-e my-env-id