milvus-logo
LFAI
< Docs
  • RESTful

List Roles

This operation lists the information about all existing roles.

POST
/v2/vectordb/roles/list
Cluster Endpoint

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

http://localhost:19530

export CLUSTER_ENDPOINT="http://localhost:19530"
Parameters
Request-Timeoutintegerheader

The timeout duration for this operation. Setting this to None indicates that this operation times out when any response returns or an error occurs.

Example Value: 0
Authorizationstringheaderrequired

The authentication token should be a pair of colon-joined username and password, like username:password.

Example Value: Bearer {{TOKEN}}
Request Bodyapplication/json
export TOKEN="root:Milvus"
curl --request POST \
--url "${CLUSTER_ENDPOINT}/v2/vectordb/roles/list" \
--header "Request-Timeout: 0" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json" \
-d '{}'
Responses200 - application/json
codeinteger

Response code.

Example Value: 0
dataarray

Response payload which is a list of item objects.

[]datastring

A list of item objects.

A failure response.

codeinteger

Response code.

messagestring

Error message.

{
"code": 0,
"data": [
"admin",
"public"
]
}