iam.api_key.revoke

Revoke an API key: the key itself is disabled and EVERY token generation it ever minted is revoked. Effective immediately — there is no token cache.

• Scope: admin.users.write
• System: no
• Reachable from: POST /v1/commands/iam.api_key.revoke (tenant credential) · MCP tool iam.api_key.revoke · SDK client.call('iam.api_key.revoke', …)
• Events: iam.api_key.revoked

Input (JSON Schema)

{
  "properties": {
    "api_key_id": {
      "minLength": 1,
      "type": "string"
    }
  },
  "required": [
    "api_key_id"
  ],
  "type": "object"
}

Result (200)

{
  "additionalProperties": false,
  "properties": {
    "api_key_id": {
      "type": "string"
    }
  },
  "required": [
    "api_key_id"
  ],
  "type": "object"
}

Errors

validation_failed (400) · unauthorized (401) · forbidden (403) · conflict (409) · internal (500)