Class: Anthropic::Models::Beta::Vaults::CredentialListParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/anthropic/models/beta/vaults/credential_list_params.rb,
sig/anthropic/models/beta/vaults/credential_list_params.rbs

Overview

See Also:

  • Anthropic::Resources::Beta::Vaults::Credentials#list

Constant Summary

Constants included from Internal::Type::RequestParameters

Internal::Type::RequestParameters::Anthropic

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

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

Methods included from Internal::Util::SorbetRuntimeSupport

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

Constructor Details

#initialize(vault_id:, include_archived: nil, limit: nil, page: nil, betas: nil, workspace_id: nil, request_options: {}) ⇒ void

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

Parameters:

  • vault_id (String)

    Identifier of the vault to list credentials for.

  • include_archived (Boolean) (defaults to: nil)

    Whether to include archived credentials in the results.

  • limit (Integer) (defaults to: nil)

    Maximum number of credentials to return per page. Defaults to 20, maximum 100.

  • page (String) (defaults to: nil)

    Opaque pagination token from a previous list_credentials response.

  • betas (Array<Symbol, String, Anthropic::Models::AnthropicBeta>) (defaults to: nil)

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

  • workspace_id (String) (defaults to: nil)

    Optional header to select the Workspace for this request. The value is a Workspa

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


# File 'lib/anthropic/models/beta/vaults/credential_list_params.rb', line 53

Instance Attribute Details

#betasArray<Symbol, String, Anthropic::Models::AnthropicBeta>?

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

Returns:



40
# File 'lib/anthropic/models/beta/vaults/credential_list_params.rb', line 40

optional :betas, -> { Anthropic::Internal::Type::ArrayOf[union: Anthropic::AnthropicBeta] }

#include_archivedBoolean?

Whether to include archived credentials in the results.

Parameters:

Returns:



22
# File 'lib/anthropic/models/beta/vaults/credential_list_params.rb', line 22

optional :include_archived, Anthropic::Internal::Type::Boolean

#limitInteger?

Maximum number of credentials to return per page. Defaults to 20, maximum 100.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil)


28
# File 'lib/anthropic/models/beta/vaults/credential_list_params.rb', line 28

optional :limit, Integer

#pageString?

Opaque pagination token from a previous list_credentials response.

Parameters:

  • (String)

Returns:

  • (String, nil)


34
# File 'lib/anthropic/models/beta/vaults/credential_list_params.rb', line 34

optional :page, String

#vault_idString

Identifier of the vault to list credentials for.

Parameters:

  • value (String)

Returns:

  • (String)


16
# File 'lib/anthropic/models/beta/vaults/credential_list_params.rb', line 16

required :vault_id, String

#workspace_idString?

Optional header to select the Workspace for this request. The value is a Workspace ID (for example, wrkspc_011CZkZaBF1tNoB5wlCeusgy).

Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.

Parameters:

  • (String)

Returns:

  • (String, nil)


51
# File 'lib/anthropic/models/beta/vaults/credential_list_params.rb', line 51

optional :workspace_id, String

Instance Method Details

#to_hash{

Returns:

  • ({)


54
# File 'sig/anthropic/models/beta/vaults/credential_list_params.rbs', line 54

def to_hash: -> {