Drop User

This operation deletes an existing user.

POST

/v2/vectordb/users/drop

Cluster 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, refer to On Zilliz Cloud Console or use the Describe Cluster V2 API to extract the values from the responses.

export CLUSTER_ENDPOINT=""

Parameters

Request-Timeoutintegerheader

The timeout duration for this operation. Setting this to None indicates that this operation timeouts when any response arrives or any error occurs.

Example Value: 0

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.

export TOKEN="db_admin:xxxxxxxxxxxxx"

curl --request POST \
--url "${CLUSTER_ENDPOINT}/v2/vectordb/users/drop" \
--header "Request-Timeout: 0" \
--header "Content-Type: application/json" \
-d '{
    "userName": "my_user"
}'

Responses200 - application/json

SUCCESS

A success response

codeinteger

Response code.

Example Value: 0

dataobject

Response payload which is an empty object.

FAILURE

A failure response.

codeinteger

Response code.

messagestring

Error message.

SUCCESS

{
    "code": 0,
    "data": {}
}