Unkey · Schema
V2PermissionsDeleteRoleRequestBody
API KeysRate LimitingAuthenticationDeveloper PlatformAccess ControlIdentityAnalytics
Properties
| Name | Type | Description |
|---|---|---|
| role | string | Unique identifier of the role to permanently delete from your workspace. Must either be a valid role ID that begins with 'role_' or the given role name and exists within your workspace. WARNING: Delet |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/V2PermissionsDeleteRoleRequestBody",
"title": "V2PermissionsDeleteRoleRequestBody",
"type": "object",
"required": [
"role"
],
"properties": {
"role": {
"type": "string",
"pattern": "^[a-zA-Z0-9_:\\-\\.\\*]+$",
"minLength": 3,
"maxLength": 255,
"description": "Unique identifier of the role to permanently delete from your workspace.\nMust either be a valid role ID that begins with 'role_' or the given role name and exists within your workspace.\n\nWARNING: Deletion is immediate and irreversible with significant consequences:\n- All API keys assigned this role will lose the associated permissions\n- Access to resources protected by this role's permissions will be denied\n- Any authorization logic depending on this role will start failing\n- Historical analytics referencing this role remain intact\n\nBefore deletion, ensure:\n- You've updated any dependent authorization logic or code\n- You've migrated any keys to use alternative roles or direct permissions\n- You've notified relevant team members of the access changes\n",
"example": "role_dns_manager"
}
},
"additionalProperties": false
}