Claude Platform Docs

Anmeldedaten

Create a Credential
POST/v1/vaults/{vault_id}/credentials
Credentials auflisten
GET/v1/vaults/{vault_id}/credentials
Retrieve a Credential
GET/v1/vaults/{vault_id}/credentials/{credential_id}
Update a Credential
POST/v1/vaults/{vault_id}/credentials/{credential_id}
Delete a Credential
DELETE/v1/vaults/{vault_id}/credentials/{credential_id}
Archive a Credential
POST/v1/vaults/{vault_id}/credentials/{credential_id}/archive
Validate an MCP OAuth Credential
POST/v1/vaults/{vault_id}/credentials/{credential_id}/mcp_oauth_validate
Models
BetaManagedAgentsCredential object{ type: "vault_credential", id, archived_at, 6 more }

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

BetaManagedAgentsCredentialNetworkingParams = BetaManagedAgentsUnrestrictedCredentialNetworkingParams or BetaManagedAgentsLimitedCredentialNetworkingParams
One of the following:
BetaManagedAgentsUnrestrictedCredentialNetworkingParams 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"
BetaManagedAgentsLimitedCredentialNetworkingParams 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.

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

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

BetaManagedAgentsCredentialValidationStatus = "valid" or "invalid" or "unknown"

Overall verdict of a credential validation probe.

One of the following:
"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.

BetaManagedAgentsDeletedCredential 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_...).

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

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

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

Parameters for creating an environment variable credential.

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

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

BetaManagedAgentsInjectionLocationParams 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.

BetaManagedAgentsInjectionLocationResponse 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.

BetaManagedAgentsInjectionLocationUpdateParams 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.

BetaManagedAgentsLimitedCredentialNetworkingParams 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.

BetaManagedAgentsLimitedCredentialNetworkingResponse 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.

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

OAuth credential details for an MCP server.

type: "mcp_oauth"
mcp_server_url: string

URL of the MCP server this credential authenticates against.

expires_at: optional string or null

When the credential's access token expires, in RFC 3339. Absent if the expiry isn't known.

formatdate-time
refresh: optional BetaManagedAgentsMCPOAuthRefreshResponse { client_id, token_endpoint, token_endpoint_auth, 2 more } or null

Refresh token configuration, if the credential supports token refresh.

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

Parameters for creating an MCP OAuth credential.

type: "mcp_oauth"
access_token: string

The OAuth access token to send to the MCP server.

minLength1
maxLength8192
mcp_server_url: string

URL of the MCP server this credential authenticates against.

minLength1
maxLength2047
expires_at: optional string or null

When access_token expires, in RFC 3339.

Must be in the future.

formatdate-time
refresh: optional BetaManagedAgentsMCPOAuthRefreshParams { client_id, refresh_token, token_endpoint, 3 more } or null

Refresh token configuration, if the credential supports token refresh.

BetaManagedAgentsMCPOAuthRefreshParams object{ client_id, refresh_token, token_endpoint, 3 more }

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

BetaManagedAgentsMCPOAuthRefreshResponse object{ client_id, token_endpoint, token_endpoint_auth, 2 more }

OAuth refresh token configuration returned in credential responses.

BetaManagedAgentsMCPOAuthRefreshUpdateParams object{ refresh_token, scope, token_endpoint_auth }

Parameters for updating OAuth refresh token configuration.

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

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

type: "mcp_oauth"
access_token: optional string or null

The new OAuth access token to replace the stored one.

minLength1
maxLength8192
expires_at: optional string or null

When the credential's access token expires, in RFC 3339. Leave it out to keep the stored expiry.

If you send a new access_token, send its expires_at too, or the new token keeps the old expiry.

Must be in the future.

formatdate-time
refresh: optional BetaManagedAgentsMCPOAuthRefreshUpdateParams { refresh_token, scope, token_endpoint_auth } or null

Updated refresh token configuration.

BetaManagedAgentsMCPProbe object{ http_response, method }

The failing step of an MCP validation probe.

http_response: BetaManagedAgentsRefreshHTTPResponse { body, body_truncated, content_type, status_code } or null

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).

BetaManagedAgentsRefreshHTTPResponse 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
BetaManagedAgentsRefreshObject object{ http_response, status }

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

http_response: BetaManagedAgentsRefreshHTTPResponse { body, body_truncated, content_type, status_code } or null

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.

BetaManagedAgentsStaticBearerAuthResponse 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.

BetaManagedAgentsStaticBearerCreateParams 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
BetaManagedAgentsStaticBearerUpdateParams 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 or null

The new static bearer token to replace the stored one.

minLength1
maxLength8192
BetaManagedAgentsTokenEndpointAuthBasicParam 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
BetaManagedAgentsTokenEndpointAuthBasicResponse object{ type: "client_secret_basic" }

Token endpoint uses HTTP Basic authentication with client credentials.

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

Updated HTTP Basic authentication parameters for the token endpoint.

type: "client_secret_basic"
client_secret: optional string or null

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
BetaManagedAgentsTokenEndpointAuthNoneParam object{ type: "none" }

Token endpoint requires no client authentication.

type: "none"
BetaManagedAgentsTokenEndpointAuthNoneResponse object{ type: "none" }

Token endpoint requires no client authentication.

type: "none"
BetaManagedAgentsTokenEndpointAuthPostParam 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
BetaManagedAgentsTokenEndpointAuthPostResponse object{ type: "client_secret_post" }

Token endpoint uses POST body authentication with client credentials.

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

Updated POST body authentication parameters for the token endpoint.

type: "client_secret_post"
client_secret: optional string or null

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
BetaManagedAgentsUnrestrictedCredentialNetworkingParams 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"
BetaManagedAgentsUnrestrictedCredentialNetworkingResponse object{ type: "unrestricted" }

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

type: "unrestricted"