get-role - Unkey Docs

Retrieve details about a specific role including its assigned permissions.

Use this to verify role configuration, check which permissions are currently assigned, or retrieve metadata for access review. Accepts either a role ID (starting with role_) or a role name.

Required permissions:

rbac.*.read_role (to read roles in any workspace)

Note

See the API reference for the full HTTP endpoint documentation.

Usage#

unkey api permissions get-role [flags]

Flags#

--rolestringrequired#

Role ID (starting with role_) or role name to retrieve. Must be 1-128 characters. Returns complete role information including all assigned permissions.

Global Flags#

Flag	Type	Description
`--root-key`	string	Override root key (`$UNKEY_ROOT_KEY`)
`--api-url`	string	Override API base URL (default: `https://api.unkey.com`)
`--config`	string	Path to config file (default: `~/.unkey/config.toml`)
`--output`	string	Output format. Use `json` for raw JSON
`--body`	string	Send this JSON string as the request body. You cannot combine it with request-building flags.

Examples#

unkey api permissions get-role --role=role_1234567890abcdef

Output#

Default output shows the request ID, followed by the role details:

req_2c9a0jf23l4k567{  "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:

{  "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"      }    ]  }}