火山方舟
火山方舟
API参考
请输入
- 文档首页
火山方舟Managed Agents APIVaults凭证管理更新凭证
复制全文
下载 pdf更新凭证
文档反馈
问问助手POST https://ark.cn-beijing.volces.com/api/v3/vaults/{vault_id}/credentials/{credential_id}
更新指定凭证的展示信息、元数据或可轮换的鉴权信息。请求体不包含任何可更新字段时，接口返回当前凭证信息，不修改内容或更新时间。
对于 OAuth 凭证，可以轮换访问令牌、更新过期时间、启用自动刷新或更新自动刷新所需信息。省略的字段保留原值。
响应不返回以下密文字段：access_token、token、secret_value、refresh_token 和 client_secret。
鉴权
- API Key 鉴权，请在 API Key 管理 页面，获取长效 API Key。
请求参数
Path 参数
credential_id string 必选 | 凭证 ID
凭证 ID，以 vcrd- 开头。
vault_id string 必选 | 保管库 ID
保管库 ID，以 vlt- 开头。
Body 参数
auth object | 鉴权配置
用于更新凭证的鉴权信息。
- 省略时，保留全部原值。
- 提供时，只需填写 type 和需要修改的字段，其他未修改字段无需重复提供。
- type 用于标识当前凭证类型，必须与当前值一致。
注意
更新 mcp_static.token 时，服务端会同步访问目标 MCP 服务：
- 返回内容不符合 MCP 协议时，返回 HTTP 424 MCPInvalidResponse。
- MCP 服务返回 5xx 或连接异常时，返回 HTTP 424 UpstreamUnavailable。
- 校验失败时，不更新凭证。
MCP OAuth 凭证 object
用于更新 MCP OAuth 凭证，可轮换访问令牌、启用自动刷新或更新自动刷新所需信息。
type string 必选 | 鉴权类型
auth.type
用于标识当前凭证为 MCP OAuth 类型。更新 auth 时必填，不能修改为其他类型。
取值固定为 mcp_oauth。
access_token string | 访问令牌
auth.access_token
用于访问 MCP 服务的 OAuth 访问令牌。省略时保留原值，提供时整体替换。
expires_at string | 过期时间
auth.expires_at
访问令牌的过期时间，采用 RFC 3339 格式。服务端根据该时间判断是否需要自动刷新；省略时保留原值，提供时整体替换。
mcp_server_url string | MCP 服务器 URL
auth.mcp_server_url
MCP 服务的访问地址。更新时无需提供；如果提供，必须与当前值一致，否则返回 HTTP 409 Conflict。
refresh object | 访问令牌刷新
auth.refresh
用于启用或更新访问令牌自动刷新。启用自动刷新时，提供完整对象；已启用自动刷新后，只需提供需要更新的字段，未提供的字段保留原值。
client_id string | 客户端 ID
auth.refresh.client_id
向 OAuth 令牌端点请求访问令牌时使用的客户端 ID。启用自动刷新时必填；更新自动刷新信息时无需提供，如果提供则必须与当前值一致。
refresh_token string | 刷新令牌
auth.refresh.refresh_token
用于向 OAuth 令牌端点获取新访问令牌的刷新令牌。启用自动刷新时必填；更新自动刷新信息时，省略该字段会保留原值，提供时会整体替换。
resource string | 资源标识
auth.refresh.resource
OAuth 授权请求对应的资源标识。省略时保留原值，提供时整体替换。
scope string | 授权范围
auth.refresh.scope
OAuth 令牌允许访问的权限范围。省略时保留原值，提供时整体替换。
token_endpoint string | OAuth 令牌端点
auth.refresh.token_endpoint
用于刷新访问令牌的 OAuth 端点地址。启用自动刷新时必填；更新自动刷新信息时无需提供，如果提供则必须与当前值一致。
token_endpoint_auth object | OAuth 客户端鉴权
auth.refresh.token_endpoint_auth
服务端向 OAuth 令牌端点提交刷新请求时使用的客户端鉴权配置。启用自动刷新时，根据鉴权方式提供完整对象；更新自动刷新信息时，仅更新显式传入的字段。
type string 必选 | 鉴权方式
auth.refresh.token_endpoint_auth.type
服务端向 OAuth 令牌端点提交刷新请求时使用的客户端鉴权方式：
- none：仅提交 client_id，不使用客户端密钥。
- client_secret_basic：通过 HTTP Basic Authentication 提交 client_id 和 client_secret。
- client_secret_post：在请求体中提交 client_id 和 client_secret。
client_secret string | 客户端密钥
auth.refresh.token_endpoint_auth.client_secret
OAuth 客户端密钥。
- 启用自动刷新时，如果 type 为 client_secret_basic 或 client_secret_post，必须提供该字段；如果 type 为 none，必须省略该字段。
- 更新自动刷新信息时，省略该字段会保留原值，提供时会整体替换。
静态 Bearer 令牌凭证 object
用于更新静态 Bearer 令牌凭证，可轮换令牌但不能更改 MCP 服务地址。
type string 必选 | 鉴权类型
auth.type
用于标识当前凭证为静态 Bearer 令牌类型。更新 auth 时必填，不能修改为其他类型。
取值固定为 static_bearer。
mcp_server_url string | MCP 服务器 URL
auth.mcp_server_url
MCP 服务的访问地址。更新时无需提供；如果提供，必须与当前值一致，否则返回 HTTP 409 Conflict。
token string | Bearer 令牌
auth.token
用于访问 MCP 服务的静态 Bearer 令牌。省略时保留原值，提供时整体替换。
MCP 静态凭证 object
用于更新 MCP 静态凭证，可轮换密钥但不能更改目标地址或注入方式。
type string 必选 | 鉴权类型
auth.type
用于标识当前凭证为 MCP 静态密钥类型。更新 auth 时必填，不能修改为其他类型。
取值固定为 mcp_static。
injection_name string | 注入名
auth.injection_name
自定义请求头名称或查询参数名。更新时无需提供；如果提供，必须与当前值一致，否则返回 HTTP 409 Conflict。
injection_type string | 注入方式
auth.injection_type
静态密钥的注入方式。更新时无需提供；如果提供，必须与当前值一致，否则返回 HTTP 409 Conflict。取值：bearer / header / query。
mcp_server_url string | MCP 服务器 URL
auth.mcp_server_url
MCP 服务的访问地址。更新时无需提供；如果提供，必须与当前值一致，否则返回 HTTP 409 Conflict。
token string | 密钥值
auth.token
注入 MCP 请求的静态密钥。
- 省略时，保留原值。
- 提供时，整体替换且不能为空。
- injection_type 为 bearer 时，不要包含 Bearer 前缀。
环境变量注入凭证 object
用于更新环境变量凭证，可替换凭证值和网络范围但不能更改环境变量名。
type string 必选 | 鉴权类型
auth.type
用于标识当前凭证为环境变量类型。更新 auth 时必填，不能修改为其他类型。
取值固定为 environment_variable。
networking object | 网络范围
auth.networking
控制凭证可以注入的目标主机范围。省略时保留原值，提供时整体替换并重新校验。
type string 必选 | 网络范围类型
auth.networking.type
控制凭证可以注入的目标主机范围：
- unrestricted：可以注入发往任意公网主机的请求。
- limited：仅可以注入发往 allowed_hosts 所列主机的请求。
allowed_hosts string[] | 允许主机列表
auth.networking.allowed_hosts
type 为 limited 时允许注入的主机列表。
- 提供 1～16 个不重复的主机。
- 每项可为域名、IPv4 地址或 *.example.com 形式的通配域名。
- 不接受 URL、端口、路径或 IPv6 地址。
secret_name string | 环境变量名
auth.secret_name
向运行环境注入凭证时使用的环境变量名。更新时无需提供；如果提供，必须与当前值一致，否则返回 HTTP 409 Conflict。
secret_value string | 环境变量值
auth.secret_value
向运行环境注入的凭证值。省略时保留原值，提供时整体替换且不能为空，最大为 4096 字节。
环境 OAuth 凭证 object
用于更新环境 OAuth 凭证，可轮换访问令牌、启用自动刷新、更新自动刷新所需信息或更新网络范围。
type string 必选 | 鉴权类型
auth.type
用于标识当前凭证为环境 OAuth 类型。更新 auth 时必填，不能修改为其他类型。
取值固定为 env_oauth。
access_token string | 访问令牌
auth.access_token
向运行环境注入并用于目标服务鉴权的 OAuth 访问令牌。省略时保留原值，提供时整体替换。
expires_at string | 过期时间
auth.expires_at
访问令牌的过期时间，采用 RFC 3339 格式。服务端根据该时间判断是否需要自动刷新；省略时保留原值，提供时整体替换。
networking object | 网络范围
auth.networking
控制访问令牌可以注入的目标主机范围。省略时保留原值，提供时整体替换并重新校验。
type string 必选 | 网络范围类型
auth.networking.type
控制凭证可以注入的目标主机范围：
- unrestricted：可以注入发往任意公网主机的请求。
- limited：仅可以注入发往 allowed_hosts 所列主机的请求。
allowed_hosts string[] | 允许主机列表
auth.networking.allowed_hosts
type 为 limited 时允许注入的主机列表。
- 提供 1～16 个不重复的主机。
- 每项可为域名、IPv4 地址或 *.example.com 形式的通配域名。
- 不接受 URL、端口、路径或 IPv6 地址。
refresh object | 访问令牌刷新
auth.refresh
用于启用或更新访问令牌自动刷新。启用自动刷新时，提供完整对象；已启用自动刷新后，只需提供需要更新的字段，未提供的字段保留原值。
client_id string | 客户端 ID
auth.refresh.client_id
向 OAuth 令牌端点请求访问令牌时使用的客户端 ID。启用自动刷新时必填；更新自动刷新信息时无需提供，如果提供则必须与当前值一致。
refresh_token string | 刷新令牌
auth.refresh.refresh_token
用于向 OAuth 令牌端点获取新访问令牌的刷新令牌。启用自动刷新时必填；更新自动刷新信息时，省略该字段会保留原值，提供时会整体替换。
resource string | 资源标识
auth.refresh.resource
OAuth 授权请求对应的资源标识。省略时保留原值，提供时整体替换。
scope string | 授权范围
auth.refresh.scope
OAuth 令牌允许访问的权限范围。省略时保留原值，提供时整体替换。
token_endpoint string | OAuth 令牌端点
auth.refresh.token_endpoint
用于刷新访问令牌的 OAuth 端点地址。启用自动刷新时必填；更新自动刷新信息时无需提供，如果提供则必须与当前值一致。
token_endpoint_auth object | OAuth 客户端鉴权
auth.refresh.token_endpoint_auth
服务端向 OAuth 令牌端点提交刷新请求时使用的客户端鉴权配置。启用自动刷新时，根据鉴权方式提供完整对象；更新自动刷新信息时，仅更新显式传入的字段。
type string 必选 | 鉴权方式
auth.refresh.token_endpoint_auth.type
服务端向 OAuth 令牌端点提交刷新请求时使用的客户端鉴权方式：
- none：仅提交 client_id，不使用客户端密钥。
- client_secret_basic：通过 HTTP Basic Authentication 提交 client_id 和 client_secret。
- client_secret_post：在请求体中提交 client_id 和 client_secret。
client_secret string | 客户端密钥
auth.refresh.token_endpoint_auth.client_secret
OAuth 客户端密钥。
- 启用自动刷新时，如果 type 为 client_secret_basic 或 client_secret_post，必须提供该字段；如果 type 为 none，必须省略该字段。
- 更新自动刷新信息时，省略该字段会保留原值，提供时会整体替换。
secret_name string | 环境变量名
auth.secret_name
向运行环境注入访问令牌时使用的环境变量名。更新时无需提供；如果提供，必须与当前值一致，否则返回 HTTP 409 Conflict。
display_name string | 凭证展示名
凭证的展示名称，用于在凭证列表和详情中识别该凭证。不能只包含空白字符；省略时保留原值。
metadata object | 自定义元数据
用于分类或关联业务信息的字符串键值对。按键新增或覆盖，未出现的键保留，空字符串作为普通值保存；更新后最多 16 对，键长度为 1～64 个字符，值最长 512 个字符。
响应参数
auth object | 鉴权配置
凭证的鉴权方式及可公开返回的配置。字段结构由 type 决定，响应只返回与 type 匹配的一种结构。
MCP OAuth 凭证 object
服务端返回 MCP OAuth 凭证的鉴权类型和 MCP 服务地址。配置自动刷新时，还返回访问令牌过期时间和用于刷新访问令牌的字段。
响应不返回访问令牌、刷新令牌或客户端密钥。
mcp_server_url string | MCP 服务器 URL
auth.mcp_server_url
MCP 服务的访问地址。
type string | 鉴权类型
auth.type
表示该凭证使用 OAuth 访问令牌连接 MCP 服务。
取值固定为 mcp_oauth。
expires_at string | 过期时间
auth.expires_at
访问令牌的过期时间，采用 RFC 3339 格式。Session 使用该凭据且访问令牌进入 5 分钟刷新窗口时，服务端尝试自动刷新。
refresh object | 访问令牌刷新
auth.refresh
服务端返回用于刷新访问令牌的字段，不返回刷新令牌或客户端密钥。
client_id string | 客户端 ID
auth.refresh.client_id
向 OAuth 令牌端点请求访问令牌时使用的客户端 ID。
resource string | 资源标识
auth.refresh.resource
OAuth 授权请求对应的资源标识。
scope string | 授权范围
auth.refresh.scope
OAuth 令牌允许访问的权限范围。
token_endpoint string | OAuth 令牌端点
auth.refresh.token_endpoint
用于刷新访问令牌的 OAuth 端点地址。
token_endpoint_auth object | OAuth 客户端鉴权
auth.refresh.token_endpoint_auth
服务端向 OAuth 令牌端点提交刷新请求时使用的客户端鉴权配置。
type string | 鉴权方式
auth.refresh.token_endpoint_auth.type
服务端向 OAuth 令牌端点提交刷新请求时使用的客户端鉴权方式：
- none：仅提交 client_id，不使用客户端密钥。
- client_secret_basic：通过 HTTP Basic Authentication 提交客户端信息。
- client_secret_post：在请求体中提交客户端信息。
静态 Bearer 令牌凭证 object
服务端返回静态 Bearer 令牌凭证的公开配置，不返回令牌。
mcp_server_url string | MCP 服务器 URL
auth.mcp_server_url
MCP 服务的访问地址。
type string | 鉴权类型
auth.type
表示该凭证使用静态 Bearer 令牌连接 MCP 服务。
取值固定为 static_bearer。
MCP 静态凭证 object
服务端返回 MCP 静态凭证的公开注入配置，不返回密钥值。
injection_type string | 注入方式
auth.injection_type
服务端返回的密钥注入方式：
- bearer：通过 Authorization: Bearer <token> 请求头注入。
- header：通过 injection_name 指定的自定义请求头注入。
- query：通过 injection_name 指定的 URL 查询参数注入。
mcp_server_url string | MCP 服务器 URL
auth.mcp_server_url
MCP 服务的访问地址。
type string | 鉴权类型
auth.type
表示该凭证会将静态密钥注入 MCP 请求，注入位置由 injection_type 指定。
取值固定为 mcp_static。
injection_name string | 注入名
auth.injection_name
自定义请求头名称或查询参数名。injection_type 为 header 或 query 时返回该字段；injection_type 为 bearer 时不返回。
环境变量注入凭证 object
服务端返回环境变量凭证的公开注入配置，不返回环境变量值。
networking object | 网络范围
auth.networking
凭证可注入的目标主机范围。
type string | 网络范围类型
auth.networking.type
凭证的目标主机范围：
- unrestricted：可以注入发往任意公网主机的请求。
- limited：仅可以注入发往 allowed_hosts 所列主机的请求。
allowed_hosts string[] | 允许主机列表
auth.networking.allowed_hosts
type 为 limited 时返回允许注入凭证的公网主机列表，每项为纯域名、通配域名或公网 IPv4 地址。type 为 unrestricted 时不返回。
secret_name string | 环境变量名
auth.secret_name
向运行环境注入凭证时使用的环境变量名。
type string | 鉴权类型
auth.type
表示该凭证通过环境变量向运行环境注入凭证。
取值固定为 environment_variable。
环境 OAuth 凭证 object
服务端返回环境 OAuth 凭证的鉴权类型、环境变量名和网络范围。配置自动刷新时，还返回访问令牌过期时间和用于刷新访问令牌的字段。
响应不返回访问令牌、刷新令牌或客户端密钥。
networking object | 网络范围
auth.networking
访问令牌可注入的目标主机范围。
type string | 网络范围类型
auth.networking.type
凭证的目标主机范围：
- unrestricted：可以注入发往任意公网主机的请求。
- limited：仅可以注入发往 allowed_hosts 所列主机的请求。
allowed_hosts string[] | 允许主机列表
auth.networking.allowed_hosts
type 为 limited 时返回允许注入凭证的公网主机列表，每项为纯域名、通配域名或公网 IPv4 地址。type 为 unrestricted 时不返回。
secret_name string | 环境变量名
auth.secret_name
向运行环境注入访问令牌时使用的环境变量名。
type string | 鉴权类型
auth.type
表示该凭证使用 OAuth 访问令牌，并通过环境变量向运行环境注入该令牌。
取值固定为 env_oauth。
expires_at string | 过期时间
auth.expires_at
访问令牌的过期时间，采用 RFC 3339 格式。Session 使用该凭据且访问令牌进入 5 分钟刷新窗口时，服务端尝试自动刷新。
refresh object | 访问令牌刷新
auth.refresh
服务端返回用于刷新访问令牌的字段，不返回刷新令牌或客户端密钥。
client_id string | 客户端 ID
auth.refresh.client_id
向 OAuth 令牌端点请求访问令牌时使用的客户端 ID。
resource string | 资源标识
auth.refresh.resource
OAuth 授权请求对应的资源标识。
scope string | 授权范围
auth.refresh.scope
OAuth 令牌允许访问的权限范围。
token_endpoint string | OAuth 令牌端点
auth.refresh.token_endpoint
用于刷新访问令牌的 OAuth 端点地址。
token_endpoint_auth object | OAuth 客户端鉴权
auth.refresh.token_endpoint_auth
服务端向 OAuth 令牌端点提交刷新请求时使用的客户端鉴权配置。
type string | 鉴权方式
auth.refresh.token_endpoint_auth.type
服务端向 OAuth 令牌端点提交刷新请求时使用的客户端鉴权方式：
- none：仅提交 client_id，不使用客户端密钥。
- client_secret_basic：通过 HTTP Basic Authentication 提交客户端信息。
- client_secret_post：在请求体中提交客户端信息。
created_at string | 创建时间
凭证的创建时间，采用 RFC 3339 格式。
id string | 凭证 ID
凭证 ID，以 vcrd- 开头。
type string | 对象类型
表示当前对象是一条保管库凭证。
取值固定为 vault_credential。
updated_at string | 更新时间
凭证最后一次更新的时间，采用 RFC 3339 格式。
vault_id string | 保管库 ID
凭证所属的保管库 ID，以 vlt- 开头。
display_name string | 凭证展示名
凭证的展示名称，用于识别该凭证。
metadata object | 自定义元数据
为凭证设置的字符串键值对，可用于分类或关联业务信息。
更新凭证
发起调试等同于请求真实调用，可能产生云产品费用，请谨慎操作！
Request
cURL
curl -sS --fail-with-body "https://ark.cn-beijing.volces.com/api/v3/vaults/<VAULT_ID>/credentials/<CRED_ID>" \
-H "Authorization: Bearer $ARK_API_KEY" \
-H "Content-Type: application/json" \
-d @- <<'EOF'
{
"display_name": "GitHub 只读 MCP (rotated)",
"auth": {
"type": "static_bearer",
"token": "<NEW_STATIC_BEARER_TOKEN>"
},
"metadata": {
"rotated_at": "2026-07-15T10:00:00Z"
}
}
EOFResponse
{
"id": "vcrd-example",
"type": "vault_credential",
"vault_id": "vlt-example",
"display_name": "GitHub 只读 MCP (rotated)",
"auth": {
"type": "static_bearer",
"mcp_server_url": "<MCP_SERVER_URL>"
},
"metadata": {
"team": "agent-infra",
"rotated_at": "2026-07-15T10:00:00Z"
},
"created_at": "2026-07-15T08:00:00Z",
"updated_at": "2026-07-15T10:00:00Z"
}最近更新时间：2026.10.14 20:02:13
这个页面对您有帮助吗？
有用
有用
无用
无用