Remove a role from your workspace. This also removes the role from all assigned API keys.
Important: This operation cannot be undone and immediately affects all API keys that had this role assigned. All keys with this role will lose the associated permissions, and access to resources protected by this role's permissions will be denied.
Required permissions:
rbac.*.delete_role
Note
See the API reference for the full HTTP endpoint documentation.
Usage#
Flags#
The role ID or name to permanently delete. Must be 1-128 characters and either a valid role ID that begins with role_ or a role name that exists within your workspace.
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#
Output#
Default output shows the request ID:
With --output=json, the full response envelope is returned: