Delete Permission

Auto-generate your docs

Remove a permission from your workspace. This also removes the permission from all API keys and roles. Important: This operation cannot be undone and immediately affects all API keys and roles that had this permission assigned.

Required Permissions

Your root key must have the following permission:

rbac.*.delete_permission

Request

string

required

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:

All API keys with this permission will lose that access immediately
All roles containing this permission will have it removed
Any verification requests checking for this permission will fail
This action cannot be undone

Before deletion, ensure you:

Have updated any keys or roles that depend on this permission
Have migrated to alternative permissions if needed
Have notified affected users about the access changes

Pattern: ^[a-zA-Z][a-zA-Z0-9._-]*$Length: 3-255 charactersExample: perm_1234567890abcdef

Response

boolean

required

Indicates whether the permission was successfully deleted.

Examples

curl -X POST https://api.unkey.com/v2/permissions.deletePermission \
  -H "Authorization: Bearer <UNKEY_ROOT_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
    "permission": "perm_1234567890abcdef"
  }'

import { Unkey } from "@unkey/api";

const unkey = new Unkey({ token: process.env.UNKEY_ROOT_KEY });

const result = await unkey.permissions.deletePermission({
  permission: "perm_1234567890abcdef",
});

console.log(result.result);

Response Example

{
  "meta": {
    "requestId": "req_1234abcd"
  },
  "data": {
    "success": true
  }
}

Overview

Keys

APIs

Rate Limiting

Identities

Analytics

Permissions

Delete Permission

Required Permissions

Request

Response

Examples

Response Example

​Required Permissions

​Request

​Response

​Examples

​Response Example

Required Permissions

Request

Response

Examples

Response Example