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

Inherits:
Object
  • Object
show all
Defined in:
lib/anthropic/resources/beta/vaults/credentials.rb,
sig/anthropic/resources/beta/vaults/credentials.rbs

Instance Method Summary collapse

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:



274
275
276
 
# File 'lib/anthropic/resources/beta/vaults/credentials.rb', line 274

def initialize(client:)
  @client = client
end

Instance Method Details

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

Archive Credential

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

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.

  • workspace_id (String) —

    Header param: Optional header to select the Workspace for this request. The valu

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

Returns:

See Also:



220
221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/anthropic/resources/beta/vaults/credentials.rb', line 220

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", workspace_id: "anthropic-workspace-id"),
    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, workspace_id: nil, request_options: {}) ⇒ Anthropic::Models::Beta::Vaults::BetaManagedAgentsCredential

Create Credential

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

Parameters:

Returns:

See Also:



32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/anthropic/resources/beta/vaults/credentials.rb', line 32

def create(vault_id, params)
  parsed, options = Anthropic::Beta::Vaults::CredentialCreateParams.dump_request(params)
  header_params = {betas: "anthropic-beta", workspace_id: "anthropic-workspace-id"}
  @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, workspace_id: nil, request_options: {}) ⇒ Anthropic::Models::Beta::Vaults::BetaManagedAgentsDeletedCredential

Delete Credential

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

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.

  • workspace_id (String) —

    Header param: Optional header to select the Workspace for this request. The valu

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

Returns:

See Also:



185
186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/anthropic/resources/beta/vaults/credentials.rb', line 185

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", workspace_id: "anthropic-workspace-id"),
    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, workspace_id: nil, request_options: {}) ⇒ Anthropic::Internal::PageCursor<Anthropic::Models::Beta::Vaults::BetaManagedAgentsCredential>

List Credentials

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

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.

  • workspace_id (String) —

    Header param: Optional header to select the Workspace for this request. The valu

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

Returns:

See Also:



147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/anthropic/resources/beta/vaults/credentials.rb', line 147

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",
      workspace_id: "anthropic-workspace-id"
    ),
    page: Anthropic::Internal::PageCursor,
    model: Anthropic::Beta::Vaults::BetaManagedAgentsCredential,
    options: {extra_headers: {"anthropic-beta" => "managed-agents-2026-04-01"}, **options}
  )
end

#mcp_oauth_validate(credential_id, vault_id:, betas: nil, workspace_id: nil, request_options: {}) ⇒ Anthropic::Models::Beta::Vaults::BetaManagedAgentsCredentialValidation

Validate Credential

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

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.

  • workspace_id (String) —

    Header param: Optional header to select the Workspace for this request. The valu

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

Returns:

See Also:



256
257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/anthropic/resources/beta/vaults/credentials.rb', line 256

def mcp_oauth_validate(credential_id, params)
  parsed, options = Anthropic::Beta::Vaults::CredentialMCPOAuthValidateParams.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/mcp_oauth_validate?beta=true", vault_id, credential_id],
    headers: parsed.transform_keys(betas: "anthropic-beta", workspace_id: "anthropic-workspace-id"),
    model: Anthropic::Beta::Vaults::BetaManagedAgentsCredentialValidation,
    options: {extra_headers: {"anthropic-beta" => "managed-agents-2026-04-01"}, **options}
  )
end

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

Get Credential

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

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.

  • workspace_id (String) —

    Header param: Optional header to select the Workspace for this request. The valu

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

Returns:

See Also:



65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/anthropic/resources/beta/vaults/credentials.rb', line 65

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", workspace_id: "anthropic-workspace-id"),
    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, workspace_id: nil, request_options: {}) ⇒ Anthropic::Models::Beta::Vaults::BetaManagedAgentsCredential

Update Credential

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

Parameters:

Returns:

See Also:



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/anthropic/resources/beta/vaults/credentials.rb', line 106

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", workspace_id: "anthropic-workspace-id"}
  @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