在指定 Vault 中创建一个 Credential。auth 为多态结构,支持 environment_variable、static_bearer、mcp_oauth 三种类型。secret_value 等敏感值仅写入时传入,响应中不返回。
前提
已完成 Endpoint 与鉴权配置,详见API 总览与认证。
接口
POST /credentials
请求体
| 字段 | 必填 | 类型 | 说明 |
|---|---|---|---|
vault_id | 是 | string | 所属 Vault ID,格式 vlt_xxx |
auth | 是 | object | 认证信息,多态结构,通过 type 区分。 |
display_name | 否 | string | Credential 可读名称,最大 255 字符 |
metadata | 否 | object | 业务自定义键值对元数据 |
auth 类型
auth 字段支持三种类型,通过 type 区分。
environment_variable
以环境变量形式注入会话。
| 字段 | 必填 | 类型 | 说明 |
|---|---|---|---|
type | 是 | string | 固定为 environment_variable |
secret_name | 是 | string | 环境变量名称,创建后不可修改 |
secret_value | 是 | string | 环境变量值,仅写入时传入,响应中不返回 |
networking | 是 | object | 网络策略,当前仅支持 {"type": "unrestricted"} |
static_bearer
静态 Bearer Token,用于访问需要 Token 认证的 MCP Server。
| 字段 | 必填 | 类型 | 说明 |
|---|---|---|---|
type | 是 | string | 固定为 static_bearer |
token | 是 | string | Bearer Token 值 |
mcp_server_url | 是 | string | MCP Server 地址 |
mcp_oauth
MCP OAuth 认证,用于 OAuth 流程授权的 MCP Server。
| 字段 | 必填 | 类型 | 说明 |
|---|---|---|---|
type | 是 | string | 固定为 mcp_oauth |
access_token | 是 | string | OAuth Access Token |
mcp_server_url | 是 | string | MCP Server 地址 |
expires_at | 否 | string | Token 过期时间,ISO 8601 |
refresh | 否 | object | Token 刷新配置 |
请求示例
响应
响应字段
| 字段 | 类型 | 说明 |
|---|---|---|
id | string | Credential ID,格式 cred_xxx |
type | string | 固定为 credential |
vault_id | string | 所属 Vault ID |
display_name | string | Credential 可读名称 |
auth | object | 认证信息,敏感值已脱敏(如 secret_value、token、access_token 不返回) |
auth.type | string | 认证类型:environment_variable、static_bearer 或 mcp_oauth |
auth.secret_name | string | 环境变量名称(environment_variable 类型) |
auth.networking | object | 网络策略(environment_variable 类型) |
auth.mcp_server_url | string | MCP Server 地址(static_bearer / mcp_oauth 类型) |
auth.expires_at | string | Token 过期时间,ISO 8601(mcp_oauth 类型) |
metadata | object | 业务自定义键值对 |
archived_at | string | null | 归档时间,未归档时为 null |
created_at | string | 创建时间,ISO 8601 |
updated_at | string | 最近更新时间,ISO 8601 |
request_id | string | 请求唯一标识 |
错误码
| 状态码 | 错误码 | 说明 |
|---|---|---|
| 400 | InvalidParameter | Required parameter missing or invalid. |
| 401 | InvalidApiKey | Invalid API-key provided. |