Skip to main content
GET
Get Permission Registry
Enterprise Edition FeatureThis feature requires an Enterprise plan. View plans or contact sales to learn more.
Required permission: Admin (admin).

Authorizations

Authorization
string
header
required

Authorization header with Bearer token

Response

Successful Response

id
string
required
display_name
string
required
description
string
required
permissions
enum<string>[]
required

Permission tokens for group-based authorization and PAT scoping. full_admin_panel_access is an override — if present, any permission check passes.

The read:/write: "API-surface scopes" are coarser than the capability tokens: they name request surfaces (search, chat, admin-read) rather than admin capabilities. They are implied by basic / admin (so they're never granted directly to a group) and exist primarily to scope Personal Access Tokens.

Available options:
basic,
read:connectors,
read:document_sets,
read:agents,
read:users,
read:user_groups,
read:search,
read:chat,
write:chat,
read:admin,
generate:image,
use:llm_gateway,
add:agents,
manage:agents,
manage:document_sets,
manage:connectors,
manage:llms,
read:agent_analytics,
manage:actions,
manage:skills,
read:query_history,
manage:user_groups,
create:user_api_keys,
manage:service_account_api_keys,
manage:bots,
craft_sandbox,
admin
group
integer
required
default_group_toggleable
boolean
required
read-only

Whether the row is offered on the Basic group's page.