Unkey · Schema

V2KeysRemoveRolesRequestBody

APIKeysRate LimitingAuthenticationDeveloper PlatformAccess ControlIdentityAnalytics

Properties

Name Type Description
keyId string Specifies which key loses the roles using the database identifier returned from createKey. Do not confuse this with the actual API key string that users include in requests. Removing roles only affect
roles array Removes direct role assignments from the key without affecting other role sources or permissions. Operations are idempotent - removing non-assigned roles has no effect and causes no errors. After remo
View JSON Schema on GitHub

JSON Schema

unkey-v2keysremoverolesrequestbody-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/V2KeysRemoveRolesRequestBody",
  "title": "V2KeysRemoveRolesRequestBody",
  "type": "object",
  "required": [
    "keyId",
    "roles"
  ],
  "properties": {
    "keyId": {
      "type": "string",
      "minLength": 3,
      "maxLength": 255,
      "pattern": "^[a-zA-Z0-9_]+$",
      "description": "Specifies which key loses the roles using the database identifier returned from createKey.\nDo not confuse this with the actual API key string that users include in requests.\nRemoving roles only affects direct assignments, not permissions inherited from other sources.\nRole changes take effect immediately but may take up to 30 seconds to propagate across all regions.\n",
      "example": "key_2cGKbMxRyIzhCxo1Idjz8q"
    },
    "roles": {
      "type": "array",
      "minItems": 1,
      "maxItems": 100,
      "description": "Removes direct role assignments from the key without affecting other role sources or permissions.\nOperations are idempotent - removing non-assigned roles has no effect and causes no errors.\n\nAfter removal, the key loses access to permissions that were only granted through these roles.\nInvalid role references cause the entire operation to fail atomically, ensuring consistent state.\n",
      "items": {
        "type": "string",
        "pattern": "^[a-zA-Z0-9_:\\-\\.\\*]+$",
        "minLength": 3,
        "maxLength": 255,
        "description": "Specify the role by name."
      }
    }
  },
  "additionalProperties": false
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/unkey-v2keysremoverolesrequestbody"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

A second provider on the same verified email joins the account you already have.