Class: Anthropic::Resources::Beta::Vaults::Credentials

Inherits:

Object

• Object
• Anthropic::Resources::Beta::Vaults::Credentials

Defined in:

lib/anthropic/resources/beta/vaults/credentials.rb

Instance Method Summary

• #archive(credential_id, vault_id:, betas: nil, request_options: {}) ⇒ Anthropic::Models::Beta::Vaults::BetaManagedAgentsCredential

  Archive Credential.

• #create(vault_id, auth:, display_name: nil, metadata: nil, betas: nil, request_options: {}) ⇒ Anthropic::Models::Beta::Vaults::BetaManagedAgentsCredential

  Some parameter documentations has been truncated, see Models::Beta::Vaults::CredentialCreateParams for more details.

• #delete(credential_id, vault_id:, betas: nil, request_options: {}) ⇒ Anthropic::Models::Beta::Vaults::BetaManagedAgentsDeletedCredential

  Delete Credential.

• #initialize(client:) ⇒ Credentials constructor private

  A new instance of Credentials.

• #list(vault_id, include_archived: nil, limit: nil, page: nil, betas: nil, request_options: {}) ⇒ Anthropic::Internal::PageCursor<Anthropic::Models::Beta::Vaults::BetaManagedAgentsCredential>

  Some parameter documentations has been truncated, see Models::Beta::Vaults::CredentialListParams for more details.

• #retrieve(credential_id, vault_id:, betas: nil, request_options: {}) ⇒ Anthropic::Models::Beta::Vaults::BetaManagedAgentsCredential

  Get Credential.

• #update(credential_id, vault_id:, auth: nil, display_name: nil, metadata: nil, betas: nil, request_options: {}) ⇒ Anthropic::Models::Beta::Vaults::BetaManagedAgentsCredential

  Some parameter documentations has been truncated, see Models::Beta::Vaults::CredentialUpdateParams for more details.

Constructor Details

#initialize(client:) ⇒ Credentials

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Credentials.

Parameters:

• client (Anthropic::Client)

# File 'lib/anthropic/resources/beta/vaults/credentials.rb', line 214

def initialize(client:)
  @client = client
end

Instance Method Details

#archive(credential_id, vault_id:, betas: nil, request_options: {}) ⇒ Anthropic::Models::Beta::Vaults::BetaManagedAgentsCredential

Archive Credential

Parameters:

• credential_id (String) —

  Path param: Path parameter credential_id

• vault_id (String) —

  Path param: Path parameter vault_id

• betas (Array<String, Symbol, Anthropic::Models::AnthropicBeta>) —

  Header param: Optional header to specify the beta version(s) you want to use.

• request_options (Anthropic::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

• (Anthropic::Models::Beta::Vaults::BetaManagedAgentsCredential)

See Also:

• Models::Beta::Vaults::CredentialArchiveParams

# File 'lib/anthropic/resources/beta/vaults/credentials.rb', line 196

def archive(credential_id, params)
  parsed, options = Anthropic::Beta::Vaults::CredentialArchiveParams.dump_request(params)
  vault_id =
    parsed.delete(:vault_id) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :post,
    path: ["v1/vaults/%1$s/credentials/%2$s/archive?beta=true", vault_id, credential_id],
    headers: parsed.transform_keys(betas: "anthropic-beta"),
    model: Anthropic::Beta::Vaults::BetaManagedAgentsCredential,
    options: {extra_headers: {"anthropic-beta" => "managed-agents-2026-04-01"}, **options}
  )
end

#create(vault_id, auth:, display_name: nil, metadata: nil, betas: nil, request_options: {}) ⇒ Anthropic::Models::Beta::Vaults::BetaManagedAgentsCredential

Some parameter documentations has been truncated, see Models::Beta::Vaults::CredentialCreateParams for more details.

Create Credential

Parameters:

• vault_id (String) —

  Path param: Path parameter vault_id

• auth (Anthropic::Models::Beta::Vaults::BetaManagedAgentsMCPOAuthCreateParams, Anthropic::Models::Beta::Vaults::BetaManagedAgentsStaticBearerCreateParams) —

  Body param: Authentication details for creating a credential.

• display_name (String, nil) —

  Body param: Human-readable name for the credential. Up to 255 characters.

• metadata (Hash{Symbol=>String}) —

  Body param: Arbitrary key-value metadata to attach to the credential. Maximum 16

• betas (Array<String, Symbol, Anthropic::Models::AnthropicBeta>) —

  Header param: Optional header to specify the beta version(s) you want to use.

• request_options (Anthropic::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

• (Anthropic::Models::Beta::Vaults::BetaManagedAgentsCredential)

See Also:

• Models::Beta::Vaults::CredentialCreateParams

# File 'lib/anthropic/resources/beta/vaults/credentials.rb', line 30

def create(vault_id, params)
  parsed, options = Anthropic::Beta::Vaults::CredentialCreateParams.dump_request(params)
  header_params = {betas: "anthropic-beta"}
  @client.request(
    method: :post,
    path: ["v1/vaults/%1$s/credentials?beta=true", vault_id],
    headers: parsed.slice(*header_params.keys).transform_keys(header_params),
    body: parsed.except(*header_params.keys),
    model: Anthropic::Beta::Vaults::BetaManagedAgentsCredential,
    options: {extra_headers: {"anthropic-beta" => "managed-agents-2026-04-01"}, **options}
  )
end

#delete(credential_id, vault_id:, betas: nil, request_options: {}) ⇒ Anthropic::Models::Beta::Vaults::BetaManagedAgentsDeletedCredential

Delete Credential

Parameters:

• credential_id (String) —

  Path param: Path parameter credential_id

• vault_id (String) —

  Path param: Path parameter vault_id

• betas (Array<String, Symbol, Anthropic::Models::AnthropicBeta>) —

  Header param: Optional header to specify the beta version(s) you want to use.

• request_options (Anthropic::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

• (Anthropic::Models::Beta::Vaults::BetaManagedAgentsDeletedCredential)

See Also:

• Models::Beta::Vaults::CredentialDeleteParams

# File 'lib/anthropic/resources/beta/vaults/credentials.rb', line 166

def delete(credential_id, params)
  parsed, options = Anthropic::Beta::Vaults::CredentialDeleteParams.dump_request(params)
  vault_id =
    parsed.delete(:vault_id) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :delete,
    path: ["v1/vaults/%1$s/credentials/%2$s?beta=true", vault_id, credential_id],
    headers: parsed.transform_keys(betas: "anthropic-beta"),
    model: Anthropic::Beta::Vaults::BetaManagedAgentsDeletedCredential,
    options: {extra_headers: {"anthropic-beta" => "managed-agents-2026-04-01"}, **options}
  )
end

#list(vault_id, include_archived: nil, limit: nil, page: nil, betas: nil, request_options: {}) ⇒ Anthropic::Internal::PageCursor<Anthropic::Models::Beta::Vaults::BetaManagedAgentsCredential>

Some parameter documentations has been truncated, see Models::Beta::Vaults::CredentialListParams for more details.

List Credentials

Parameters:

• vault_id (String) —

  Path param: Path parameter vault_id

• include_archived (Boolean) —

  Query param: Whether to include archived credentials in the results.

• limit (Integer) —

  Query param: Maximum number of credentials to return per page. Defaults to 20, m

• page (String) —

  Query param: Opaque pagination token from a previous ‘list_credentials` response

• betas (Array<String, Symbol, Anthropic::Models::AnthropicBeta>) —

  Header param: Optional header to specify the beta version(s) you want to use.

• request_options (Anthropic::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

• (Anthropic::Internal::PageCursor<Anthropic::Models::Beta::Vaults::BetaManagedAgentsCredential>)

See Also:

• Models::Beta::Vaults::CredentialListParams

# File 'lib/anthropic/resources/beta/vaults/credentials.rb', line 136

def list(vault_id, params = {})
  query_params = [:include_archived, :limit, :page]
  parsed, options = Anthropic::Beta::Vaults::CredentialListParams.dump_request(params)
  query = Anthropic::Internal::Util.encode_query_params(parsed.slice(*query_params))
  @client.request(
    method: :get,
    path: ["v1/vaults/%1$s/credentials?beta=true", vault_id],
    query: query,
    headers: parsed.except(*query_params).transform_keys(betas: "anthropic-beta"),
    page: Anthropic::Internal::PageCursor,
    model: Anthropic::Beta::Vaults::BetaManagedAgentsCredential,
    options: {extra_headers: {"anthropic-beta" => "managed-agents-2026-04-01"}, **options}
  )
end

#retrieve(credential_id, vault_id:, betas: nil, request_options: {}) ⇒ Anthropic::Models::Beta::Vaults::BetaManagedAgentsCredential

Get Credential

Parameters:

• credential_id (String) —

  Path param: Path parameter credential_id

• vault_id (String) —

  Path param: Path parameter vault_id

• betas (Array<String, Symbol, Anthropic::Models::AnthropicBeta>) —

  Header param: Optional header to specify the beta version(s) you want to use.

• request_options (Anthropic::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

• (Anthropic::Models::Beta::Vaults::BetaManagedAgentsCredential)

See Also:

• Models::Beta::Vaults::CredentialRetrieveParams

# File 'lib/anthropic/resources/beta/vaults/credentials.rb', line 58

def retrieve(credential_id, params)
  parsed, options = Anthropic::Beta::Vaults::CredentialRetrieveParams.dump_request(params)
  vault_id =
    parsed.delete(:vault_id) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :get,
    path: ["v1/vaults/%1$s/credentials/%2$s?beta=true", vault_id, credential_id],
    headers: parsed.transform_keys(betas: "anthropic-beta"),
    model: Anthropic::Beta::Vaults::BetaManagedAgentsCredential,
    options: {extra_headers: {"anthropic-beta" => "managed-agents-2026-04-01"}, **options}
  )
end

#update(credential_id, vault_id:, auth: nil, display_name: nil, metadata: nil, betas: nil, request_options: {}) ⇒ Anthropic::Models::Beta::Vaults::BetaManagedAgentsCredential

Some parameter documentations has been truncated, see Models::Beta::Vaults::CredentialUpdateParams for more details.

Update Credential

Parameters:

• credential_id (String) —

  Path param: Path parameter credential_id

• vault_id (String) —

  Path param: Path parameter vault_id

• auth (Anthropic::Models::Beta::Vaults::BetaManagedAgentsMCPOAuthUpdateParams, Anthropic::Models::Beta::Vaults::BetaManagedAgentsStaticBearerUpdateParams) —

  Body param: Updated authentication details for a credential.

• display_name (String, nil) —

  Body param: Updated human-readable name for the credential. 1-255 characters.

• metadata (Hash{Symbol=>String, nil}, nil) —

  Body param: Metadata patch. Set a key to a string to upsert it, or to null to de

• betas (Array<String, Symbol, Anthropic::Models::AnthropicBeta>) —

  Header param: Optional header to specify the beta version(s) you want to use.

• request_options (Anthropic::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

• (Anthropic::Models::Beta::Vaults::BetaManagedAgentsCredential)

See Also:

• Models::Beta::Vaults::CredentialUpdateParams

# File 'lib/anthropic/resources/beta/vaults/credentials.rb', line 97

def update(credential_id, params)
  parsed, options = Anthropic::Beta::Vaults::CredentialUpdateParams.dump_request(params)
  vault_id =
    parsed.delete(:vault_id) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  header_params = {betas: "anthropic-beta"}
  @client.request(
    method: :post,
    path: ["v1/vaults/%1$s/credentials/%2$s?beta=true", vault_id, credential_id],
    headers: parsed.slice(*header_params.keys).transform_keys(header_params),
    body: parsed.except(*header_params.keys),
    model: Anthropic::Beta::Vaults::BetaManagedAgentsCredential,
    options: {extra_headers: {"anthropic-beta" => "managed-agents-2026-04-01"}, **options}
  )
end