Unkey · Schema

V2KeysSetPermissionsResponseData

Complete list of all permissions now directly assigned to the key after the set operation has completed. The response includes: - The comprehensive, updated set of direct permissions (reflecting the complete replacement) - Both ID and name for each permission for easy reference Important notes: - This only shows direct permissions, not those granted through roles - An empty array means the key has no direct permissions assigned - For a complete permission picture including roles, use keys.getKey instead

API KeysRate LimitingAuthenticationDeveloper PlatformAccess ControlIdentityAnalytics
View JSON Schema on GitHub

JSON Schema

unkey-v2keyssetpermissionsresponsedata-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/V2KeysSetPermissionsResponseData",
  "title": "V2KeysSetPermissionsResponseData",
  "type": "array",
  "description": "Complete list of all permissions now directly assigned to the key after the set operation has completed.\n\nThe response includes:\n- The comprehensive, updated set of direct permissions (reflecting the complete replacement)\n- Both ID and name for each permission for easy reference\n\nImportant notes:\n- This only shows direct permissions, not those granted through roles\n- An empty array means the key has no direct permissions assigned\n- For a complete permission picture including roles, use keys.getKey instead",
  "items": {
    "$ref": "#/components/schemas/Permission"
  }
}