milvus-logo
LFAI
< Docs

reset_password()

This operation resets the password for a specific user.

notes

This operation differs from update_password() in that this operation also resets the current connection using the newly set credentials.

Request Syntax

reset_password(
    user: str,
    old_password: str,
    new_password: str,
    using: str,
    timeout: float | None
)

PARAMETERS:

  • user (str) -

    [REQUIRED]

    The specific user whose password is to be reset.

  • old_password (str) -

    [REQUIRED]

    The original password for the specified user.

    Setting this to an incorrect password results in a MilvusException.

  • new_password (str) -

    [REQUIRED]

    The new password for the specified user.

    The password must be a string of 8 to 64 characters and must include at least three of the following character types: uppercase letters, lowercase letters, numbers, and special characters.

  • using (string) -

    The alias of the employed connection.

    The default value is default, indicating that this operation employs the default connection.

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

Examples

from pymilvus import connections, utility

# Connection to localhost:19530
connections.connect()

# Create a user
user = utility.create_user(user="admin", password="123456")

# Reset the password for the user.
reset_password(
    user="admin",
    old_password="123456",
    new_password="123456Abc*",
    using="default"
)

Related operations

The following operations are related to reset_password()

Try Managed Milvus for Free

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

Get Started
Feedback

Was this page helpful?