Module: OpenAI::Models::Beta::Agents::Vaults::CredentialAuth

Extended by:

Internal::Type::Union

Defined in:

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

Overview

The MCP server and authentication configuration of a vault credential, excluding secrets.

Defined Under Namespace

Classes: McpOauth, StaticBearer

Class Method Summary

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

Instance Method Summary

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

  Configuration used to refresh an MCP OAuth access token, excluding secret values.

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

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::CredentialAuth::McpOauth, OpenAI::Models::Beta::Agents::Vaults::CredentialAuth::StaticBearer)

Returns:

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

# File 'lib/openai/models/beta/agents/vaults/credential_auth.rb', line 148

Instance Method Details

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

Configuration used to refresh an MCP OAuth access token, excluding secret values.

Parameters:

• client_id (String) —

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

• resource (String, nil) —

  The resource URI sent to the OAuth token endpoint during refresh, if configured.

• scope (String, nil) —

  Space-separated OAuth scopes requested during refresh, if configured.

• token_endpoint (String) —

  The HTTPS OAuth token endpoint used for refresh.

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

  How the OAuth client authenticates to the token endpoint, excluding its client secret.

# File 'lib/openai/models/beta/agents/vaults/credential_auth.rb', line 103

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

Returns:

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

# File 'sig/openai/models/beta/agents/vaults/credential_auth.rbs', line 98

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