Skip to main content

Update User (V2)

This operation updates the password or description of a specified user.

POST/v2/vectordb/users/update_password
Connection Endpoint

The base URL for this API is in the following format:

https://${CLUSTER_ENDPOINT}

📘Notes
  • You need to fill in ${CLUSTER_ENDPOINT} with that of your Zilliz Cloud cluster.
  • To get the endpoint, use the Describe Cluster V2 API to extract the values from the responses.
shell
export CLUSTER_ENDPOINT=""
Parameters
Authorizationstringheaderrequired

The authentication token should be an API key with appropriate privileges or a pair of colon-joined username and password, like username:password.

Example Value: Bearer {{TOKEN}}
Request Bodyapplication/json
userNamestringrequired

The name of the target user. The value should start with a letter and can only contain underline, letters and numbers.

passwordstring<password>

The current password of the user. Provide this field together with newPassword when changing the password.

newPasswordstring<password>

The new password for the user. Provide this field together with password when changing the password.

descriptionstring

The new description of the user. The value can be an empty string.

bash
export TOKEN="db_admin:xxxxxxxxxxxxx"

curl --request POST \
--url "${CLUSTER_ENDPOINT}/v2/vectordb/users/update_password" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Request-Timeout: 5" \
--header "Content-Type: application/json" \
-d '{
    "newPassword": "P@ssw0rd!",
    "userName": "myUser",
    "password": "P@ssw0rd*"
}'
Responses200 OK - application/json

Return an empty object or an error message

A success response

codeinteger

Response code.

Example Value: 0
dataobject

Response payload which is an empty object.

A failure response.

codeinteger

Response code.

messagestring

Error message.

Successjson
{
    "code": 0,
    "data": {}
}
Ctrl I