Copy

描述

在指定 Vault 下创建 Credential；敏感认证字段不会在响应中回显。

路径

POST /api/v1/forward/vaults/{id}/credentials

请求头

头部	必选	说明
`Authorization`	是	`Bearer <PAT 或 SAT>`
`Idempotency-Key`	否	可选创建请求幂等键。相同 key 只能用于相同请求。
`Content-Type`	是	`application/json`

路径参数

参数	类型	必选	说明
`id`	string	是	Vault ID。

请求体

字段	类型	必选	说明
`auth`	object	是	Credential 认证信息，支持 `static_bearer`、`mcp_oauth`、`environment_variable`；响应只返回脱敏后的非密文字段。
`display_name`	string	否	兼容字段；当前不持久化，Forward 响应固定为空字符串。
`metadata`	object	否	元数据对象；`created_by` 为保留字段，不可传入（传入返回 400）。

auth 字段

static_bearer：

字段	类型	必选	说明
`type`	string	是	固定为 `static_bearer`。
`mcp_server_url`	string	是	MCP Server URL。
`token`	string	是	Bearer token，仅写入，响应不回显。

mcp_oauth：

字段	类型	必选	说明
`type`	string	是	固定为 `mcp_oauth`。
`mcp_server_url`	string	是	MCP Server URL。
`access_token`	string	是	OAuth access token，仅写入，响应不回显。
`expires_at`	string	否	Access token 过期时间，RFC 3339 格式。
`refresh`	object	否	OAuth 刷新配置，其中的密文字段不会在响应中回显。

environment_variable：

字段	类型	必选	说明
`type`	string	是	固定为 `environment_variable`。
`secret_name`	string	是	环境变量名，必须匹配 `[A-Za-z_][A-Za-z0-9_]*`。
`secret_value`	string	是	环境变量值，仅写入，响应不回显。

auth.protocol 不是 Forward Credential 请求字段，传入不会生效。

示例请求

{
  "auth": {
    "type": "static_bearer",
    "mcp_server_url": "https://mcp.example.com",
    "token": "secret_token"
  },
  "display_name": "example-mcp",
  "metadata": {
    "source": "console"
  }
}

示例响应

HTTP 201 Created

{
  "id": "vcred_xxx",
  "type": "vault_credential",
  "vault_id": "vault_xxx",
  "auth": {
    "type": "static_bearer",
    "mcp_server_url": "https://mcp.example.com"
  },
  "display_name": "",
  "metadata": {
    "source": "console"
  },
  "created_at": "2026-07-23T10:00:00Z",
  "updated_at": "2026-07-23T10:00:00Z"
}

响应字段解释

字段	类型	说明
`id`	string	Credential ID。
`type`	string	固定为 `vault_credential`。
`vault_id`	string	所属 Vault ID。
`auth`	object	脱敏后的认证信息。
`display_name`	string	当前固定为空字符串。
`metadata`	object	Credential 元数据。
`created_at`	string	创建时间，RFC 3339 格式。
`updated_at`	string	最后更新时间，RFC 3339 格式。

错误码

HTTP	type	触发条件
400	`invalid_request_error`	请求体、路径参数或查询参数非法。
400	`invalid_request_error`	传入保留键 `created_by` 时，`message` 为 `metadata key "created_by" is reserved`，可据此定位到具体字段。
401	`authentication_error`	缺少或无效的认证令牌。
403	`permission_error`	当前调用方无权访问该资源。
404	`not_found_error`	Vault 不存在或不可见。
409	`conflict_error`	资源状态、引用关系或幂等键冲突。
500/502/503	`api_error`	Forward 或依赖服务失败。

​描述

​路径

​请求头

​路径参数

​请求体

​auth 字段

​示例请求

​示例响应

​响应字段解释

​错误码

描述

路径

请求头

路径参数

请求体

auth 字段

示例请求

示例响应

响应字段解释

错误码