Claude Platform Docs

Credentials

Create Credential
BetaManagedAgentsCredential Beta.Vaults.Credentials.Create(parameters, cancellationToken = default)
POST/v1/vaults/{vault_id}/credentials
List Credentials
CredentialListPage Beta.Vaults.Credentials.List(parameters, cancellationToken = default)
GET/v1/vaults/{vault_id}/credentials
Get Credential
BetaManagedAgentsCredential Beta.Vaults.Credentials.Retrieve(parameters, cancellationToken = default)
GET/v1/vaults/{vault_id}/credentials/{credential_id}
Update Credential
BetaManagedAgentsCredential Beta.Vaults.Credentials.Update(parameters, cancellationToken = default)
POST/v1/vaults/{vault_id}/credentials/{credential_id}
Delete Credential
BetaManagedAgentsDeletedCredential Beta.Vaults.Credentials.Delete(parameters, cancellationToken = default)
DELETE/v1/vaults/{vault_id}/credentials/{credential_id}
Archive Credential
BetaManagedAgentsCredential Beta.Vaults.Credentials.Archive(parameters, cancellationToken = default)
POST/v1/vaults/{vault_id}/credentials/{credential_id}/archive
Validate Credential
BetaManagedAgentsCredentialValidation Beta.Vaults.Credentials.McpOAuthValidate(parameters, cancellationToken = default)
POST/v1/vaults/{vault_id}/credentials/{credential_id}/mcp_oauth_validate
Models
class BetaManagedAgentsCredential { Type; ID; ArchivedAt; /* 6 more */ }

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

class BetaManagedAgentsCredentialNetworkingParams: union
class BetaManagedAgentsUnrestrictedCredentialNetworkingParams { 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.

required Type Type
class BetaManagedAgentsLimitedCredentialNetworkingParams { Type; AllowedHosts; }

Substitute the secret only on requests to the listed hosts.

required Type Type
required IReadOnlyList<string> AllowedHosts

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.

class BetaManagedAgentsCredentialValidation { Type; CredentialID; HasRefreshToken; /* 5 more */ }

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

enum BetaManagedAgentsCredentialValidationStatus

Overall verdict of a credential validation probe.

Valid("valid")
Invalid("invalid")
Unknown("unknown")
class BetaManagedAgentsDeletedCredential { Type; ID; }

Confirmation of a deleted credential.

required Type Type
required string ID

Unique identifier of the deleted credential.

class BetaManagedAgentsEnvironmentVariableAuthResponse { Type; InjectionLocation; Networking; SecretName; }

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

class BetaManagedAgentsEnvironmentVariableCreateParams { Type; Networking; SecretName; /* 2 more */ }

Parameters for creating an environment variable credential.

class BetaManagedAgentsEnvironmentVariableUpdateParams { Type; InjectionLocation; Networking; SecretValue; }

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

class BetaManagedAgentsInjectionLocationParams { Body; Header; }

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

bool Body

Substitute when the placeholder appears in the request body.

bool Header

Substitute when the placeholder appears in a request header value.

class BetaManagedAgentsInjectionLocationResponse { Body; Header; }

Where in the outbound request the secret value is substituted.

required bool Body

Whether the placeholder is substituted in the request body.

required bool Header

Whether the placeholder is substituted in request header values.

class BetaManagedAgentsInjectionLocationUpdateParams { Body; Header; }

Updated injection location.

bool Body

Substitute when the placeholder appears in the request body.

bool Header

Substitute when the placeholder appears in a request header value.

class BetaManagedAgentsLimitedCredentialNetworkingParams { Type; AllowedHosts; }

Substitute the secret only on requests to the listed hosts.

required Type Type
required IReadOnlyList<string> AllowedHosts

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.

class BetaManagedAgentsLimitedCredentialNetworkingResponse { Type; AllowedHosts; }

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

required Type Type
required IReadOnlyList<string> AllowedHosts

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.

class BetaManagedAgentsMcpOAuthAuthResponse { Type; McpServerUrl; ExpiresAt; Refresh; }

OAuth credential details for an MCP server.

required Type Type
required string McpServerUrl

URL of the MCP server this credential authenticates against.

DateTimeOffset? ExpiresAt

A timestamp in RFC 3339 format

formatdate-time
BetaManagedAgentsMcpOAuthRefreshResponse? Refresh

OAuth refresh token configuration returned in credential responses.

class BetaManagedAgentsMcpOAuthCreateParams { Type; AccessToken; McpServerUrl; /* 2 more */ }

Parameters for creating an MCP OAuth credential.

required Type Type
required string AccessToken

OAuth access token.

minLength1
maxLength8192
required string McpServerUrl

URL of the MCP server this credential authenticates against.

minLength1
maxLength2047
DateTimeOffset? ExpiresAt

A timestamp in RFC 3339 format

formatdate-time
BetaManagedAgentsMcpOAuthRefreshParams? Refresh

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

class BetaManagedAgentsMcpOAuthRefreshParams { ClientID; RefreshToken; TokenEndpoint; /* 3 more */ }

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

class BetaManagedAgentsMcpOAuthRefreshResponse { ClientID; TokenEndpoint; TokenEndpointAuth; /* 2 more */ }

OAuth refresh token configuration returned in credential responses.

class BetaManagedAgentsMcpOAuthRefreshUpdateParams { RefreshToken; Scope; TokenEndpointAuth; }

Parameters for updating OAuth refresh token configuration.

string? RefreshToken

Updated OAuth refresh token.

minLength1
maxLength8192
string? Scope

Updated OAuth scope for the refresh request.

maxLength8192
TokenEndpointAuth TokenEndpointAuth
One of the following:
class BetaManagedAgentsTokenEndpointAuthBasicUpdateParam { Type; ClientSecret; }

Updated HTTP Basic authentication parameters for the token endpoint.

required Type Type
string? ClientSecret

Updated OAuth client secret.

minLength1
maxLength512
class BetaManagedAgentsTokenEndpointAuthPostUpdateParam { Type; ClientSecret; }

Updated POST body authentication parameters for the token endpoint.

required Type Type
string? ClientSecret

Updated OAuth client secret.

minLength1
maxLength512
class BetaManagedAgentsMcpOAuthUpdateParams { Type; AccessToken; ExpiresAt; Refresh; }

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

class BetaManagedAgentsMcpProbe { HttpResponse; Method; }

The failing step of an MCP validation probe.

required BetaManagedAgentsRefreshHttpResponse? HttpResponse

An HTTP response captured during a credential validation probe.

required string Body

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

required bool BodyTruncated

Whether body was truncated.

required string ContentType

Value of the Content-Type response header.

required int StatusCode

HTTP status code.

formatint32
required string Method

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

class BetaManagedAgentsRefreshHttpResponse { Body; BodyTruncated; ContentType; StatusCode; }

An HTTP response captured during a credential validation probe.

required string Body

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

required bool BodyTruncated

Whether body was truncated.

required string ContentType

Value of the Content-Type response header.

required int StatusCode

HTTP status code.

formatint32
class BetaManagedAgentsRefreshObject { HttpResponse; Status; }

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

required BetaManagedAgentsRefreshHttpResponse? HttpResponse

An HTTP response captured during a credential validation probe.

required string Body

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

required bool BodyTruncated

Whether body was truncated.

required string ContentType

Value of the Content-Type response header.

required int StatusCode

HTTP status code.

formatint32
required Status Status

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

One of the following:
Succeeded("succeeded")
Failed("failed")
ConnectError("connect_error")
NoRefreshToken("no_refresh_token")
class BetaManagedAgentsStaticBearerAuthResponse { Type; McpServerUrl; }

Static bearer token credential details for an MCP server.

required Type Type
required string McpServerUrl

URL of the MCP server this credential authenticates against.

class BetaManagedAgentsStaticBearerCreateParams { Type; Token; McpServerUrl; }

Parameters for creating a static bearer token credential.

required Type Type
required string Token

Static bearer token value.

minLength1
maxLength8192
required string McpServerUrl

URL of the MCP server this credential authenticates against.

minLength1
maxLength2047
class BetaManagedAgentsStaticBearerUpdateParams { Type; Token; }

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

required Type Type
string? Token

Updated static bearer token value.

minLength1
maxLength8192
class BetaManagedAgentsTokenEndpointAuthBasicParam { Type; ClientSecret; }

Token endpoint uses HTTP Basic authentication with client credentials.

required Type Type
required string ClientSecret

OAuth client secret.

minLength1
maxLength512
class BetaManagedAgentsTokenEndpointAuthBasicResponse { Type; }

Token endpoint uses HTTP Basic authentication with client credentials.

required Type Type
class BetaManagedAgentsTokenEndpointAuthBasicUpdateParam { Type; ClientSecret; }

Updated HTTP Basic authentication parameters for the token endpoint.

required Type Type
string? ClientSecret

Updated OAuth client secret.

minLength1
maxLength512
class BetaManagedAgentsTokenEndpointAuthNoneParam { Type; }

Token endpoint requires no client authentication.

required Type Type
class BetaManagedAgentsTokenEndpointAuthNoneResponse { Type; }

Token endpoint requires no client authentication.

required Type Type
class BetaManagedAgentsTokenEndpointAuthPostParam { Type; ClientSecret; }

Token endpoint uses POST body authentication with client credentials.

required Type Type
required string ClientSecret

OAuth client secret.

minLength1
maxLength512
class BetaManagedAgentsTokenEndpointAuthPostResponse { Type; }

Token endpoint uses POST body authentication with client credentials.

required Type Type
class BetaManagedAgentsTokenEndpointAuthPostUpdateParam { Type; ClientSecret; }

Updated POST body authentication parameters for the token endpoint.

required Type Type
string? ClientSecret

Updated OAuth client secret.

minLength1
maxLength512
class BetaManagedAgentsUnrestrictedCredentialNetworkingParams { 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.

required Type Type
class BetaManagedAgentsUnrestrictedCredentialNetworkingResponse { Type; }

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

required Type Type