Describe Role

This operation describes the details of a specified role.

POST
/v2/vectordb/roles/describe
Cluster Endpoint

The 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
roleNamestringrequired

The name of the role.

dbNamestring

Name of the database. If not specified, the default database is used.

descriptionstring

An optional description string, providing human-readable text for the addressed object.

Example
export TOKEN="root:Milvus"
curl --request POST \
--url "${CLUSTER_ENDPOINT}/v2/vectordb/roles/describe" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Request-Timeout: 5" \
--header "Content-Type: application/json" \
-d '{
"roleName": "root"
}'
Responses

An object that contains the detailed desription of a role.

A success response.

codeinteger

Response code.

Example Value: 0
dataarray

Response payload which is a list of privilege items.

[]dataobject

A privilege item.

object_typestring

The type of the object to which the privilege belongs.

privilegestring

The privilege that is granted to the role.

object_namestring

The name of the object to which the role is granted the specified privilege.

db_namestring

The name of the database in which this operation has been executed.

grantorstring

The name of the user who granted a specific role to a user.

descriptionstring

The description of the role.

A failure response.

codeinteger

Response code.

messagestring

Error message.

Success
{
"code": 0,
"data": [
{
"db_name": "*",
"grantor": "root",
"object_name": "*",
"object_type": "Global",
"privilege": "ShowCollections"
},
{
"db_name": "*",
"grantor": "root",
"object_name": "*",
"object_type": "Global",
"privilege": "ShowCollections"
},
{
"db_name": "*",
"grantor": "root",
"object_name": "*",
"object_type": "Global",
"privilege": "ShowCollections"
}
],
"description": "Grants read-only access to analytics collections."
}