Claude Platform Docs

Credentials

Create Credential
$ ant beta:vaults:credentials create
POST/v1/vaults/{vault_id}/credentials
List Credentials
$ ant beta:vaults:credentials list
GET/v1/vaults/{vault_id}/credentials
Get Credential
$ ant beta:vaults:credentials retrieve
GET/v1/vaults/{vault_id}/credentials/{credential_id}
Update Credential
$ ant beta:vaults:credentials update
POST/v1/vaults/{vault_id}/credentials/{credential_id}
Delete Credential
$ ant beta:vaults:credentials delete
DELETE/v1/vaults/{vault_id}/credentials/{credential_id}
Archive Credential
$ ant beta:vaults:credentials archive
POST/v1/vaults/{vault_id}/credentials/{credential_id}/archive
Validate 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{ id, archived_at, auth, 6 more }

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

beta_managed_agents_credential_networking_params: BetaManagedAgentsUnrestrictedCredentialNetworkingParams { type } or BetaManagedAgentsLimitedCredentialNetworkingParams { allowed_hosts, type }

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.

beta_managed_agents_unrestricted_credential_networking_params: object{ type }

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{ allowed_hosts, type }

Substitute the secret only on requests to the listed hosts.

allowed_hosts: array of string

Hostnames on which the secret will be substituted. Each entry is a bare hostname (api.example.com), an IPv4 address (192.0.2.1), or a *.-prefixed wildcard (*.example.com). URLs, ports, paths, and IPv6 addresses are not accepted. At most 16 entries.

type: "limited"
beta_managed_agents_credential_validation: object{ credential_id, has_refresh_token, mcp_probe, 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"
"invalid"
"unknown"
beta_managed_agents_deleted_credential: object{ id, type }

Confirmation of a deleted credential.

id: string

Unique identifier of the deleted credential.

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

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

beta_managed_agents_environment_variable_create_params: object{ networking, secret_name, secret_value, 2 more }

Parameters for creating an environment variable credential.

beta_managed_agents_environment_variable_update_params: object{ type, 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 }

Updated injection location.

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{ allowed_hosts, type }

Substitute the secret only on requests to the listed hosts.

allowed_hosts: array of string

Hostnames on which the secret will be substituted. Each entry is a bare hostname (api.example.com), an IPv4 address (192.0.2.1), or a *.-prefixed wildcard (*.example.com). URLs, ports, paths, and IPv6 addresses are not accepted. At most 16 entries.

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

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

allowed_hosts: array of string

Hostnames on which the secret will be substituted. An entry matches the request host exactly; a *.-prefixed entry matches any subdomain of the named domain but not the domain itself.

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

OAuth credential details for an MCP server.

beta_managed_agents_mcp_oauth_create_params: object{ access_token, mcp_server_url, type, 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, 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 }

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
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 }

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
status: "succeeded" or "failed" or "connect_error" or "no_refresh_token"

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

One of the following:
"succeeded"
"failed"
"connect_error"
"no_refresh_token"
beta_managed_agents_static_bearer_auth_response: object{ mcp_server_url, type }

Static bearer token credential details for an MCP server.

mcp_server_url: string

URL of the MCP server this credential authenticates against.

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

Parameters for creating a static bearer token credential.

token: string

Static bearer token value.

minLength1
maxLength8192
mcp_server_url: string

URL of the MCP server this credential authenticates against.

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

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

type: "static_bearer"
token: optional string

Updated static bearer token value.

minLength1
maxLength8192
beta_managed_agents_token_endpoint_auth_basic_param: object{ client_secret, type }

Token endpoint uses HTTP Basic authentication with client credentials.

client_secret: string

OAuth client secret.

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

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 }

Updated HTTP Basic authentication parameters for the token endpoint.

type: "client_secret_basic"
client_secret: optional string

Updated OAuth client secret.

minLength1
maxLength512
beta_managed_agents_token_endpoint_auth_none_param: object{ type }

Token endpoint requires no client authentication.

type: "none"
beta_managed_agents_token_endpoint_auth_none_response: object{ type }

Token endpoint requires no client authentication.

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

Token endpoint uses POST body authentication with client credentials.

client_secret: string

OAuth client secret.

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

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 }

Updated POST body authentication parameters for the token endpoint.

type: "client_secret_post"
client_secret: optional string

Updated OAuth client secret.

minLength1
maxLength512
beta_managed_agents_unrestricted_credential_networking_params: object{ type }

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 }

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

type: "unrestricted"