Manage users and user tags

Create, query, update, disable, or delete users, and maintain tags used to classify users. This page does not create roles or configure permission policies.

Prerequisites

Prepare credentials that can access the target workspace. For service endpoints, authentication, and general request formats, see Prepare to call an API.

Before updating, disabling, deleting, or binding roles, obtain the target user ID from the user list. Before managing tags, list the available tags.

Call sequence

  1. First list users to identify a target user or create a new user.

  2. After creation or update, query user-role bindings. To change roles, update the bindings, then query again to confirm.

  3. To classify users by business purpose, create or update tags and query the tag list to confirm the result.

  4. Before disabling or deleting a user, query user information and related records, then confirm impact and conditions on the action page.

API operations

Create and maintain users

What you need to do

API operation

Use it when

Create a user

Create a user

Create a new user.

Query users

List users

Select a target user or confirm a change.

Update user information

Update a user

You have the user ID and need to modify user information.

Update user status

Update user status

Adjust a target user’s status.

Delete a user

Delete a user

Confirm impact and conditions on the action page before deletion.

Query user audit events

List user audit events

View audit events for a target user.

Manage user-role bindings

What you need to do

API operation

Use it when

Query user-role bindings

Get user-role bindings

Confirm a user’s roles before or after updating.

Update user-role bindings

Update user-role bindings

You identified a user and roles and need to adjust their bindings.

Manage user tags

What you need to do

API operation

Use it when

Create a tag

Create a user tag

You need a new user tag.

Query tags

List user tags

Select or confirm tags.

Update a tag

Update a user tag

You have the tag ID and need to modify it.

Delete a tag

Delete a user tag

Confirm impact and conditions on the action page before deletion.

Confirm the result

After user changes, use List users and Get user-role bindings to confirm the result. After tag changes, use List user tags to confirm them.

Limitations and notes

Deleting users or tags and updating user status affect the target objects. Confirm conditions and results on the corresponding action page before proceeding.

Next steps

Last updated on