Domain types
Beta Managed Agents Credential
BetaManagedAgentsCredential objectA credential stored in a vault. Sensitive fields are never returned in responses.
type: "vault_credential"id: stringUnique identifier for the credential.
archived_at: string or nullA timestamp in RFC 3339 format
format: date-time
auth: BetaManagedAgentsMCPOAuthAuthResponse or BetaManagedAgentsStaticBearerAuthResponse or BetaManagedAgentsEnvironmentVariableAuthResponseAuthentication details for a credential.
BetaManagedAgentsMCPOAuthAuthResponse objectOAuth credential details for an MCP server.
type: "mcp_oauth"mcp_server_url: stringURL of the MCP server this credential authenticates against.
expires_at: optional string or nullA timestamp in RFC 3339 format
format: date-time
refresh: optional BetaManagedAgentsMCPOAuthRefreshResponse or nullOAuth refresh token configuration returned in credential responses.
client_id: stringOAuth client ID.
token_endpoint: stringToken endpoint URL used to refresh the access token.
token_endpoint_auth: BetaManagedAgentsTokenEndpointAuthNoneResponse or BetaManagedAgentsTokenEndpointAuthBasicResponse or BetaManagedAgentsTokenEndpointAuthPostResponseToken endpoint requires no client authentication.
BetaManagedAgentsTokenEndpointAuthNoneResponse objectToken endpoint requires no client authentication.
type: "none"
BetaManagedAgentsTokenEndpointAuthBasicResponse objectToken endpoint uses HTTP Basic authentication with client credentials.
type: "client_secret_basic"
BetaManagedAgentsTokenEndpointAuthPostResponse objectToken endpoint uses POST body authentication with client credentials.
type: "client_secret_post"
resource: optional string or nullOAuth resource indicator.
scope: optional string or nullOAuth scope for the refresh request.
BetaManagedAgentsStaticBearerAuthResponse objectStatic bearer token credential details for an MCP server.
type: "static_bearer"mcp_server_url: stringURL of the MCP server this credential authenticates against.
BetaManagedAgentsEnvironmentVariableAuthResponse objectEnvironment variable credential details. The secret value is never returned.
type: "environment_variable"injection_location: BetaManagedAgentsInjectionLocationResponseWhere in the outbound request the secret value is substituted.
body: booleanWhether the placeholder is substituted in the request body.
header: booleanWhether the placeholder is substituted in request header values.
networking: BetaManagedAgentsUnrestrictedCredentialNetworkingResponse or BetaManagedAgentsLimitedCredentialNetworkingResponseOutbound hosts the secret value is substituted on.
BetaManagedAgentsUnrestrictedCredentialNetworkingResponse objectThe secret is substituted on any host the session's Environment network policy permits egress to.
type: "unrestricted"
BetaManagedAgentsLimitedCredentialNetworkingResponse objectThe secret is substituted only on requests to the listed hosts.
type: "limited"allowed_hosts: array of stringHostnames 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.
secret_name: stringName of the environment variable.
created_at: stringA timestamp in RFC 3339 format
format: date-time
metadata: map[string]Arbitrary key-value metadata attached to the credential.
updated_at: stringA timestamp in RFC 3339 format
format: date-time
vault_id: stringIdentifier of the vault this credential belongs to.
display_name: optional string or nullHuman-readable name for the credential.
Beta Managed Agents Credential Networking Params
BetaManagedAgentsCredentialNetworkingParams = BetaManagedAgentsUnrestrictedCredentialNetworkingParams or BetaManagedAgentsLimitedCredentialNetworkingParamsSubstitute 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.
BetaManagedAgentsUnrestrictedCredentialNetworkingParams objectSubstitute 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 objectSubstitute the secret only on requests to the listed hosts.
type: "limited"allowed_hosts: array of stringHostnames 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.
Beta Managed Agents Credential Validation
BetaManagedAgentsCredentialValidation objectResult of live-probing a credential against its configured MCP server.
type: "vault_credential_validation"credential_id: stringUnique identifier of the credential that was validated.
has_refresh_token: booleanWhether the credential has a refresh token configured.
mcp_probe: BetaManagedAgentsMCPProbe or nullThe failing step of an MCP validation probe.
http_response: BetaManagedAgentsRefreshHTTPResponse or nullAn HTTP response captured during a credential validation probe.
body: stringResponse body. May be truncated and has sensitive values scrubbed.
body_truncated: booleanWhether
bodywas truncated.content_type: stringValue of the
Content-Typeresponse header.status_code: numberHTTP status code.
format: int32
method: stringThe MCP method that failed (for example
initializeortools/list).
refresh: BetaManagedAgentsRefreshObject or nullOutcome of a refresh-token exchange attempted during credential validation.
http_response: BetaManagedAgentsRefreshHTTPResponse or nullAn HTTP response captured during a credential validation probe.
status: "succeeded" or "failed" or "connect_error" or "no_refresh_token"Outcome of a refresh-token exchange attempted during credential validation.
"succeeded""failed""connect_error""no_refresh_token"
status: BetaManagedAgentsCredentialValidationStatusOverall verdict of a credential validation probe.
"valid""invalid""unknown"
validated_at: stringA timestamp in RFC 3339 format
format: date-time
vault_id: stringIdentifier of the vault containing the credential.
Beta Managed Agents Credential Validation Status
BetaManagedAgentsCredentialValidationStatus = "valid" or "invalid" or "unknown"Overall verdict of a credential validation probe.
"valid""invalid""unknown"
Beta Managed Agents Deleted Credential
BetaManagedAgentsDeletedCredential objectConfirmation of a deleted credential.
type: "vault_credential_deleted"id: stringUnique identifier of the deleted credential.
Beta Managed Agents Environment Variable Auth Response
BetaManagedAgentsEnvironmentVariableAuthResponse objectEnvironment variable credential details. The secret value is never returned.
type: "environment_variable"injection_location: BetaManagedAgentsInjectionLocationResponseWhere in the outbound request the secret value is substituted.
body: booleanWhether the placeholder is substituted in the request body.
header: booleanWhether the placeholder is substituted in request header values.
networking: BetaManagedAgentsUnrestrictedCredentialNetworkingResponse or BetaManagedAgentsLimitedCredentialNetworkingResponseOutbound hosts the secret value is substituted on.
BetaManagedAgentsUnrestrictedCredentialNetworkingResponse objectThe secret is substituted on any host the session's Environment network policy permits egress to.
type: "unrestricted"
BetaManagedAgentsLimitedCredentialNetworkingResponse objectThe secret is substituted only on requests to the listed hosts.
type: "limited"allowed_hosts: array of stringHostnames 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.
secret_name: stringName of the environment variable.
Beta Managed Agents Environment Variable Create Params
BetaManagedAgentsEnvironmentVariableCreateParams objectParameters for creating an environment variable credential.
type: "environment_variable"networking: BetaManagedAgentsCredentialNetworkingParamsOutbound hosts the secret value is substituted on.
BetaManagedAgentsUnrestrictedCredentialNetworkingParams objectSubstitute 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 objectSubstitute the secret only on requests to the listed hosts.
type: "limited"allowed_hosts: array of stringHostnames 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.
secret_name: stringName of the environment variable. Immutable after create.
minLength: 1, maxLength: 255
secret_value: stringSecret value. Write-only; never returned in responses.
minLength: 1, maxLength: 4096
injection_location: optional BetaManagedAgentsInjectionLocationParamsWhere in the outbound request the secret value may be substituted.
body: optional booleanSubstitute when the placeholder appears in the request body.
header: optional booleanSubstitute when the placeholder appears in a request header value.
Beta Managed Agents Environment Variable Update Params
BetaManagedAgentsEnvironmentVariableUpdateParams objectParameters for updating an environment variable credential.
secret_nameis immutable.type: "environment_variable"injection_location: optional BetaManagedAgentsInjectionLocationUpdateParamsUpdated injection location.
body: optional booleanSubstitute when the placeholder appears in the request body.
header: optional booleanSubstitute when the placeholder appears in a request header value.
networking: optional BetaManagedAgentsCredentialNetworkingParams or nullUpdated networking scope. Full replacement.
BetaManagedAgentsUnrestrictedCredentialNetworkingParams objectSubstitute 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 objectSubstitute the secret only on requests to the listed hosts.
type: "limited"allowed_hosts: array of stringHostnames 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.
secret_value: optional string or nullUpdated secret value.
minLength: 1, maxLength: 4096
Beta Managed Agents Injection Location Params
BetaManagedAgentsInjectionLocationParams objectWhere in the outbound request the secret value may be substituted.
body: optional booleanSubstitute when the placeholder appears in the request body.
header: optional booleanSubstitute when the placeholder appears in a request header value.
Beta Managed Agents Injection Location Response
BetaManagedAgentsInjectionLocationResponse objectWhere in the outbound request the secret value is substituted.
body: booleanWhether the placeholder is substituted in the request body.
header: booleanWhether the placeholder is substituted in request header values.
Beta Managed Agents Injection Location Update Params
BetaManagedAgentsInjectionLocationUpdateParams objectUpdated injection location.
body: optional booleanSubstitute when the placeholder appears in the request body.
header: optional booleanSubstitute when the placeholder appears in a request header value.
Beta Managed Agents Limited Credential Networking Params
BetaManagedAgentsLimitedCredentialNetworkingParams objectSubstitute the secret only on requests to the listed hosts.
type: "limited"allowed_hosts: array of stringHostnames 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.
Beta Managed Agents Limited Credential Networking Response
BetaManagedAgentsLimitedCredentialNetworkingResponse objectThe secret is substituted only on requests to the listed hosts.
type: "limited"allowed_hosts: array of stringHostnames 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.
Beta Managed Agents MCP OAuth Auth Response
BetaManagedAgentsMCPOAuthAuthResponse objectOAuth credential details for an MCP server.
type: "mcp_oauth"mcp_server_url: stringURL of the MCP server this credential authenticates against.
expires_at: optional string or nullA timestamp in RFC 3339 format
format: date-time
refresh: optional BetaManagedAgentsMCPOAuthRefreshResponse or nullOAuth refresh token configuration returned in credential responses.
client_id: stringOAuth client ID.
token_endpoint: stringToken endpoint URL used to refresh the access token.
token_endpoint_auth: BetaManagedAgentsTokenEndpointAuthNoneResponse or BetaManagedAgentsTokenEndpointAuthBasicResponse or BetaManagedAgentsTokenEndpointAuthPostResponseToken endpoint requires no client authentication.
BetaManagedAgentsTokenEndpointAuthNoneResponse objectToken endpoint requires no client authentication.
type: "none"
BetaManagedAgentsTokenEndpointAuthBasicResponse objectToken endpoint uses HTTP Basic authentication with client credentials.
type: "client_secret_basic"
BetaManagedAgentsTokenEndpointAuthPostResponse objectToken endpoint uses POST body authentication with client credentials.
type: "client_secret_post"
resource: optional string or nullOAuth resource indicator.
scope: optional string or nullOAuth scope for the refresh request.
Beta Managed Agents MCP OAuth Create Params
BetaManagedAgentsMCPOAuthCreateParams objectParameters for creating an MCP OAuth credential.
type: "mcp_oauth"access_token: stringOAuth access token.
minLength: 1, maxLength: 8192
mcp_server_url: stringURL of the MCP server this credential authenticates against.
minLength: 1, maxLength: 2047
expires_at: optional string or nullA timestamp in RFC 3339 format
format: date-time
refresh: optional BetaManagedAgentsMCPOAuthRefreshParams or nullOAuth refresh token parameters for creating a credential with refresh support.
client_id: stringOAuth client ID.
minLength: 1, maxLength: 1024
refresh_token: stringOAuth refresh token.
minLength: 1, maxLength: 8192
token_endpoint: stringToken endpoint URL used to refresh the access token.
minLength: 1, maxLength: 2047
token_endpoint_auth: BetaManagedAgentsTokenEndpointAuthNoneParam or BetaManagedAgentsTokenEndpointAuthBasicParam or BetaManagedAgentsTokenEndpointAuthPostParamToken endpoint requires no client authentication.
BetaManagedAgentsTokenEndpointAuthNoneParam objectToken endpoint requires no client authentication.
type: "none"
BetaManagedAgentsTokenEndpointAuthBasicParam objectToken endpoint uses HTTP Basic authentication with client credentials.
type: "client_secret_basic"client_secret: stringOAuth client secret.
minLength: 1, maxLength: 512
BetaManagedAgentsTokenEndpointAuthPostParam objectToken endpoint uses POST body authentication with client credentials.
type: "client_secret_post"client_secret: stringOAuth client secret.
minLength: 1, maxLength: 512
resource: optional string or nullOAuth resource indicator.
minLength: 1, maxLength: 2047
scope: optional string or nullOAuth scope for the refresh request.
minLength: 1, maxLength: 8192
Beta Managed Agents MCP OAuth Refresh Params
BetaManagedAgentsMCPOAuthRefreshParams objectOAuth refresh token parameters for creating a credential with refresh support.
client_id: stringOAuth client ID.
minLength: 1, maxLength: 1024
refresh_token: stringOAuth refresh token.
minLength: 1, maxLength: 8192
token_endpoint: stringToken endpoint URL used to refresh the access token.
minLength: 1, maxLength: 2047
token_endpoint_auth: BetaManagedAgentsTokenEndpointAuthNoneParam or BetaManagedAgentsTokenEndpointAuthBasicParam or BetaManagedAgentsTokenEndpointAuthPostParamToken endpoint requires no client authentication.
BetaManagedAgentsTokenEndpointAuthNoneParam objectToken endpoint requires no client authentication.
type: "none"
BetaManagedAgentsTokenEndpointAuthBasicParam objectToken endpoint uses HTTP Basic authentication with client credentials.
type: "client_secret_basic"client_secret: stringOAuth client secret.
minLength: 1, maxLength: 512
BetaManagedAgentsTokenEndpointAuthPostParam objectToken endpoint uses POST body authentication with client credentials.
type: "client_secret_post"client_secret: stringOAuth client secret.
minLength: 1, maxLength: 512
resource: optional string or nullOAuth resource indicator.
minLength: 1, maxLength: 2047
scope: optional string or nullOAuth scope for the refresh request.
minLength: 1, maxLength: 8192
Beta Managed Agents MCP OAuth Refresh Response
BetaManagedAgentsMCPOAuthRefreshResponse objectOAuth refresh token configuration returned in credential responses.
client_id: stringOAuth client ID.
token_endpoint: stringToken endpoint URL used to refresh the access token.
token_endpoint_auth: BetaManagedAgentsTokenEndpointAuthNoneResponse or BetaManagedAgentsTokenEndpointAuthBasicResponse or BetaManagedAgentsTokenEndpointAuthPostResponseToken endpoint requires no client authentication.
BetaManagedAgentsTokenEndpointAuthNoneResponse objectToken endpoint requires no client authentication.
type: "none"
BetaManagedAgentsTokenEndpointAuthBasicResponse objectToken endpoint uses HTTP Basic authentication with client credentials.
type: "client_secret_basic"
BetaManagedAgentsTokenEndpointAuthPostResponse objectToken endpoint uses POST body authentication with client credentials.
type: "client_secret_post"
resource: optional string or nullOAuth resource indicator.
scope: optional string or nullOAuth scope for the refresh request.
Beta Managed Agents MCP OAuth Refresh Update Params
BetaManagedAgentsMCPOAuthRefreshUpdateParams objectParameters for updating OAuth refresh token configuration.
refresh_token: optional string or nullUpdated OAuth refresh token.
minLength: 1, maxLength: 8192
scope: optional string or nullUpdated OAuth scope for the refresh request.
maxLength: 8192
token_endpoint_auth: optional BetaManagedAgentsTokenEndpointAuthBasicUpdateParam or BetaManagedAgentsTokenEndpointAuthPostUpdateParamUpdated HTTP Basic authentication parameters for the token endpoint.
BetaManagedAgentsTokenEndpointAuthBasicUpdateParam objectUpdated HTTP Basic authentication parameters for the token endpoint.
type: "client_secret_basic"client_secret: optional string or nullUpdated OAuth client secret.
minLength: 1, maxLength: 512
BetaManagedAgentsTokenEndpointAuthPostUpdateParam objectUpdated POST body authentication parameters for the token endpoint.
type: "client_secret_post"client_secret: optional string or nullUpdated OAuth client secret.
minLength: 1, maxLength: 512
Beta Managed Agents MCP OAuth Update Params
BetaManagedAgentsMCPOAuthUpdateParams objectParameters for updating an MCP OAuth credential. The
mcp_server_urlis immutable.type: "mcp_oauth"access_token: optional string or nullUpdated OAuth access token.
minLength: 1, maxLength: 8192
expires_at: optional string or nullA timestamp in RFC 3339 format
format: date-time
refresh: optional BetaManagedAgentsMCPOAuthRefreshUpdateParams or nullParameters for updating OAuth refresh token configuration.
refresh_token: optional string or nullUpdated OAuth refresh token.
minLength: 1, maxLength: 8192
scope: optional string or nullUpdated OAuth scope for the refresh request.
maxLength: 8192
token_endpoint_auth: optional BetaManagedAgentsTokenEndpointAuthBasicUpdateParam or BetaManagedAgentsTokenEndpointAuthPostUpdateParamUpdated HTTP Basic authentication parameters for the token endpoint.
BetaManagedAgentsTokenEndpointAuthBasicUpdateParam objectUpdated HTTP Basic authentication parameters for the token endpoint.
type: "client_secret_basic"client_secret: optional string or nullUpdated OAuth client secret.
minLength: 1, maxLength: 512
BetaManagedAgentsTokenEndpointAuthPostUpdateParam objectUpdated POST body authentication parameters for the token endpoint.
type: "client_secret_post"client_secret: optional string or nullUpdated OAuth client secret.
minLength: 1, maxLength: 512
Beta Managed Agents MCP Probe
BetaManagedAgentsMCPProbe objectThe failing step of an MCP validation probe.
http_response: BetaManagedAgentsRefreshHTTPResponse or nullAn HTTP response captured during a credential validation probe.
body: stringResponse body. May be truncated and has sensitive values scrubbed.
body_truncated: booleanWhether
bodywas truncated.content_type: stringValue of the
Content-Typeresponse header.status_code: numberHTTP status code.
format: int32
method: stringThe MCP method that failed (for example
initializeortools/list).
Beta Managed Agents Refresh HTTP Response
BetaManagedAgentsRefreshHTTPResponse objectAn HTTP response captured during a credential validation probe.
body: stringResponse body. May be truncated and has sensitive values scrubbed.
body_truncated: booleanWhether
bodywas truncated.content_type: stringValue of the
Content-Typeresponse header.status_code: numberHTTP status code.
format: int32
Beta Managed Agents Refresh Object
BetaManagedAgentsRefreshObject objectOutcome of a refresh-token exchange attempted during credential validation.
http_response: BetaManagedAgentsRefreshHTTPResponse or nullAn HTTP response captured during a credential validation probe.
body: stringResponse body. May be truncated and has sensitive values scrubbed.
body_truncated: booleanWhether
bodywas truncated.content_type: stringValue of the
Content-Typeresponse header.status_code: numberHTTP status code.
format: int32
status: "succeeded" or "failed" or "connect_error" or "no_refresh_token"Outcome of a refresh-token exchange attempted during credential validation.
"succeeded""failed""connect_error""no_refresh_token"
Beta Managed Agents Static Bearer Auth Response
BetaManagedAgentsStaticBearerAuthResponse objectStatic bearer token credential details for an MCP server.
type: "static_bearer"mcp_server_url: stringURL of the MCP server this credential authenticates against.
Beta Managed Agents Static Bearer Create Params
BetaManagedAgentsStaticBearerCreateParams objectParameters for creating a static bearer token credential.
type: "static_bearer"token: stringStatic bearer token value.
minLength: 1, maxLength: 8192
mcp_server_url: stringURL of the MCP server this credential authenticates against.
minLength: 1, maxLength: 2047
Beta Managed Agents Static Bearer Update Params
BetaManagedAgentsStaticBearerUpdateParams objectParameters for updating a static bearer token credential. The
mcp_server_urlis immutable.type: "static_bearer"token: optional string or nullUpdated static bearer token value.
minLength: 1, maxLength: 8192
Beta Managed Agents Token Endpoint Auth Basic Param
BetaManagedAgentsTokenEndpointAuthBasicParam objectToken endpoint uses HTTP Basic authentication with client credentials.
type: "client_secret_basic"client_secret: stringOAuth client secret.
minLength: 1, maxLength: 512
Beta Managed Agents Token Endpoint Auth Basic Response
BetaManagedAgentsTokenEndpointAuthBasicResponse objectToken endpoint uses HTTP Basic authentication with client credentials.
type: "client_secret_basic"
Beta Managed Agents Token Endpoint Auth Basic Update Param
BetaManagedAgentsTokenEndpointAuthBasicUpdateParam objectUpdated HTTP Basic authentication parameters for the token endpoint.
type: "client_secret_basic"client_secret: optional string or nullUpdated OAuth client secret.
minLength: 1, maxLength: 512
Beta Managed Agents Token Endpoint Auth None Param
BetaManagedAgentsTokenEndpointAuthNoneParam objectToken endpoint requires no client authentication.
type: "none"
Beta Managed Agents Token Endpoint Auth None Response
BetaManagedAgentsTokenEndpointAuthNoneResponse objectToken endpoint requires no client authentication.
type: "none"
Beta Managed Agents Token Endpoint Auth Post Param
BetaManagedAgentsTokenEndpointAuthPostParam objectToken endpoint uses POST body authentication with client credentials.
type: "client_secret_post"client_secret: stringOAuth client secret.
minLength: 1, maxLength: 512
Beta Managed Agents Token Endpoint Auth Post Response
BetaManagedAgentsTokenEndpointAuthPostResponse objectToken endpoint uses POST body authentication with client credentials.
type: "client_secret_post"
Beta Managed Agents Token Endpoint Auth Post Update Param
BetaManagedAgentsTokenEndpointAuthPostUpdateParam objectUpdated POST body authentication parameters for the token endpoint.
type: "client_secret_post"client_secret: optional string or nullUpdated OAuth client secret.
minLength: 1, maxLength: 512
Beta Managed Agents Unrestricted Credential Networking Params
BetaManagedAgentsUnrestrictedCredentialNetworkingParams objectSubstitute 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
BetaManagedAgentsUnrestrictedCredentialNetworkingResponse objectThe secret is substituted on any host the session's Environment network policy permits egress to.
type: "unrestricted"