Skip to content

禁用 API Key

POST/web/v1/workspaces/{workspaceId}/api-keys/{keyId}/disableJWT

禁用一个处于启用状态的 API Key。一旦禁用,使用该 Key 进行鉴权的所有请求将被拒绝。

鉴权

Auth Chain: WEB Chain — 需要 Authorization: Bearer <jwt> 需要工作空间 OWNER 角色。 以下请求头由系统自动注入(前端无需处理): X-PORTAL-ACCESS-CODE (Nginx), X-Request-Id (Gateway)

请求参数

NameTypeRequiredInDescription
workspaceIdstringYespath工作空间业务 ID
keyIdstringYespathAPI Key 业务 ID

成功响应

无内容200
{
  "version": "1.3.0",
  "timestamp": 1709337600000,
  "success": true,
  "code": "2000",
  "message": "SUCCESS",
  "data": null
}

错误响应

未授权401
{
  "success": false,
  "code": "4010",
  "message": "Invalid or expired token"
}
禁止访问 — 非工作空间所有者403
{
  "success": false,
  "code": "4030",
  "message": "Only workspace owner can manage API keys"
}

说明

  • 禁用操作是可逆的;可使用启用 API Key 接口重新激活。
  • 仅工作空间 OWNER 可以禁用 API Key。

内部文档