# Describe role

Inspect a role and the privileges granted to it.

SDK: `@zilliz/milvus2-sdk-node@3.0.10` · Tested with Milvus 3.0.6

Canonical documentation: https://milvus-io.github.io/milvus-sdk-node/rest-api/roles/describe/

## Section links

- [cURL command](https://milvus-io.github.io/milvus-sdk-node/rest-api/roles/describe/#curl-command)
- [Default request](https://milvus-io.github.io/milvus-sdk-node/rest-api/roles/describe/#default-request)
- [Sample response](https://milvus-io.github.io/milvus-sdk-node/rest-api/roles/describe/#sample-response)
- [Request fields](https://milvus-io.github.io/milvus-sdk-node/rest-api/roles/describe/#request-fields)

`POST /v2/vectordb/roles/describe`

Replace `https://your-cluster.example.com` with your Milvus endpoint. Set `MILVUS_TOKEN` for authentication or omit the Authorization header on an unauthenticated cluster.

## cURL command

```bash
curl --request POST --url 'https://your-cluster.example.com/v2/vectordb/roles/describe' \
  --header 'Content-Type: application/json' \
  --header "Authorization: Bearer ${MILVUS_TOKEN}" \
  --data-raw '{
  "dbName": "default",
  "roleName": "catalog_reader"
}'
```

## Default request

```json
{
  "dbName": "default",
  "roleName": "catalog_reader"
}
```

## Sample response

```json
{
  "code": 0,
  "data": [
    {
      "objectType": "Collection",
      "objectName": "books",
      "privilege": "Search",
      "dbName": "default",
      "grantor": "root"
    }
  ],
  "description": "Read access for the catalog application"
}
```

## Request fields

- `dbName` string
  Database name. Operations on collections use default when omitted.
- `roleName` string (required)
  Milvus role name.
- `description` string
  Human-readable description.

See [`HttpClient.describeRole`](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#describerole) for the Node.js SDK method.
