Module: OpenAI::Models::Beta::Agents::Vaults::CredentialAuthCreateParam

Extended by:

Internal::Type::Union

Defined in:

lib/openai/models/beta/agents/vaults/credential_auth_create_param.rb,
sig/openai/models/beta/agents/vaults/credential_auth_create_param.rbs

Overview

Authentication credentials for an MCP server used by agent tools.

Defined Under Namespace

Classes: McpOauth, StaticBearer

Class Method Summary

• .variants ⇒ Array(OpenAI::Models::Beta::Agents::Vaults::CredentialAuthCreateParam::McpOauth, OpenAI::Models::Beta::Agents::Vaults::CredentialAuthCreateParam::StaticBearer)

Instance Method Summary

• #initialize(client_id:, refresh_token:, token_endpoint:, token_endpoint_auth:, resource: nil, scope: nil) ⇒ Object

  Configuration for refreshing the access token of an MCP OAuth credential.

• #self?.variants ⇒ ::Array[OpenAI::Models::Beta::Agents::Vaults::credential_auth_create_param]

Methods included from Internal::Type::Union

==, ===, coerce, derefed_variants, dump, hash, inspect, to_sorbet_type, variants

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Methods included from Internal::Type::Converter

#coerce, coerce, coerce_with_error, dump, #dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Class Method Details

.variants ⇒ Array(OpenAI::Models::Beta::Agents::Vaults::CredentialAuthCreateParam::McpOauth, OpenAI::Models::Beta::Agents::Vaults::CredentialAuthCreateParam::StaticBearer)

Returns:

• (Array(OpenAI::Models::Beta::Agents::Vaults::CredentialAuthCreateParam::McpOauth, OpenAI::Models::Beta::Agents::Vaults::CredentialAuthCreateParam::StaticBearer))

# File 'lib/openai/models/beta/agents/vaults/credential_auth_create_param.rb', line 177

Instance Method Details

#initialize(client_id:, refresh_token:, token_endpoint:, token_endpoint_auth:, resource: nil, scope: nil) ⇒ Object

Configuration for refreshing the access token of an MCP OAuth credential.

Parameters:

• client_id (String) —

  The OAuth client ID used when requesting a new access token.

• refresh_token (String) —

  The refresh token to store. This secret is never returned in credential resources.

• token_endpoint (String) —

  The HTTPS OAuth token endpoint used to exchange the refresh token for a new access token.

• token_endpoint_auth (OpenAI::Models::Beta::Agents::Vaults::McpOauthTokenEndpointAuthCreateParam::None, OpenAI::Models::Beta::Agents::Vaults::McpOauthTokenEndpointAuthCreateParam::ClientSecretBasic, OpenAI::Models::Beta::Agents::Vaults::McpOauthTokenEndpointAuthCreateParam::ClientSecretPost) —

  How the OAuth client authenticates to the token endpoint.

• resource (String, nil) (defaults to: nil) —

  The resource URI to send to the OAuth token endpoint during refresh, if required.

• scope (String, nil) (defaults to: nil) —

  Space-separated OAuth scopes to request during refresh, if required.

# File 'lib/openai/models/beta/agents/vaults/credential_auth_create_param.rb', line 117

#self?.variants ⇒ ::Array[OpenAI::Models::Beta::Agents::Vaults::credential_auth_create_param]

Returns:

• (::Array[OpenAI::Models::Beta::Agents::Vaults::credential_auth_create_param])

# File 'sig/openai/models/beta/agents/vaults/credential_auth_create_param.rbs', line 115

def self?.variants: -> ::Array[OpenAI::Models::Beta::Agents::Vaults::credential_auth_create_param]