Skip to main content

Documentation Index

Fetch the complete documentation index at: https://unkey.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Retrieve all roles in your workspace including their assigned permissions. Results are paginated and sorted by their id. Use this to audit your access control setup, verify role-permission mappings, or build automation that reacts to your current RBAC configuration. Required permissions:
  • rbac.*.read_role
See the API reference for the full HTTP endpoint documentation.

​
Usage

unkey api permissions list-roles [flags]

​
Flags

​
--limit
integer
Maximum number of roles to return in a single response (1-100, default 100). Use smaller values for faster response times and better UI performance. Use larger values when you need to process many roles efficiently. Results exceeding this limit will be paginated with a cursor for continuation.
​
--cursor
string
Pagination cursor from a previous response to fetch the next page of roles. Include this when you need to retrieve additional roles beyond the first page. Each response containing more results will include a cursor value that can be used here. Leave empty or omit this flag to start from the beginning of the role list.

​
Global Flags

FlagTypeDescription
--root-keystringOverride root key ($UNKEY_ROOT_KEY)
--api-urlstringOverride API base URL (default: https://api.unkey.com)
--configstringPath to config file (default: ~/.unkey/config.toml)
--outputstringOutput format. Use json for raw JSON

​
Examples

unkey api permissions list-roles

​
Output

Default output shows the request ID with latency, followed by the list of roles and their permissions: 
req_2c9a0jf23l4k567 (took 32ms)

[
  {
    "id": "role_1234567890abcdef",
    "name": "support.readonly",
    "description": "Provides read-only access for customer support representatives",
    "permissions": [
      {
        "id": "perm_abc123",
        "name": "tickets.read"
      }
    ]
  }
]
With --output=json, the full response envelope is returned including pagination metadata: 
{
  "meta": {
    "requestId": "req_2c9a0jf23l4k567"
  },
  "data": [
    {
      "id": "role_1234567890abcdef",
      "name": "support.readonly",
      "description": "Provides read-only access for customer support representatives",
      "permissions": [
        {
          "id": "perm_abc123",
          "name": "tickets.read"
        }
      ]
    }
  ],
  "pagination": {
    "cursor": "eyJrZXkiOiJyb2xlXzEyMzQiLCJ0cyI6MTY5OTM3ODgwMH0=",
    "hasMore": true
  }
}
Last modified on May 6, 2026