Skip to main content
Credential

创建 Credential

在指定 Vault 中创建一个 Credential。auth 为多态结构,支持 environment_variable、static_bearer、mcp_oauth 三种类型。secret_value 等敏感值仅写入时传入,响应中不返回。

前提

已完成 Endpoint 与鉴权配置,详见API 总览与认证

接口

POST /credentials

请求体

字段必填类型说明
vault_idstring所属 Vault ID,格式 vlt_xxx
authobject认证信息,多态结构,通过 type 区分。
display_namestringCredential 可读名称,最大 255 字符
metadataobject业务自定义键值对元数据

auth 类型

auth 字段支持三种类型,通过 type 区分。

environment_variable

以环境变量形式注入会话。
字段必填类型说明
typestring固定为 environment_variable
secret_namestring环境变量名称,创建后不可修改
secret_valuestring环境变量值,仅写入时传入,响应中不返回
networkingobject网络策略,当前仅支持 {"type": "unrestricted"}

static_bearer

静态 Bearer Token,用于访问需要 Token 认证的 MCP Server。
字段必填类型说明
typestring固定为 static_bearer
tokenstringBearer Token 值
mcp_server_urlstringMCP Server 地址

mcp_oauth

MCP OAuth 认证,用于 OAuth 流程授权的 MCP Server。
字段必填类型说明
typestring固定为 mcp_oauth
access_tokenstringOAuth Access Token
mcp_server_urlstringMCP Server 地址
expires_atstringToken 过期时间,ISO 8601
refreshobjectToken 刷新配置

请求示例

curl -X POST "$AGENTSTUDIO_URL/credentials" \
  -H "Authorization: Bearer $DASHSCOPE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "vault_id": "vlt_xxx",
    "display_name": "第三方 API 密钥",
    "auth": {
      "type": "environment_variable",
      "secret_name": "API_KEY",
      "secret_value": "sk-xxxx",
      "networking": {
        "type": "unrestricted"
      }
    }
  }'

响应

{
  "id": "cred_xxx",
  "type": "credential",
  "vault_id": "vlt_xxx",
  "display_name": "第三方 API 密钥",
  "auth": {
    "type": "environment_variable",
    "secret_name": "API_KEY",
    "networking": {
      "type": "unrestricted"
    }
  },
  "metadata": {},
  "archived_at": null,
  "created_at": "2026-07-10T08:00:00Z",
  "updated_at": "2026-07-10T08:00:00Z",
  "request_id": "req_xxx"
}

响应字段

字段类型说明
idstringCredential ID,格式 cred_xxx
typestring固定为 credential
vault_idstring所属 Vault ID
display_namestringCredential 可读名称
authobject认证信息,敏感值已脱敏(如 secret_value、token、access_token 不返回)
auth.typestring认证类型:environment_variable、static_bearer 或 mcp_oauth
auth.secret_namestring环境变量名称(environment_variable 类型)
auth.networkingobject网络策略(environment_variable 类型)
auth.mcp_server_urlstringMCP Server 地址(static_bearer / mcp_oauth 类型)
auth.expires_atstringToken 过期时间,ISO 8601(mcp_oauth 类型)
metadataobject业务自定义键值对
archived_atstring | null归档时间,未归档时为 null
created_atstring创建时间,ISO 8601
updated_atstring最近更新时间,ISO 8601
request_idstring请求唯一标识

错误码

状态码错误码说明
400InvalidParameterRequired parameter missing or invalid.
401InvalidApiKeyInvalid API-key provided.