主题
API Key
API Key 是组织级凭证,用于脚本 / CI/CD 调用平台接口(典型用途:上传原型版本)。 管理 API Key 需要组织 admin 及以上角色。
GET /api/orgs/:id/apikeys
列出组织下所有 API Key(不返回明文,只返回元信息)。
鉴权:需 Authorization: Bearer <JWT>(admin+)
响应 200
json
{
"apiKeys": [
{ "id": "...", "name": "...", "prefix": "xxxxxxxx", "createdAt": "...", "revokedAt": null }
]
}POST /api/orgs/:id/apikeys
创建 API Key。明文仅在创建时返回一次,之后无法再查看。
鉴权:需 Authorization: Bearer <JWT>(admin+)
请求体(JSON)
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
name | string | 是 | Key 名称(便于区分) |
响应 201
json
{
"apiKey": {
"id": "...",
"name": "...",
"key": "pk_xxxxxxxx_xxxx",
"createdAt": "..."
}
}
key字段(明文pk_<prefix>_<secret>)只在此响应中出现一次,请立即保存。 平台只存储其 SHA-256 哈希,无法再次获取明文。
DELETE /api/apikeys/:id
吊销 API Key。吊销后立即失效,使用该 Key 的请求会返回 401。
鉴权:需 Authorization: Bearer <JWT>(admin+,且属于该 Key 所在组织)
响应 200
json
{ "apiKey": { "id": "...", "revokedAt": "..." } }