Skip to main content
PUT
Set User Group Permissions
Business Edition FeatureThis feature requires a Business or Enterprise plan. View plans or contact sales to learn more.
Required permission: Admin (admin).

Authorizations

Authorization
string
header
required

Authorization header with Bearer token

Path Parameters

user_group_id
integer
required

Body

application/json
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

Response

Successful Response

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