Class: OCI::Secrets::SecretsClient

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/secrets/secrets_client.rb

Overview

Use the Secret Retrieval API to retrieve secrets and secret versions from vaults. For more information, see Managing Secrets.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ SecretsClient

Creates a new SecretsClient. Notes: If a config is not specified, then the global OCI.config will be used.

This client is not thread-safe

Either a region or an endpoint must be specified. If an endpoint is specified, it will be used instead of the region. A region may be specified in the config or via or the region parameter. If specified in both, then the region parameter will be used.

Parameters:

  • config (Config) (defaults to: nil) —

    A Config object.

  • region (String) (defaults to: nil) —

    A region used to determine the service endpoint. This will usually correspond to a value in Regions::REGION_ENUM, but may be an arbitrary string.

  • endpoint (String) (defaults to: nil) —

    The fully qualified endpoint URL

  • signer (OCI::BaseSigner) (defaults to: nil) —

    A signer implementation which can be used by this client. If this is not provided then a signer will be constructed via the provided config. One use case of this parameter is instance principals authentication, so that the instance principals signer can be provided to the client

  • proxy_settings (OCI::ApiClientProxySettings) (defaults to: nil) —

    If your environment requires you to use a proxy server for outgoing HTTP requests the details for the proxy can be provided in this parameter

  • retry_config (OCI::Retry::RetryConfig) (defaults to: nil) —

    The retry configuration for this service client. This represents the default retry configuration to apply across all operations. This can be overridden on a per-operation basis. The default retry configuration value is nil, which means that an operation will not perform any retries



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/oci/secrets/secrets_client.rb', line 55

def initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil)
  # If the signer is an InstancePrincipalsSecurityTokenSigner or SecurityTokenSigner and no config was supplied (they are self-sufficient signers)
  # then create a dummy config to pass to the ApiClient constructor. If customers wish to create a client which uses instance principals
  # and has config (either populated programmatically or loaded from a file), they must construct that config themselves and then
  # pass it to this constructor.
  #
  # If there is no signer (or the signer is not an instance principals signer) and no config was supplied, this is not valid
  # so try and load the config from the default file.
  config = OCI::Config.validate_and_build_config_with_signer(config, signer)

  signer = OCI::Signer.config_file_auth_builder(config) if signer.nil?

  @api_client = OCI::ApiClient.new(config, signer, proxy_settings: proxy_settings)
  @retry_config = retry_config

  if endpoint
    @endpoint = endpoint + '/20190301'
  else
    region ||= config.region
    region ||= signer.region if signer.respond_to?(:region)
    self.region = region
  end
  logger.info "SecretsClient endpoint set to '#{@endpoint}'." if logger
end

Instance Attribute Details

#api_client ⇒ OCI::ApiClient (readonly)

Client used to make HTTP requests.

Returns:



15
16
17
 
# File 'lib/oci/secrets/secrets_client.rb', line 15

def api_client
  @api_client
end

#endpoint ⇒ String (readonly)

Fully qualified endpoint URL

Returns:

  • (String) 


19
20
21
 
# File 'lib/oci/secrets/secrets_client.rb', line 19

def endpoint
  @endpoint
end

#region ⇒ String

The region, which will usually correspond to a value in Regions::REGION_ENUM.

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/secrets/secrets_client.rb', line 29

def region
  @region
end

#retry_config ⇒ OCI::Retry::RetryConfig (readonly)

The default retry configuration to apply to all operations in this service client. This can be overridden on a per-operation basis. The default retry configuration value is nil, which means that an operation will not perform any retries

Returns:



25
26
27
 
# File 'lib/oci/secrets/secrets_client.rb', line 25

def retry_config
  @retry_config
end

Instance Method Details

#get_secret_bundle(secret_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_secret_bundle API.

Gets a secret bundle that matches either the specified stage, secretVersionName, or versionNumber parameter. If none of these parameters are provided, the bundle for the secret version marked as CURRENT will be returned.

Parameters:

  • secret_id (String) —

    The OCID of the secret.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :version_number (Integer) —

    The version number of the secret. (default to 0)

  • :secret_version_name (String) —

    The name of the secret. (This might be referred to as the name of the secret version. Names are unique across the different versions of a secret.)

  • :stage (String) —

    The rotation state of the secret version. Allowed values are: CURRENT, PENDING, LATEST, PREVIOUS, DEPRECATED

Returns:



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/oci/secrets/secrets_client.rb', line 117

def get_secret_bundle(secret_id, opts = {})
  logger.debug 'Calling operation SecretsClient#get_secret_bundle.' if logger

  raise "Missing the required parameter 'secret_id' when calling get_secret_bundle." if secret_id.nil?

  if opts[:stage] && !%w[CURRENT PENDING LATEST PREVIOUS DEPRECATED].include?(opts[:stage])
    raise 'Invalid value for "stage", must be one of CURRENT, PENDING, LATEST, PREVIOUS, DEPRECATED.'
  end
  raise "Parameter value for 'secret_id' must not be blank" if OCI::Internal::Util.blank_string?(secret_id)

  path = '/secretbundles/{secretId}'.sub('{secretId}', secret_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:versionNumber] = opts[:version_number] if opts[:version_number]
  query_params[:secretVersionName] = opts[:secret_version_name] if opts[:secret_version_name]
  query_params[:stage] = opts[:stage] if opts[:stage]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'SecretsClient#get_secret_bundle') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Secrets::Models::SecretBundle'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_secret_bundle_by_name(secret_name, vault_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_secret_bundle_by_name API.

Gets a secret bundle by secret name and vault ID, and secret version that matches either the specified stage, secretVersionName, or versionNumber parameter. If none of these parameters are provided, the bundle for the secret version marked as CURRENT is returned.

Parameters:

  • secret_name (String) —

    A user-friendly name for the secret. Secret names are unique within a vault. Secret names are case-sensitive.

  • vault_id (String) —

    The OCID of the vault that contains the secret.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :version_number (Integer) —

    The version number of the secret. (default to 0)

  • :secret_version_name (String) —

    The name of the secret. (This might be referred to as the name of the secret version. Names are unique across the different versions of a secret.)

  • :stage (String) —

    The rotation state of the secret version. Allowed values are: CURRENT, PENDING, LATEST, PREVIOUS, DEPRECATED

Returns:



185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/oci/secrets/secrets_client.rb', line 185

def get_secret_bundle_by_name(secret_name, vault_id, opts = {})
  logger.debug 'Calling operation SecretsClient#get_secret_bundle_by_name.' if logger

  raise "Missing the required parameter 'secret_name' when calling get_secret_bundle_by_name." if secret_name.nil?
  raise "Missing the required parameter 'vault_id' when calling get_secret_bundle_by_name." if vault_id.nil?

  if opts[:stage] && !%w[CURRENT PENDING LATEST PREVIOUS DEPRECATED].include?(opts[:stage])
    raise 'Invalid value for "stage", must be one of CURRENT, PENDING, LATEST, PREVIOUS, DEPRECATED.'
  end

  path = '/secretbundles/actions/getByName'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:secretName] = secret_name
  query_params[:vaultId] = vault_id
  query_params[:versionNumber] = opts[:version_number] if opts[:version_number]
  query_params[:secretVersionName] = opts[:secret_version_name] if opts[:secret_version_name]
  query_params[:stage] = opts[:stage] if opts[:stage]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'SecretsClient#get_secret_bundle_by_name') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Secrets::Models::SecretBundle'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_secret_bundle_versions(secret_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_secret_bundle_versions API.

Lists all secret bundle versions for the specified secret. Allowed values are: ASC, DESC

Parameters:

  • secret_id (String) —

    The OCID of the secret.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :limit (Integer) —

    The maximum number of items to return in a paginated "List" call. For information about pagination, see List Pagination. (default to 10)

  • :page (String) —

    The value of the opc-next-page response header from the previous "List" call. For information about pagination, see List Pagination.

  • :sort_by (String) —

    The field to sort by. You can specify only one sort order. The default order for VERSION_NUMBER is descending. (default to VERSION_NUMBER) Allowed values are: VERSION_NUMBER

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to DESC)

Returns:



261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'lib/oci/secrets/secrets_client.rb', line 261

def list_secret_bundle_versions(secret_id, opts = {})
  logger.debug 'Calling operation SecretsClient#list_secret_bundle_versions.' if logger

  raise "Missing the required parameter 'secret_id' when calling list_secret_bundle_versions." if secret_id.nil?

  if opts[:sort_by] && !%w[VERSION_NUMBER].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of VERSION_NUMBER.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end
  raise "Parameter value for 'secret_id' must not be blank" if OCI::Internal::Util.blank_string?(secret_id)

  path = '/secretbundles/{secretId}/versions'.sub('{secretId}', secret_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'SecretsClient#list_secret_bundle_versions') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::Secrets::Models::SecretBundleVersionSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#logger ⇒ Logger

Returns The logger for this client. May be nil.

Returns:

  • (Logger) —

    The logger for this client. May be nil.



94
95
96
 
# File 'lib/oci/secrets/secrets_client.rb', line 94

def logger
  @api_client.config.logger
end