UNunkeyed
keys

Set key permissions

Changed on

Replace all permissions on a key with the specified set in a single atomic operation.

Use this to synchronize with external systems, reset permissions to a known state, or apply standardized permission templates. Permissions granted through roles remain unchanged.

Important: Changes take effect immediately with up to 30-second edge propagation.

Required Permissions

Your root key must have one of the following permissions:

  • api.*.update_key (to update keys in any API)
  • api.<api_id>.update_key (to update keys in a specific API)

Side Effects

Invalidates the key cache for immediate effect, and makes permission changes available for verification within 30 seconds across all regions.

post/v2/keys.setPermissions

Request

  • Base URL
    https://api.unkey.com
  • URL
    https://api.unkey.com/v2/keys.setPermissions
  • Auth
    HTTP bearer

Request body

keyIdstring required

Specifies which key receives the additional permissions using the database identifier returned from keys.createKey. Do not confuse this with the actual API key string that users include in requests.

permissionsstring[] required

The permissions to set for this key.

This is a complete replacement operation - it overwrites all existing direct permissions with this new set.

Key behaviors:

  • Providing an empty array removes all direct permissions from the key
  • This only affects direct permissions - permissions granted through roles are not affected
  • All existing direct permissions not included in this list will be removed

Any permissions that do not exist will be auto created if the root key has permissions, otherwise this operation will fail with a 403 error.

Example request

{
  "keyId": "key_2cGKbMxRyIzhCxo1Idjz8q"
}

Response

Permissions set successfully. Returns all permissions currently assigned to the key.

Example response

{
  "meta": {
    "requestId": "req_123"
  },
  "data": [
    {
      "id": "perm_1234567890abcdef",
      "name": "users.read",
      "slug": "users-read",
      "description": "Allows reading user profile information and account details"
    }
  ]
}

Changes

  • 59efaed65ec4Revision changes
    • warning

      the / request property's maxLength was set to 128

    • info

      the / request property's minLength was decreased from 3 to 1

  • 43ad1ce9a152Revision changes
    • info

      the endpoint scheme security dashboard was removed from the API

    • info

      the endpoint scheme security rootKey was removed from the API