MCP tool

列出 API keys

sosoapi_list_api_keys

列出自己 API keys 嘅名稱、最後四個字元、狀態、到期日及接替關係；include_authority 可加能力及工作空間限制。唔會回傳 secret。需要 Manage API keys 授權；PAT 唔可以用。

閱讀 Markdown

Profiles 及連接方式

Profiles: full · Transports: stdio, http

Profile 只影響工具可見性，唔會授權。HTTP 冇本機檔案上傳。SOSOAPI_OUTPUT_SCHEMAS=1 會宣告輸出 schema；兩種模式都會回傳 structured results。

權限及改動

MCP annotations 只係發現提示，唔係存取控制保證；仍然有實際登入、角色、資源及能力檢查。

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

/identity-api/api-keys/list: agent:manage_api_keys · synchronous_http_response

輸入欄位

必填表示喺所屬物件及所選分支內必須提供；子欄位必填唔代表可選父物件變成必填。以下欄位名稱及規則直接來自 contract。

輸入欄位
欄位／分支	類型／必填	限制
`$`	`object`父物件內必填	`additionalProperties: false`
`include_revoked`	`boolean`可選／陣列項目	—
`include_authority`	`boolean`可選／陣列項目	Also return each key's capabilities, Workspace limit (null = every Workspace) and the delegated grant that created it. —

完整 JSON Schema

{
  "type": "object",
  "properties": {
    "include_revoked": {
      "type": "boolean"
    },
    "include_authority": {
      "description": "Also return each key's capabilities, Workspace limit (null = every Workspace) and the delegated grant that created it.",
      "type": "boolean"
    }
  },
  "additionalProperties": false
}

結構化輸出

此 schema 描述成功工具結果嘅 structuredContent。MCP envelope 亦包括 content，失敗可能設定 isError；唔好將文字收據或接受請求當成平台終態。權限及重試規則見對應 API 操作。

必填表示喺所屬物件及所選分支內必須提供；子欄位必填唔代表可選父物件變成必填。以下欄位名稱及規則直接來自 contract。

結構化輸出
欄位／分支	類型／必填	限制
`$`	`object`父物件內必填	`additionalProperties: false`
`apiKeys`	`array`父物件內必填	—
`apiKeys[]`	`object`可選／陣列項目	`additionalProperties: false`
`apiKeys[].id`	`string`父物件內必填	`format: "uuid"`
`apiKeys[].name`	`string`父物件內必填	—
`apiKeys[].last_4`	`string`父物件內必填	—
`apiKeys[].scopes`	`array`父物件內必填	—
`apiKeys[].scopes[]`	`string`可選／陣列項目	—
`apiKeys[].created_at`	`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)))$"`
`apiKeys[].expires_at`	`string \| null`父物件內必填	—
`apiKeys[].expires_at`anyOf 1	`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)))$"`
`apiKeys[].expires_at`anyOf 2	`null`父物件內必填	—
`apiKeys[].last_used_at`	`string \| null`父物件內必填	—
`apiKeys[].last_used_at`anyOf 1	`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)))$"`
`apiKeys[].last_used_at`anyOf 2	`null`父物件內必填	—
`apiKeys[].revoked_at`	`string \| null`父物件內必填	—
`apiKeys[].revoked_at`anyOf 1	`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)))$"`
`apiKeys[].revoked_at`anyOf 2	`null`父物件內必填	—
`apiKeys[].status`	`string`父物件內必填	`enum: ["active","expired","revoked"]`
`apiKeys[].replaces`	`object \| null`父物件內必填	—
`apiKeys[].replaces`anyOf 1	`object`父物件內必填	`additionalProperties: false`
`apiKeys[].replaces.id`anyOf 1	`string`父物件內必填	`format: "uuid"`
`apiKeys[].replaces.name`anyOf 1	`string`父物件內必填	—
`apiKeys[].replaces.last_4`anyOf 1	`string`父物件內必填	—
`apiKeys[].replaces.status`anyOf 1	`string`父物件內必填	`enum: ["active","expired","revoked"]`
`apiKeys[].replaces`anyOf 2	`null`父物件內必填	—
`apiKeys[].replaced_by`	`array`父物件內必填	—
`apiKeys[].replaced_by[]`	`object`可選／陣列項目	`additionalProperties: false`
`apiKeys[].replaced_by[].id`	`string`父物件內必填	`format: "uuid"`
`apiKeys[].replaced_by[].name`	`string`父物件內必填	—
`apiKeys[].replaced_by[].last_4`	`string`父物件內必填	—
`apiKeys[].replaced_by[].status`	`string`父物件內必填	`enum: ["active","expired","revoked"]`
`apiKeys[].capabilities`	`array`可選／陣列項目	—
`apiKeys[].capabilities[]`	`string`可選／陣列項目	`enum: ["agent:operate","agent:publish","agent:engage"]`
`apiKeys[].workspace_ids`	`array \| null`可選／陣列項目	—
`apiKeys[].workspace_ids`anyOf 1	`array`可選／陣列項目	—
`apiKeys[].workspace_ids[]`anyOf 1	`string`可選／陣列項目	`format: "uuid"`
`apiKeys[].workspace_ids`anyOf 2	`null`可選／陣列項目	—
`apiKeys[].created_by_delegated_grant_id`	`string \| null`可選／陣列項目	—
`apiKeys[].created_by_delegated_grant_id`anyOf 1	`string`可選／陣列項目	`format: "uuid"`
`apiKeys[].created_by_delegated_grant_id`anyOf 2	`null`可選／陣列項目	—

完整 JSON Schema

{
  "type": "object",
  "properties": {
    "apiKeys": {
      "type": "array",
      "items": {
        "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
      }
    }
  },
  "required": [
    "apiKeys"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#",
  "additionalProperties": false
}

工具呼叫範例

以下虛構值已按 contract 驗證，唔係真實帳戶 ID、憑證或發佈紀錄。請用已授權範圍回傳嘅 ID、已準備好嘅素材及已審核排程取代，寫入前核對平台資格。此頁唔會呼叫 API。

{
  "name": "sosoapi_list_api_keys",
  "arguments": {}
}

structuredContent

{
  "apiKeys": []
}

/identity-api/api-keys/list

安裝或連接 MCP