Unkey · Schema

V2KeysAddRolesResponseData

Complete list of all roles directly assigned to the key after the operation completes. The response includes: - All roles now assigned to the key (both pre-existing and newly added) - Both ID and name of each role for easy reference Important notes: - The response shows the complete current state after the addition - An empty array means the key has no roles assigned (unlikely after an add operation) - This only shows direct role assignments, not inherited or nested roles - Role permissions are not expanded in this response - use keys.getKey for full details

API KeysRate LimitingAuthenticationDeveloper PlatformAccess ControlIdentityAnalytics
View JSON Schema on GitHub

JSON Schema

unkey-v2keysaddrolesresponsedata-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/V2KeysAddRolesResponseData",
  "title": "V2KeysAddRolesResponseData",
  "type": "array",
  "description": "Complete list of all roles directly assigned to the key after the operation completes.\n\nThe response includes:\n- All roles now assigned to the key (both pre-existing and newly added)\n- Both ID and name of each role for easy reference\n\nImportant notes:\n- The response shows the complete current state after the addition\n- An empty array means the key has no roles assigned (unlikely after an add operation)\n- This only shows direct role assignments, not inherited or nested roles\n- Role permissions are not expanded in this response - use keys.getKey for full details",
  "items": {
    "$ref": "#/components/schemas/Role"
  }
}