Module: OpenAI::Models::Beta::Agents::Vaults::CredentialAuthRotateParam

Extended by:

Internal::Type::Union

Defined in:

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

Overview

Updates to a vault credential without changing its authentication method or MCP server.

Defined Under Namespace

Classes: McpOauth, StaticBearer

Class Method Summary

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

Instance Method Summary

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

  Updates to an MCP credential's existing OAuth refresh configuration.

• #self?.variants ⇒ ::Array[OpenAI::Models::Beta::Agents::Vaults::credential_auth_rotate_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::CredentialAuthRotateParam::McpOauth, OpenAI::Models::Beta::Agents::Vaults::CredentialAuthRotateParam::StaticBearer)

Returns:

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

# File 'lib/openai/models/beta/agents/vaults/credential_auth_rotate_param.rb', line 140

Instance Method Details

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

Updates to an MCP credential's existing OAuth refresh configuration.

Parameters:

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

  The replacement refresh token. Omit or pass null to keep the stored token. This secret is never returned in resources.

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

  Replacement space-separated OAuth scopes for refresh requests. Omit to keep the scopes, or pass null to stop sending a scope parameter.

• token_endpoint_auth (OpenAI::Models::Beta::Agents::Vaults::McpOauthTokenEndpointAuthRotateParam::ClientSecretBasic, OpenAI::Models::Beta::Agents::Vaults::McpOauthTokenEndpointAuthRotateParam::ClientSecretPost, nil) (defaults to: nil) —

  Client-secret updates that preserve the credential's OAuth authentication method.

# File 'lib/openai/models/beta/agents/vaults/credential_auth_rotate_param.rb', line 98

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

Returns:

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

# File 'sig/openai/models/beta/agents/vaults/credential_auth_rotate_param.rbs', line 84

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