UpdatePasswordAsync()

Updates a user’s password.

public async Task UpdatePasswordAsync(UpdatePasswordReq request, CancellationToken cancellationToken = default)

Request Syntax

var request = new UpdatePasswordReq
{
    UserName = "alice",
    OldPassword = "p@ssw0rd",
    NewPassword = "new_p@ss",
    Description = "Alice's account"
};

await client.UpdatePasswordAsync(request);

REQUEST PARAMETERS:

  • UserName (string) -

    The name of the user whose password to update.

  • OldPassword (string) -

    The current password of the user.

  • NewPassword (string) -

    The new password for the user.

  • Description (string?) -

    An optional description for the user, updated together with the password.

  • ResetConnection (bool) -

    When true, the client’s connection is reset with the new credentials after the password change, so subsequent RPCs authenticate as the updated user. When false (default), the connection is left untouched except that an own-password change for the current user refreshes the authorization header automatically.

RETURN TYPE:

Task

RETURNS:

This method does not return a value.

EXCEPTIONS:

  • MilvusException

    Thrown when the RPC fails or the server returns an error. Inspect the exception message for details.

Example

using Milvus.Client.V2;
using Milvus.Client.V2.Requests.Rbac;

using var client = new MilvusClientV2(new ConnectConfig
{
    Uri = "localhost:19530",
    Username = "root",
    Password = "Milvus"
});
await client.ConnectAsync();

await client.UpdatePasswordAsync(new UpdatePasswordReq
{
    UserName = "alice",
    OldPassword = "p@ssw0rd",
    NewPassword = "new_p@ss"
});

Try Managed Milvus for Free

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

Get Started
Feedback

Was this page helpful?