Class: OpenAI::Resources::Beta::Agents::Vaults::Credentials

Inherits:
Object
  • Object
show all
Defined in:
lib/openai/resources/beta/agents/vaults/credentials.rb,
sig/openai/resources/beta/agents/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:



187
188
189
 
# File 'lib/openai/resources/beta/agents/vaults/credentials.rb', line 187

def initialize(client:)
  @client = client
end

Instance Method Details

#create(vault_id, auth:, name:, request_options: {}) ⇒ OpenAI::Models::Beta::Agents::Vaults::Credential

Creates a vault credential. Secret values are write-only and are never returned. See vaults.

Parameters:

Returns:

See Also:



30
31
32
33
34
35
36
37
38
39
40
 
# File 'lib/openai/resources/beta/agents/vaults/credentials.rb', line 30

def create(vault_id, params)
  parsed, options = OpenAI::Beta::Agents::Vaults::CredentialCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: ["vaults/%1$s/credentials", vault_id],
    body: parsed,
    model: OpenAI::Beta::Agents::Vaults::Credential,
    security: {bearer_auth: true},
    options: {extra_headers: {"OpenAI-Beta" => "agents=v1"}, **options}
  )
end

#delete(credential_id, vault_id:, request_options: {}) ⇒ OpenAI::Models::Beta::Agents::Vaults::CredentialDeleted

Deletes a vault credential. See vaults.

Parameters:

  • credential_id (String) —

    The ID of the vault credential.

  • vault_id (String) —

    The ID of the vault.

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

Returns:

See Also:



169
170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/openai/resources/beta/agents/vaults/credentials.rb', line 169

def delete(credential_id, params)
  parsed, options = OpenAI::Beta::Agents::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: ["vaults/%1$s/credentials/%2$s", vault_id, credential_id],
    model: OpenAI::Beta::Agents::Vaults::CredentialDeleted,
    security: {bearer_auth: true},
    options: {extra_headers: {"OpenAI-Beta" => "agents=v1"}, **options}
  )
end

#list(vault_id, after: nil, limit: nil, order: nil, status: nil, request_options: {}) ⇒ OpenAI::Internal::CursorPage<OpenAI::Models::Beta::Agents::Vaults::Credential>

Lists a vault's credentials using ID-based pagination without returning secret values. See vaults.

Parameters:

Returns:

See Also:



139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/openai/resources/beta/agents/vaults/credentials.rb', line 139

def list(vault_id, params = {})
  parsed, options = OpenAI::Beta::Agents::Vaults::CredentialListParams.dump_request(params)
  query = OpenAI::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: ["vaults/%1$s/credentials", vault_id],
    query: query,
    page: OpenAI::Internal::CursorPage,
    model: OpenAI::Beta::Agents::Vaults::Credential,
    security: {bearer_auth: true},
    options: {extra_headers: {"OpenAI-Beta" => "agents=v1"}, **options}
  )
end

#retrieve(credential_id, vault_id:, request_options: {}) ⇒ OpenAI::Models::Beta::Agents::Vaults::Credential

Retrieves vault credential metadata without returning secret values. See vaults.

Parameters:

  • credential_id (String) —

    The ID of the vault credential.

  • vault_id (String) —

    The ID of the vault.

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

Returns:

See Also:



58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/openai/resources/beta/agents/vaults/credentials.rb', line 58

def retrieve(credential_id, params)
  parsed, options = OpenAI::Beta::Agents::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: ["vaults/%1$s/credentials/%2$s", vault_id, credential_id],
    model: OpenAI::Beta::Agents::Vaults::Credential,
    security: {bearer_auth: true},
    options: {extra_headers: {"OpenAI-Beta" => "agents=v1"}, **options}
  )
end

#update(credential_id, vault_id:, auth:, request_options: {}) ⇒ OpenAI::Models::Beta::Agents::Vaults::Credential

Rotates a vault credential's write-only secret and returns only credential metadata. See vaults.

Parameters:

Returns:

See Also:



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/openai/resources/beta/agents/vaults/credentials.rb', line 94

def update(credential_id, params)
  parsed, options = OpenAI::Beta::Agents::Vaults::CredentialUpdateParams.dump_request(params)
  vault_id = parsed.delete(:vault_id) do
    raise ArgumentError.new("missing required path argument #{_1}")
  end

  @client.request(
    method: :post,
    path: ["vaults/%1$s/credentials/%2$s", vault_id, credential_id],
    body: parsed,
    model: OpenAI::Beta::Agents::Vaults::Credential,
    security: {bearer_auth: true},
    options: {extra_headers: {"OpenAI-Beta" => "agents=v1"}, **options}
  )
end