grant_role()
This operation grants a role to a user.
Request syntax
grant_role(
user_name: str,
role_name: str,
timeout: Optional[float] = None
) -> None
PARAMETERS:
-
user_name (str) -
[REQUIRED]
The name of an existing user.
-
role_name (str) -
[REQUIRED]
The name of the role to assign.
-
timeout (float | None)
The timeout duration for this operation.
Setting this to None indicates that this operation timeouts when any response arrives or any error occurs.
RETURN TYPE:
NoneType
RETURNS:
None
EXCEPTIONS:
-
MilvusException
This exception will be raised when any error occurs during this operation.
-
BaseException
This exception will be raised when this operation fails.
Example
from pymilvus import MilvusClient
# 1. Create a milvus client
client = MilvusClient(
uri="https://inxx-xxxxxxxxxxxx.api.gcp-us-west1.zillizcloud.com:19530",
token="user:password"
)
# 2. Grant the role to the user
client.grant_role(user_name="user_1", role_name="db_ro")
📘Notes
Each Zilliz Cloud cluster has three built-in roles, namely, db_ro, db_rw, and db_admin. For details, refer to Cluster Built-in Roles.