Skip to content

Commit

Permalink
Merge pull request #2750 from SimFG/patch-4
Browse files Browse the repository at this point in the history
add comments for object_type and obect_name
  • Loading branch information
shanghaikid authored Aug 7, 2024
2 parents 1594c09 + 832132b commit cf66f2d
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions site/en/adminGuide/rbac.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,8 @@ client.list_roles()

The following example demonstrates how to grant the permission of searching all collections to the role named `roleA`. See [Users and Roles](users_and_roles.md) for other types of privileges you can grant.

The `object_type` specifies the object type, which can also be understood as the resource type. Currently, valid values ​​include Collection/User/Global, etc., where Global means that there is no specific resource type. `object_name` is the object name, that is, the resource name. If object_type is Collection, then object name refers to a specific collection name. If object_type is Global, then object name is specified as *.

Before managing role privileges, make sure you have enabled user authentication. Otherwise, an error may occur. For information on how to enable user authentication, refer to [Authenticate User Access](authenticate.md).

```python
Expand Down

0 comments on commit cf66f2d

Please sign in to comment.