Claude Platform Docs

Учётные данные

Create a Credential
$ ant beta:vaults:credentials create
POST/v1/vaults/{vault_id}/credentials
Список учётных данных
$ ant beta:vaults:credentials list
GET/v1/vaults/{vault_id}/credentials
Retrieve a Credential
$ ant beta:vaults:credentials retrieve
GET/v1/vaults/{vault_id}/credentials/{credential_id}
Update a Credential
$ ant beta:vaults:credentials update
POST/v1/vaults/{vault_id}/credentials/{credential_id}
Delete a Credential
$ ant beta:vaults:credentials delete
DELETE/v1/vaults/{vault_id}/credentials/{credential_id}
Archive a Credential
$ ant beta:vaults:credentials archive
POST/v1/vaults/{vault_id}/credentials/{credential_id}/archive
Validate an MCP OAuth Credential
$ ant beta:vaults:credentials mcp-oauth-validate
POST/v1/vaults/{vault_id}/credentials/{credential_id}/mcp_oauth_validate
Models
beta_managed_agents_credential: object{ type: "vault_credential", id, archived_at, 6 more }

A credential stored in a vault. Sensitive fields are never returned in responses.

beta_managed_agents_unrestricted_credential_networking_params: object{ type: "unrestricted" }

Substitute the secret on any host the session's Environment network policy permits egress to. The Environment's network policy is the only boundary on where the secret can reach.

type: "unrestricted"
beta_managed_agents_limited_credential_networking_params: object{ type: "limited", allowed_hosts }

Substitute the secret only on requests to the listed hosts.

type: "limited"
allowed_hosts: array of string

The destination hosts of the outbound requests that the credential's secret is substituted into.

Each entry is a bare hostname (api.example.com), an IPv4 address (192.0.2.1), or a *. wildcard (*.example.com). URLs, ports, paths, and IPv6 addresses aren't accepted. The list can have up to 16 entries.

beta_managed_agents_credential_validation: object{ type: "vault_credential_validation", credential_id, has_refresh_token, 5 more }

Result of live-probing a credential against its configured MCP server.

beta_managed_agents_credential_validation_status: "valid" or "invalid" or "unknown"

Overall verdict of a credential validation probe.

"valid"

The credential successfully authenticated against its MCP server.

"invalid"

The probe reached the MCP server and the server rejected the credential, or no access token is stored. A refresh, if one was tried, didn't recover it. Usually the end user needs to authorize again.

"unknown"

The probe couldn't tell whether the credential works, for example because of a network error or because a refresh succeeded but the new access token wasn't tested. Validate the credential again to find out.

beta_managed_agents_deleted_credential: object{ type: "vault_credential_deleted", id }

Confirmation of a deleted credential.

type: "vault_credential_deleted"
id: string

The unique ID of the deleted credential (vcrd_...).

beta_managed_agents_environment_variable_auth_response: object{ type: "environment_variable", injection_location, networking, secret_name }

Environment variable credential details. The secret value is never returned.

beta_managed_agents_environment_variable_create_params: object{ type: "environment_variable", networking, secret_name, 2 more }

Parameters for creating an environment variable credential.

beta_managed_agents_environment_variable_update_params: object{ type: "environment_variable", injection_location, networking, secret_value }

Parameters for updating an environment variable credential. secret_name is immutable.

beta_managed_agents_injection_location_params: object{ body, header }

Where in the outbound request the secret value may be substituted.

body: optional boolean

Substitute when the placeholder appears in the request body.

header: optional boolean

Substitute when the placeholder appears in a request header value.

beta_managed_agents_injection_location_response: object{ body, header }

Where in the outbound request the secret value is substituted.

body: boolean

Whether the placeholder is substituted in the request body.

header: boolean

Whether the placeholder is substituted in request header values.

beta_managed_agents_injection_location_update_params: object{ body, header }

Changes which parts of an outbound request the secret is substituted into. A location you leave out keeps its current setting.

After the change, at least one location must be enabled.

See Authenticate with vaults to learn more about injection locations.

body: optional boolean

Substitute when the placeholder appears in the request body.

header: optional boolean

Substitute when the placeholder appears in a request header value.

beta_managed_agents_limited_credential_networking_params: object{ type: "limited", allowed_hosts }

Substitute the secret only on requests to the listed hosts.

type: "limited"
allowed_hosts: array of string

The destination hosts of the outbound requests that the credential's secret is substituted into.

Each entry is a bare hostname (api.example.com), an IPv4 address (192.0.2.1), or a *. wildcard (*.example.com). URLs, ports, paths, and IPv6 addresses aren't accepted. The list can have up to 16 entries.

beta_managed_agents_limited_credential_networking_response: object{ type: "limited", allowed_hosts }

The secret is substituted only on requests to the listed hosts.

type: "limited"
allowed_hosts: array of string

The destination hosts of the outbound requests that the credential's secret is substituted into.

An entry matches the request host exactly. An entry such as *.example.com matches any subdomain of example.com but not example.com itself.

beta_managed_agents_mcp_oauth_auth_response: object{ type: "mcp_oauth", mcp_server_url, expires_at, refresh }

OAuth credential details for an MCP server.

beta_managed_agents_mcp_oauth_create_params: object{ type: "mcp_oauth", access_token, mcp_server_url, 2 more }

Parameters for creating an MCP OAuth credential.

beta_managed_agents_mcp_oauth_refresh_params: object{ client_id, refresh_token, token_endpoint, 3 more }

OAuth refresh token parameters for creating a credential with refresh support.

beta_managed_agents_mcp_oauth_refresh_response: object{ client_id, token_endpoint, token_endpoint_auth, 2 more }

OAuth refresh token configuration returned in credential responses.

beta_managed_agents_mcp_oauth_refresh_update_params: object{ refresh_token, scope, token_endpoint_auth }

Parameters for updating OAuth refresh token configuration.

beta_managed_agents_mcp_oauth_update_params: object{ type: "mcp_oauth", access_token, expires_at, refresh }

Parameters for updating an MCP OAuth credential. The mcp_server_url is immutable.

beta_managed_agents_mcp_probe: object{ http_response, method }

The failing step of an MCP validation probe.

http_response: object{ body, body_truncated, content_type, status_code }

The HTTP error response from the MCP server, or null if the MCP server didn't return one for the failing step, for example after a timeout or a DNS or TLS failure.

body: string

Response body. May be truncated and has sensitive values scrubbed.

body_truncated: boolean

Whether body was truncated.

content_type: string

Value of the Content-Type response header.

status_code: number

HTTP status code.

formatint32
method: string

The MCP method that failed (for example initialize or tools/list).

beta_managed_agents_refresh_http_response: object{ body, body_truncated, content_type, status_code }

An HTTP response captured during a credential validation probe.

body: string

Response body. May be truncated and has sensitive values scrubbed.

body_truncated: boolean

Whether body was truncated.

content_type: string

Value of the Content-Type response header.

status_code: number

HTTP status code.

formatint32
beta_managed_agents_refresh_object: object{ http_response, status }

Outcome of a refresh-token exchange attempted during credential validation.

http_response: object{ body, body_truncated, content_type, status_code }

The captured HTTP error response from the token endpoint. Populated only when status is failed.

body: string

Response body. May be truncated and has sensitive values scrubbed.

body_truncated: boolean

Whether body was truncated.

content_type: string

Value of the Content-Type response header.

status_code: number

HTTP status code.

formatint32
status: "succeeded" or "failed" or "connect_error" or "no_refresh_token"

Outcome of the refresh attempt.

One of the following:
"succeeded"

The token endpoint returned a new access token.

"failed"

The token endpoint returned an error response. See http_response for detail.

"connect_error"

The token endpoint could not be reached (DNS, TLS, or connection error).

"no_refresh_token"

No refresh token is stored for the credential, so no exchange was attempted.

beta_managed_agents_static_bearer_auth_response: object{ type: "static_bearer", mcp_server_url }

Static bearer token credential details for an MCP server.

type: "static_bearer"
mcp_server_url: string

URL of the MCP server this credential authenticates against.

beta_managed_agents_static_bearer_create_params: object{ type: "static_bearer", token, mcp_server_url }

Parameters for creating a static bearer token credential.

type: "static_bearer"
token: string

The static bearer token to send to the MCP server, such as an API key or personal access token.

minLength1
maxLength8192
mcp_server_url: string

URL of the MCP server this credential authenticates against.

minLength1
maxLength2047
beta_managed_agents_static_bearer_update_params: object{ type: "static_bearer", token }

Parameters for updating a static bearer token credential. The mcp_server_url is immutable.

type: "static_bearer"
token: optional string

The new static bearer token to replace the stored one.

minLength1
maxLength8192
beta_managed_agents_token_endpoint_auth_basic_param: object{ type: "client_secret_basic", client_secret }

Token endpoint uses HTTP Basic authentication with client credentials.

type: "client_secret_basic"
client_secret: string

The OAuth client secret, sent to token_endpoint with HTTP Basic authentication.

minLength1
maxLength512
beta_managed_agents_token_endpoint_auth_basic_response: object{ type: "client_secret_basic" }

Token endpoint uses HTTP Basic authentication with client credentials.

type: "client_secret_basic"
beta_managed_agents_token_endpoint_auth_basic_update_param: object{ type: "client_secret_basic", client_secret }

Updated HTTP Basic authentication parameters for the token endpoint.

type: "client_secret_basic"
client_secret: optional string

A new OAuth client secret to replace the stored one.

The credential must already use client_secret_basic or client_secret_post. It keeps its current token_endpoint_auth type, even if the type sent with this secret is the other one.

minLength1
maxLength512
beta_managed_agents_token_endpoint_auth_none_param: object{ type: "none" }

Token endpoint requires no client authentication.

type: "none"
beta_managed_agents_token_endpoint_auth_none_response: object{ type: "none" }

Token endpoint requires no client authentication.

type: "none"
beta_managed_agents_token_endpoint_auth_post_param: object{ type: "client_secret_post", client_secret }

Token endpoint uses POST body authentication with client credentials.

type: "client_secret_post"
client_secret: string

The OAuth client secret, sent to token_endpoint in the POST body.

minLength1
maxLength512
beta_managed_agents_token_endpoint_auth_post_response: object{ type: "client_secret_post" }

Token endpoint uses POST body authentication with client credentials.

type: "client_secret_post"
beta_managed_agents_token_endpoint_auth_post_update_param: object{ type: "client_secret_post", client_secret }

Updated POST body authentication parameters for the token endpoint.

type: "client_secret_post"
client_secret: optional string

A new OAuth client secret to replace the stored one.

The credential must already use client_secret_basic or client_secret_post. It keeps its current token_endpoint_auth type, even if the type sent with this secret is the other one.

minLength1
maxLength512
beta_managed_agents_unrestricted_credential_networking_params: object{ type: "unrestricted" }

Substitute the secret on any host the session's Environment network policy permits egress to. The Environment's network policy is the only boundary on where the secret can reach.

type: "unrestricted"
beta_managed_agents_unrestricted_credential_networking_response: object{ type: "unrestricted" }

The secret is substituted on any host the session's Environment network policy permits egress to.

type: "unrestricted"