Skip to main content
You need a root key with the permissions listed on this page. Create one in the dashboard under Settings > Root Keys, and pass it as Authorization: Bearer <root key>. See Permission reference for every permission.
Replace a role’s permissions. An empty set removes them all. Keys with the role pick up the change within about 10 seconds. Calls POST /v2/permissions.setRolePermissions. See Roles and permissions.

Usage

Flags

string
Role id or name. Pass this or --role-id.
string
Old name for --role, kept so existing scripts work. Use --role.
string[]
Comma-separated permission slugs that become the role’s full set. Slugs that don’t exist yet are created. Pass an empty value to remove all. Required unless you use --body.

Shared flags

Every unkey api command takes these. See CLI output and shared flags.
string
Root key used for the request. Falls back to UNKEY_ROOT_KEY, then to the key stored by unkey auth login.
string
default:"https://api.unkey.com"
Base URL of the API. Falls back to UNKEY_API_BASE_URL. You don’t normally need to set it.
string
default:"~/.unkey/config.toml"
Path of the config file written by unkey auth login. Falls back to UNKEY_CONFIG.
string
Output format. Falls back to UNKEY_OUTPUT. json prints the full response. Any other value prints the request ID and data.
string
Send this JSON as the whole request body instead of using the command’s flags. You can’t combine it with them.

Required permissions

rbac.*.add_permission_to_role and rbac.*.remove_permission_from_role. Creating new slugs also needs rbac.*.create_permission. See Root key permissions.

Examples

Set
Clear
Or send the whole request as JSON:
Raw body
Last modified on September 29, 2026