创建 Vault - Qoder CN

描述

创建 Vault，并设置 metadata。

路径

POST /api/v1/forward/vaults

请求头

头部	必选	说明
`Authorization`	是	`Bearer <PAT 或 SAT>`
`Idempotency-Key`	否	可选创建请求幂等键。传入时相同 key 只能用于相同请求；不传时不提供本地幂等重放保护。
`Content-Type`	是	`application/json`

查询参数

参数	类型	必选	说明
`identity_id`	string	否	仅在操作 Identity 归属资源时使用，非必填；PAT 场景可显式传入，未传时为管理员视角；SAT 场景请签发 Identity 维度凭证且不要显式携带该参数，否则返回 HTTP 400（详见 Identity 归属）。

请求体

字段	类型	必选	说明
`display_name`	string	是	Vault 展示名。
`metadata`	object	否	元数据对象；`created_by` 为保留字段，不可传入（传入返回 400）。

示例请求

curl -X POST "https://api.qoder.com.cn/api/v1/forward/vaults" \
  -H "Authorization: Bearer $QODER_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "display_name": "mcp-vault",
    "metadata": {"source": "console"}
  }'

示例响应

HTTP 201 Created

{
  "id": "vault_xxx",
  "type": "vault",
  "display_name": "mcp-vault",
  "metadata": {
    "source": "console"
  },
  "created_at": "2026-07-23T10:00:00Z",
  "updated_at": "2026-07-23T10:00:00Z",
  "identity_id": null
}

响应字段解释

字段	类型	说明
`id`	string	Vault ID。
`type`	string	固定为 `vault`。
`display_name`	string	Vault 展示名。
`metadata`	object	Vault 元数据。
`created_at`	string	创建时间，RFC 3339 格式。
`updated_at`	string	最后更新时间，RFC 3339 格式。
`identity_id`	string/null	Forward 归属身份；归属为某个 Identity 时返回该 Identity ID，否则为 `null`。

错误码

HTTP	type	触发条件
400	`invalid_request_error`	请求体、路径参数或查询参数非法；或 SAT 携带了 `identity_id`。
400	`invalid_request_error`	传入保留键 `created_by` 时，`message` 为 `metadata key "created_by" is reserved`，可据此定位到具体字段。
401	`authentication_error`	缺少或无效的认证令牌。
403	`permission_error`	未指定 `identity_id` 的 PAT、Admin SAT 发生 Owner mismatch，或当前调用方存在其他权限不足。
404	`not_found_error`	`identity_id` 无效、已禁用、不属于当前调用方，或指定归属下的目标资源不存在。
409	`conflict_error`	资源状态、引用关系或幂等键冲突。
500/502/503	`api_error`	Forward 或依赖服务失败。

​描述

​路径

​请求头

​查询参数

​请求体

​示例请求

​示例响应

​响应字段解释

​错误码

描述

路径

请求头

查询参数

请求体

示例请求

示例响应

响应字段解释

错误码