Unkey · Schema

V2KeysRemovePermissionsRequestBody

API KeysRate LimitingAuthenticationDeveloper PlatformAccess ControlIdentityAnalytics

Properties

Name Type Description
keyId string Specifies which key to remove permissions from using the database identifier returned from `keys.createKey`. Do not confuse this with the actual API key string that users include in requests.
permissions array Removes direct permissions from the key without affecting role-based permissions. You can either use a permission slug, or the permission ID. After removal, verification checks for these permissions w
View JSON Schema on GitHub

JSON Schema

unkey-v2keysremovepermissionsrequestbody-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/V2KeysRemovePermissionsRequestBody",
  "title": "V2KeysRemovePermissionsRequestBody",
  "type": "object",
  "required": [
    "keyId",
    "permissions"
  ],
  "properties": {
    "keyId": {
      "type": "string",
      "minLength": 3,
      "maxLength": 255,
      "pattern": "^[a-zA-Z0-9_]+$",
      "description": "Specifies which key to remove permissions from using the database identifier returned from `keys.createKey`.\nDo not confuse this with the actual API key string that users include in requests.\n",
      "example": "key_2cGKbMxRyIzhCxo1Idjz8q"
    },
    "permissions": {
      "type": "array",
      "minItems": 1,
      "maxItems": 1000,
      "description": "Removes direct permissions from the key without affecting role-based permissions.\n\nYou can either use a permission slug, or the permission ID.\n\nAfter removal, verification checks for these permissions will fail unless granted through roles.\n",
      "items": {
        "type": "string",
        "minLength": 3,
        "pattern": "^[a-zA-Z0-9_:\\-\\.\\*]+$",
        "description": "Specify the permission by its slug."
      }
    }
  },
  "additionalProperties": false
}