Describe Role

This operation describes the details of a specified role.

Example

export MILVUS_URI="localhost:19530"

curl --location --request POST "http://${MILVUS_URI}/v2/vectordb/roles/describe" \
--header "Content-Type: application/json" \
--data-raw '{
    "roleName": "readOnly"
}'

Possible response is similar to the following .

{
    "code": 200,
    "data": [
        {
             "objectType": "Collection",
             "objectName": "*",
             "privilege": "Search",
             "roleName": "readOnly"
        }
    ]
}

Request

Parameters

• Header parameters

  Parameter	Description
  Request-Timeout	integer The timeout duration for this operation. Setting this to None indicates that this operation timeouts when any response arrives or any error occurs.
  Authorization	string The authentication token.

• No query parameters required

• No path parameters required

Request Body

{
    "roleName": "string"
}

Parameter	Description
roleName *	string The name of the role.

Response

An object that contains the detailed desription of a role.

Response Bodies

• Response body if we process your request successfully

{
    "code": "integer",
    "data": [
        {
            "object_type": "string",
            "privilege": "string",
            "object_name": "string",
            "db_name": "string",
            "grantor": "string"
        }
    ]
}

• Response body if we failed to process your request

{
    "code": integer,
    "message": string
}

Properties

The properties in the returned response are listed in the following table.

Property	Description
code	integer Indicates whether the request succeeds. 200: The request succeeds. Others: Some error occurs.
data	array A list of privilege items.
data[]	object
data[].object_type	string The type of the object to which the privilege belongs.
data[].privilege	string The privilege that is granted to the role.
data[].object_name	string The name of the object to which the role is granted the specified privilege.
data[].db_name	string The name of the database in which this operation has been executed.
data[].grantor	string The name of the user who granted a specific role to a user.
message	string Indicates the possible reason for the reported error.