MCPツール
後継のAPIキーを作成
sosoapi_renew_api_keyAPIキー(id)の後継キーを、同じ機能権限とワークスペース制限で作成します。新しいシークレットは一度だけ返されます。任意で名前や有効期間(最大365日、エージェント作成キーは30日)を変更できます。元のキーは失効しません。APIキー管理権限が必要です。
Markdownで読むプロファイルと通信方式
プロファイル: full · 通信方式: stdio, http
coreまたはfullで表示ツールを選べますが権限は変わりません。ローカルアップロードはstdioのみでHTTPは非対応です。SOSOAPI_OUTPUT_SCHEMAS=1で検出時に出力スキーマを含めます。設定に関係なく構造化結果を返します。
権限と副作用
注釈はクライアントがツールを説明するためのものです。各呼び出しでは引き続き認証、ロール、リソースアクセス、機能権限を確認します。
{
"readOnlyHint": false,
"destructiveHint": false,
"idempotentHint": false,
"openWorldHint": false
}- /identity-api/api-keys/renew: agent:manage_api_keys · synchronous_http_response
入力フィールド
必須とは、親オブジェクトと選択分岐内で必須という意味です。必須の子があっても任意の親は必須になりません。以下のルールとフィールド名は契約から転記しています。
| フィールド/分岐 | 型/必須 | 制約 |
|---|---|---|
$ | object親要素内で必須 |
|
id | string親要素内で必須 |
|
name | string任意/項目 |
|
lifetime_days | integer任意/項目 | 後継キーの有効日数(1-365、既定365。委任エージェント作成は最大30)。元キーの機能権限とワークスペース制限を維持します。
|
idempotency_key | string任意/項目 | 任意です。同じキーで安全に再試行できます。新シークレットは一回だけ表示し、後継キー作成済みなら409 IDEMPOTENT_REPLAYを返します(details.existing_keyで識別)。失効させて新しいidempotency_keyで再更新してください。
|
完全なJSON Schema
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 80
},
"lifetime_days": {
"description": "Days until the successor expires (1-365, default 365; 30 at most for a key created by a delegated agent). The successor keeps the predecessor's capabilities and Workspace limit.",
"type": "integer",
"minimum": 1,
"maximum": 365
},
"idempotency_key": {
"description": "Optional. Reuse the same key to retry safely. The new secret is shown once: a retry that finds the successor already created answers 409 IDEMPOTENT_REPLAY (details.existing_key names it). Revoke it and renew again with a new idempotency_key.",
"type": "string",
"minLength": 8,
"maxLength": 160,
"pattern": "^[!-~]+$"
}
},
"required": [
"id"
],
"additionalProperties": false
}構造化された出力
このスキーマは、成功時のツール結果に含まれるstructuredContentを説明します。MCPレスポンスはcontentも含み、失敗時にisErrorを設定する場合があります。公開では、受理やテキスト応答を確認済みと扱わず、投稿の最終結果を取得してください。権限・再試行ルールはリンク先のAPI操作をご覧ください。
必須とは、親オブジェクトと選択分岐内で必須という意味です。必須の子があっても任意の親は必須になりません。以下のルールとフィールド名は契約から転記しています。
| フィールド/分岐 | 型/必須 | 制約 |
|---|---|---|
$ | object親要素内で必須 |
|
apiKey | object親要素内で必須 |
|
apiKey.id | string親要素内で必須 |
|
apiKey.name | string親要素内で必須 | — |
apiKey.last_4 | string親要素内で必須 | — |
apiKey.scopes | array親要素内で必須 | — |
apiKey.scopes[] | string任意/項目 | — |
apiKey.created_at | string親要素内で必須 |
|
apiKey.expires_at | string | null親要素内で必須 | — |
apiKey.expires_atanyOf 1 | string親要素内で必須 |
|
apiKey.expires_atanyOf 2 | null親要素内で必須 | — |
apiKey.last_used_at | string | null親要素内で必須 | — |
apiKey.last_used_atanyOf 1 | string親要素内で必須 |
|
apiKey.last_used_atanyOf 2 | null親要素内で必須 | — |
apiKey.revoked_at | string | null親要素内で必須 | — |
apiKey.revoked_atanyOf 1 | string親要素内で必須 |
|
apiKey.revoked_atanyOf 2 | null親要素内で必須 | — |
apiKey.status | string親要素内で必須 |
|
apiKey.replaces | object | null親要素内で必須 | — |
apiKey.replacesanyOf 1 | object親要素内で必須 |
|
apiKey.replaces.idanyOf 1 | string親要素内で必須 |
|
apiKey.replaces.nameanyOf 1 | string親要素内で必須 | — |
apiKey.replaces.last_4anyOf 1 | string親要素内で必須 | — |
apiKey.replaces.statusanyOf 1 | string親要素内で必須 |
|
apiKey.replacesanyOf 2 | null親要素内で必須 | — |
apiKey.replaced_by | array親要素内で必須 | — |
apiKey.replaced_by[] | object任意/項目 |
|
apiKey.replaced_by[].id | string親要素内で必須 |
|
apiKey.replaced_by[].name | string親要素内で必須 | — |
apiKey.replaced_by[].last_4 | string親要素内で必須 | — |
apiKey.replaced_by[].status | string親要素内で必須 |
|
apiKey.capabilities | array任意/項目 | — |
apiKey.capabilities[] | string任意/項目 |
|
apiKey.workspace_ids | array | null任意/項目 | — |
apiKey.workspace_idsanyOf 1 | array任意/項目 | — |
apiKey.workspace_ids[]anyOf 1 | string任意/項目 |
|
apiKey.workspace_idsanyOf 2 | null任意/項目 | — |
apiKey.created_by_delegated_grant_id | string | null任意/項目 | — |
apiKey.created_by_delegated_grant_idanyOf 1 | string任意/項目 |
|
apiKey.created_by_delegated_grant_idanyOf 2 | null任意/項目 | — |
secret | string親要素内で必須 |
|
完全なJSON Schema
{
"type": "object",
"properties": {
"apiKey": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
},
"last_4": {
"type": "string"
},
"scopes": {
"type": "array",
"items": {
"type": "string"
}
},
"created_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"expires_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"last_used_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"revoked_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"status": {
"type": "string",
"enum": [
"active",
"expired",
"revoked"
]
},
"replaces": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
},
"last_4": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"active",
"expired",
"revoked"
]
}
},
"required": [
"id",
"name",
"last_4",
"status"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"replaced_by": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
},
"last_4": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"active",
"expired",
"revoked"
]
}
},
"required": [
"id",
"name",
"last_4",
"status"
],
"additionalProperties": false
}
},
"capabilities": {
"type": "array",
"items": {
"type": "string",
"enum": [
"agent:operate",
"agent:publish",
"agent:engage"
]
}
},
"workspace_ids": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
},
{
"type": "null"
}
]
},
"created_by_delegated_grant_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"name",
"last_4",
"scopes",
"created_at",
"expires_at",
"last_used_at",
"revoked_at",
"status",
"replaces",
"replaced_by"
],
"additionalProperties": false
},
"secret": {
"type": "string",
"minLength": 1
}
},
"required": [
"apiKey",
"secret"
],
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false
}ツール呼び出しの例
スキーマ確認済みの架空値の例です。認可されたID、準備済みメディア、確認済みの公開日時に置き換え、書き込み前に適格性を確認してください。このページはAPIを呼びません。
{
"name": "sosoapi_renew_api_key",
"arguments": {
"id": "11111111-1111-4111-8111-111111111111"
}
}structuredContent
{
"apiKey": {
"id": "11111111-1111-4111-8111-111111111111",
"name": "example",
"last_4": "example",
"scopes": [],
"created_at": "2099-01-15T09:00:00Z",
"expires_at": null,
"last_used_at": null,
"revoked_at": null,
"status": "active",
"replaces": null,
"replaced_by": []
},
"secret": "example"
}