OpenAI 列出凭证库凭证
get /vaults/{vault_id}/credentials
使用基于 ID 的分页列出凭证库内的凭证,响应省略机密值。参见凭证库指南。
路径参数
vault_id: string
凭证库 ID。
minLength: 0, maxLength: 1048576
查询参数
after: optional string
按选定顺序返回此资源 ID 之后的资源。
minLength: 0, maxLength: 1048576
limit: optional integer (default: 20)
返回资源的最大数量,范围为 1 至 100,默认为 20。
format: int64, minimum: 1, maximum: 100
metadata: optional map[string]
使用 metadata[key]=value 提供精确匹配的字符串条件。所有键值对都必须匹配。最多 16 对,键长为 1 至 64 个字符,值最长为 512 个字符。筛选结果采用最终一致性,元数据变更可能延迟显示。
order: optional "asc" or "desc" (default: "desc")
返回资源的排序方式,默认为 desc。
"asc"
按升序返回资源。
"desc"
按降序返回资源。
status: optional VaultStatusFilter
按单个状态或状态列表筛选,例如 status=active 或 status[]=active&status[]=archived。默认包含两种状态。
VaultStatus = "active" or "archived"
凭证库或凭证当前为活动或已归档状态。
"active"
"archived"
array of VaultStatus
minItems: 0, maxItems: 16384
"active"
"archived"
返回值
data: array of Credential
本页返回的资源,按指定顺序排列。
minItems: 0, maxItems: 2000
id: string
凭证 ID。
minLength: 0
auth: CredentialAuth
凭证的身份验证方式和非机密配置。
McpOauth object { expires_at, mcp_server_url, refresh, type }
OAuth 凭证的非机密元数据。响应始终省略令牌和客户端密钥。
expires_at: string or null
OAuth 访问令牌的过期时间,格式为 RFC 3339 时间戳(如已知)。
minLength: 0
mcp_server_url: string
此凭证授权访问的 HTTPS MCP 服务器 URL。
minLength: 0
refresh: object { client_id, resource, scope, 2 more } or null
可返回的非机密刷新元数据,省略刷新令牌和 OAuth 客户端密钥。
client_id: string
获取新访问令牌时使用的 OAuth 客户端 ID。
minLength: 0
resource: string or null
刷新时发送给 OAuth 令牌端点的资源 URI(如已配置)。
minLength: 0
scope: string or null
刷新时请求的 OAuth 权限范围,以空格分隔(如已配置)。
minLength: 0
token_endpoint: string
用于刷新的 HTTPS OAuth 令牌端点。
minLength: 0
token_endpoint_auth: McpOauthTokenEndpointAuth
OAuth 客户端向令牌端点进行身份验证的方式。响应省略客户端密钥。
None object { type }
发送客户端 ID,省略客户端密钥。
type: "none" (default: "none")
对象类型,固定为 none。
"none"
ClientSecretBasic object { type }
使用 HTTP Basic 身份验证发送客户端 ID 和密钥。
type: "client_secret_basic" (default: "client_secret_basic")
对象类型,固定为 client_secret_basic。
"client_secret_basic"
ClientSecretPost object { type }
在令牌请求体中发送客户端 ID 和密钥。
type: "client_secret_post" (default: "client_secret_post")
对象类型,固定为 client_secret_post。
"client_secret_post"
type: "mcp_oauth" (default: "mcp_oauth")
对象类型,固定为 mcp_oauth。
"mcp_oauth"
StaticBearer object { mcp_server_url, type }
Bearer 令牌凭证的元数据。此类凭证不支持 OAuth 自动刷新。
mcp_server_url: string
此凭证授权访问的 HTTPS MCP 服务器 URL。
minLength: 0
type: "static_bearer" (default: "static_bearer")
对象类型,固定为 static_bearer。
"static_bearer"
EnvironmentVariable object { networking, secret_name, type }
仅用于 OpenAI 托管环境的 HTTP 凭证元数据。沙箱代码收到的是占位符。代理只对获准且使用 443 或 8443 端口的 HTTPS 目标将占位符替换为密钥。沙箱代码无法使用真实密钥进行本地计算,此资源的响应也始终省略真实密钥。
networking: CredentialNetworking
代理可将占位符替换为密钥的目标,受环境网络策略约束。
Unrestricted object { type }
允许为环境网络策略许可的目标替换占位符。要求 environment.network.access 为 restricted,并明确设置 allowed_domains。
type: "unrestricted" (default: "unrestricted")
对象类型,固定为 unrestricted。
"unrestricted"
Limited object { allowed_hosts, type }
仅允许为列出的主机替换占位符。环境网络策略也必须允许访问这些主机。
allowed_hosts: array of string
允许访问的 1 至 16 个不重复主机名或 IPv4 地址,统一转换为小写。条目不得包含协议、路径、端口或通配符。当前不支持 IPv6 地址。
minItems: 1, maxItems: 16
type: "limited" (default: "limited")
对象类型,固定为 limited。
"limited"
secret_name: string
沙箱内用于接收占位符的环境变量名。
minLength: 0
type: "environment_variable" (default: "environment_variable")
对象类型,固定为 environment_variable。
"environment_variable"
created_at: integer
凭证创建时的 Unix 时间戳,单位为秒。
format: int64
metadata: map[string]
应用定义的键值对,与此凭证关联。
name: string
凭证的可读名称。
minLength: 0
object: "vault.credential" (default: "vault.credential")
对象类型,固定为 vault.credential。
"vault.credential"
updated_at: integer
凭证上次更新时的 Unix 时间戳,单位为秒。
format: int64
vault_id: string
此凭证所属凭证库的 ID。
minLength: 0
first_id: string or null
data 中第一项的资源 ID。当前页为空时为 null。
minLength: 0
has_more: boolean
当前页之后是否还有可获取的资源。
last_id: string or null
data 中最后一项的资源 ID。当前页为空时为 null。翻页时,将它作为 after 传入,并保持排序和筛选条件一致。
minLength: 0
object: "list" (default: "list")
对象类型,恒为 list。
"list"
示例
## 从环境变量读取 API 密钥。
## 将 VAULT_ID 设置为目标凭证库的 ID。
curl https://api.openai.com/v1/vaults/$VAULT_ID/credentials \
-H 'OpenAI-Beta: agents=v1' \
-H "Authorization: Bearer $OPENAI_API_KEY"
200 响应示例
字段名、类型值和示例标识均按接口定义保留。
{
"data": [
{
"id": "id",
"auth": {
"expires_at": "expires_at",
"mcp_server_url": "mcp_server_url",
"refresh": {
"client_id": "client_id",
"resource": "resource",
"scope": "scope",
"token_endpoint": "token_endpoint",
"token_endpoint_auth": {
"type": "none"
}
},
"type": "mcp_oauth"
},
"created_at": 0,
"metadata": {
"foo": "string"
},
"name": "name",
"object": "vault.credential",
"updated_at": 0,
"vault_id": "vault_id"
}
],
"first_id": "first_id",
"has_more": true,
"last_id": "last_id",
"object": "list"
}
取得凭证 ID 后,可获取凭证库凭证的元数据。

TRAE-AI编程


更多建议: