SecretsClient

class oci.secrets.SecretsClient(config, **kwargs)

Use the Secret Retrieval API to retrieve secrets and secret versions from vaults. For more information, see [Managing Secrets](/Content/KeyManagement/Tasks/managingsecrets.htm).

Methods

__init__(config, **kwargs) Creates a new service client
get_secret_bundle(secret_id, **kwargs) Gets a secret bundle that matches either the specified stage, secretVersionName, or versionNumber parameter.
get_secret_bundle_by_name(secret_name, …) Gets a secret bundle by secret name and vault ID, and secret version that matches either the specified stage, secretVersionName, or versionNumber parameter.
list_secret_bundle_versions(secret_id, **kwargs) Lists all secret bundle versions for the specified secret.
__init__(config, **kwargs)

Creates a new service client

Parameters:
  • config (dict) – Configuration keys and values as per SDK and Tool Configuration. The from_file() method can be used to load configuration from a file. Alternatively, a dict can be passed. You can validate_config the dict using validate_config()
  • service_endpoint (str) – (optional) The endpoint of the service to call using this client. For example https://iaas.us-ashburn-1.oraclecloud.com. If this keyword argument is not provided then it will be derived using the region in the config parameter. You should only provide this keyword argument if you have an explicit need to specify a service endpoint.
  • timeout (float or tuple(float, float)) – (optional) The connection and read timeouts for the client. The default values are connection timeout 10 seconds and read timeout 60 seconds. This keyword argument can be provided as a single float, in which case the value provided is used for both the read and connection timeouts, or as a tuple of two floats. If a tuple is provided then the first value is used as the connection timeout and the second value as the read timeout.
  • signer (AbstractBaseSigner) –

    (optional) The signer to use when signing requests made by the service client. The default is to use a Signer based on the values provided in the config parameter.

    One use case for this parameter is for Instance Principals authentication by passing an instance of InstancePrincipalsSecurityTokenSigner as the value for this keyword argument

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to all calls made by this service client (i.e. at the client level). There is no retry strategy applied by default. Retry strategies can also be applied at the operation level by passing a retry_strategy keyword argument as part of calling the operation. Any value provided at the operation level will override whatever is specified at the client level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

  • circuit_breaker_strategy (obj) – (optional) A circuit breaker strategy to apply to all calls made by this service client (i.e. at the client level). This client uses DEFAULT_CIRCUIT_BREAKER_STRATEGY as default if no circuit breaker strategy is provided. The specifics of circuit breaker strategy are described here.
  • circuit_breaker_callback (function) – (optional) Callback function to receive any exceptions triggerred by the circuit breaker.
  • client_level_realm_specific_endpoint_template_enabled (bool) – (optional) A boolean flag to indicate whether or not this client should be created with realm specific endpoint template enabled or disable. By default, this will be set as None.
  • allow_control_chars – (optional) allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object.
get_secret_bundle(secret_id, **kwargs)

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 (str) – (required) The OCID of the secret.
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • version_number (int) – (optional) The version number of the secret.
  • secret_version_name (str) – (optional) 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 (str) –

    (optional) The rotation state of the secret version.

    Allowed values are: “CURRENT”, “PENDING”, “LATEST”, “PREVIOUS”, “DEPRECATED”

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type SecretBundle
Return type:

Response
Example:

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

get_secret_bundle_by_name(secret_name, vault_id, **kwargs)

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 (str) – (required) A user-friendly name for the secret. Secret names are unique within a vault. Secret names are case-sensitive.
  • vault_id (str) – (required) The OCID of the vault that contains the secret.
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • version_number (int) – (optional) The version number of the secret.
  • secret_version_name (str) – (optional) 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 (str) –

    (optional) The rotation state of the secret version.

    Allowed values are: “CURRENT”, “PENDING”, “LATEST”, “PREVIOUS”, “DEPRECATED”

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type SecretBundle
Return type:

Response
Example:

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

list_secret_bundle_versions(secret_id, **kwargs)

Lists all secret bundle versions for the specified secret.

Parameters:
  • secret_id (str) – (required) The OCID of the secret.
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • limit (int) –

    (optional) The maximum number of items to return in a paginated “List” call. For information about pagination, see List Pagination.

  • page (str) –

    (optional) The value of the opc-next-page response header from the previous “List” call. For information about pagination, see List Pagination.

  • sort_by (str) –

    (optional) The field to sort by. You can specify only one sort order. The default order for VERSION_NUMBER is descending.

    Allowed values are: “VERSION_NUMBER”

  • sort_order (str) –

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

    Allowed values are: “ASC”, “DESC”

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type list of SecretBundleVersionSummary
Return type:

Response
Example:

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