Skip to main content
Credentials

Credential 数据结构

Forward Credential API 复用的响应与鉴权对象结构。

Vault credential 对象

创建、查询、列表、归档接口都会返回该结构。凭证密文(如 tokenaccess_tokenrefresh_tokenclient_secretsecret_value)只在创建请求中接收,永远不会在响应中返回。
字段类型说明
idstringCredential ID,前缀为 vcred_
typestring固定值 "vault_credential"
vault_idstring所属 Vault ID
authCredential auth object脱敏后的鉴权信息;不会返回密文
display_namestring | null兼容字段;当前固定为 null,不持久化
metadataobject与 credential 一起存储的自定义元数据对象;省略时为 {}
archived_atstring | null归档时间,RFC 3339 格式;active 时为 null
created_atstring创建时间,RFC 3339 格式
updated_atstring最后更新时间,RFC 3339 格式

创建 credential 请求

字段类型必填说明
authCredential auth object凭证鉴权信息
display_namestring兼容字段;当前响应固定为 null,不持久化
metadataobject与 credential 一起存储的自定义元数据对象;省略时为 {}

Credential auth object

auth 通过 type 区分鉴权类型。响应中不会回填任何密文字段。

static_bearer

字段类型必填说明
typestring固定值 "static_bearer"
mcp_server_urlstringMCP server URL,最长 2048 字符
tokenstring是(请求)静态 Bearer token;仅创建请求接收,响应中不返回

mcp_oauth

字段类型必填说明
typestring固定值 "mcp_oauth"
mcp_server_urlstringMCP server URL,最长 2048 字符
client_idstringOAuth 客户端 ID
client_secretstring是(请求)OAuth 客户端 secret;仅创建请求接收,响应中不返回
access_tokenstring否(请求)已完成 OAuth 换取的 access token;仅创建请求接收,响应中不返回
refresh_tokenstring否(请求)OAuth refresh token;仅创建请求接收,响应中不返回

secret_value

字段类型必填说明
typestring固定值 "secret_value"
secret_valuestring是(请求)通用密文;仅创建请求接收,响应中不返回
具体鉴权类型的可用集合以 Forward Credential API 的创建接口为准;未列出的类型将在创建时返回 400 invalid_request_error

列表分页字段

字段类型说明
dataVault credential 对象 数组当前页记录
has_moreboolean是否还有下一页
next_pagestring | null下一页向后游标(推荐使用);has_more=true 时等于当前页 last_id,否则为 null
first_idstring | null当前页第一条记录 ID
last_idstring | null当前页最后一条记录 ID
请求侧的三种游标参数 page / after_id / before_id 互斥,同时提供多个返回 400;推荐使用 page,语义等价于 after_id
Credential 数据结构 - Qoder