update_user()

This operation updates the description of an existing user.

Request syntax

client.update_user(
    user_name: str,
    description: str,
    timeout: Optional[float] = None
) -> None

PARAMETERS:

  • user_name (str) -

    [REQUIRED]

    The name of an existing user.

  • description (str) -

    [REQUIRED]

    The new description of the user.

  • 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.

Example

from pymilvus import MilvusClient

client = MilvusClient(
    uri="http://localhost:19530",
    token="root:Milvus"
)

# Create a user
client.create_user(
    user_name="user_1",
    password="password"
)

client.update_user(
    user_name="user_1",
    description="Data engineer with full access",
)

Try Managed Milvus for Free

Zilliz Cloud is hassle-free, powered by Milvus and 10x faster.

Get Started
Feedback

Was this page helpful?