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 details about a specific permission including its name, description, and metadata. Use this to inspect a permission’s current state, verify its configuration, or look up its name and description. The returned data includes the permission’s unique ID, human-readable name, URL-safe slug, and optional description. Required permissions:
  • rbac.*.read_permission (to read permissions in any workspace)
See the API reference for the full HTTP endpoint documentation.

​
Usage

unkey api permissions get-permission [flags]

​
Flags

​
--permission
string
required
The unique identifier of the permission to retrieve. Must be a valid permission ID that begins with perm_ and exists within your workspace.

​
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 get-permission --permission=perm_1234567890abcdef

​
Output

Default output shows the request ID with latency, followed by the permission details: 
req_1234abcd (took 38ms)

{
  "id": "perm_1234567890abcdef",
  "name": "documents.read",
  "slug": "documents-read",
  "description": "Allows reading document resources"
}
With --output=json, the full response envelope is returned: 
{
  "meta": {
    "requestId": "req_1234abcd"
  },
  "data": {
    "id": "perm_1234567890abcdef",
    "name": "documents.read",
    "slug": "documents-read",
    "description": "Allows reading document resources"
  }
}
Last modified on May 6, 2026