Unkey · Schema

V2PermissionsDeletePermissionRequestBody

API KeysRate LimitingAuthenticationDeveloper PlatformAccess ControlIdentityAnalytics

Properties

Name Type Description
permission string Specifies which permission to permanently delete from your workspace. This can be a permission ID or a permission slug. WARNING: Deleting a permission has immediate and irreversible consequences: - Al
View JSON Schema on GitHub

JSON Schema

unkey-v2permissionsdeletepermissionrequestbody-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/V2PermissionsDeletePermissionRequestBody",
  "title": "V2PermissionsDeletePermissionRequestBody",
  "type": "object",
  "required": [
    "permission"
  ],
  "properties": {
    "permission": {
      "type": "string",
      "minLength": 3,
      "maxLength": 255,
      "pattern": "^[a-zA-Z][a-zA-Z0-9._-]*$",
      "description": "Specifies which permission to permanently delete from your workspace.\n\nThis can be a permission ID or a permission slug.\n\nWARNING: Deleting a permission has immediate and irreversible consequences:\n- All API keys with this permission will lose that access immediately\n- All roles containing this permission will have it removed\n- Any verification requests checking for this permission will fail\n- This action cannot be undone\n\nBefore deletion, ensure you:\n- Have updated any keys or roles that depend on this permission\n- Have migrated to alternative permissions if needed\n- Have notified affected users about the access changes\n",
      "example": "perm_1234567890abcdef"
    }
  },
  "additionalProperties": false
}