# APIキーを失効

正規URL： https://sosoapi.ai/ja/docs/mcp/revoke-api-key

`sosoapi_revoke_api_key`

idを指定してAPIキーを直ちに失効させます。すでに失効している場合はalready_revokedを返します。エージェントが失効できるのは、自身の認可で作成したキーのみです。APIキー管理権限が必要です。

## プロファイルと通信方式

プロファイル： full

通信方式： stdio, http

coreまたはfullで表示ツールを選べますが権限は変わりません。ローカルアップロードはstdioのみでHTTPは非対応です。SOSOAPI_OUTPUT_SCHEMAS=1で検出時に出力スキーマを含めます。設定に関係なく構造化結果を返します。

## 権限と副作用

注釈はクライアントがツールを説明するためのものです。各呼び出しでは引き続き認証、ロール、リソースアクセス、機能権限を確認します。

```json
{
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true,
  "openWorldHint": false
}
```

`/identity-api/api-keys/revoke` — agent:manage_api_keys; synchronous_http_response

## 入力フィールド

```json
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid"
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false
}
```

## 構造化された出力

このスキーマは、成功時のツール結果に含まれるstructuredContentを説明します。MCPレスポンスはcontentも含み、失敗時にisErrorを設定する場合があります。公開では、受理やテキスト応答を確認済みと扱わず、投稿の最終結果を取得してください。権限・再試行ルールはリンク先のAPI操作をご覧ください。

```json
{
  "type": "object",
  "properties": {
    "ok": {
      "type": "boolean",
      "const": true
    },
    "already_revoked": {
      "type": "boolean"
    }
  },
  "required": [
    "ok",
    "already_revoked"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#",
  "additionalProperties": false
}
```

## ツール呼び出しの例

スキーマ確認済みの架空値の例です。認可されたID、準備済みメディア、確認済みの公開日時に置き換え、書き込み前に適格性を確認してください。このページはAPIを呼びません。

```json
{
  "name": "sosoapi_revoke_api_key",
  "arguments": {
    "id": "11111111-1111-4111-8111-111111111111"
  }
}
```

structuredContent

```json
{
  "ok": true,
  "already_revoked": false
}
```

## 基礎となるAPI操作

- [/identity-api/api-keys/revoke](https://sosoapi.ai/ja/docs/api/identity-api-api-keys-revoke)