Skip to main content

List Privilege Groups (V2)

This operation lists all privilege groups in the current database.

POST/v2/vectordb/privilege_groups/list
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. If you are using a project endpoint, only a valid API key with sufficient permissions applies.

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

The name of the database.

bash
export TOKEN="db_admin:xxxxxxxxxxxxx"

curl --request POST \
--url "${CLUSTER_ENDPOINT}/v2/vectordb/privilege_groups/list" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Request-Timeout: 5" \
--header "Content-Type: application/json" \
-d '{}'
Responses200 OK - application/json

None

One possible response shape returned on success, carrying the code and data fields.

codeinteger

The response code indicating whether the request succeeded.

dataobject

The response payload, which holds the privilege groups returned by the request.

privilegeGroupsarray

The privilege groups returned by the request.

[]privilegeGroupsobject

One privilege group entry in the response payload.

privilegeGroupNamestring

The name of the privilege group.

privilegesstring

The privileges included in the privilege group, joined by commas.

Returns an error message.

codeinteger

Response code.

messagestring

Error message.

Successjson
{
    "code": 0,
    "data": {
        "privilegeGroups": [
            {
                "privilegeGroupName": "my_priv_group",
                "privileges": "Insert,Search"
            }
        ]
    }
}
Ctrl I