Describe User
This operation describes the detailed information of a specific user.
POST
/v2/vectordb/users/describeThe base URL for this API is in the following format:
http://localhost:19530
export CLUSTER_ENDPOINT="http://localhost:19530"
Parameters
Authorizationstringheaderrequired
The authentication token should be 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.
export TOKEN="root:Milvus"
curl --request POST \--url "${CLUSTER_ENDPOINT}/v2/vectordb/users/describe" \--header "Authorization: Bearer ${TOKEN}" \--header "Content-Type: application/json" \-d '{ "userName": "my_user"}'
Responses200 - application/json
A success response.
codeinteger
Response code.
Example Value: 0
dataarray
Response payload which is a list of roles already assigned to the user.
[]datastring
The name of a role assigned to the specified user.
A failure response.
codeinteger
Response code.
messagestring
Error message.
{ "code": 0, "data": [ "public" ]}