CertificatesClient

class oci.certificates.CertificatesClient(config, **kwargs)

API for retrieving certificates.

Methods

__init__(config, **kwargs) Creates a new service client
get_ca_bundle(ca_bundle_id, **kwargs) Gets a ca-bundle bundle.
get_certificate_authority_bundle(…) Gets a certificate authority bundle that matches either the specified stage, name, or versionNumber parameter.
get_certificate_bundle(certificate_id, **kwargs) Gets a certificate bundle that matches either the specified stage, versionName, or versionNumber parameter.
list_certificate_authority_bundle_versions(…) Lists all certificate authority bundle versions for the specified certificate authority.
list_certificate_bundle_versions(…) Lists all certificate bundle versions for the specified certificate.
__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_ca_bundle(ca_bundle_id, **kwargs)

Gets a ca-bundle bundle.

Parameters:
  • ca_bundle_id (str) – (required) The OCID of the CA bundle.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • 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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. 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 CaBundle
Return type:

Response
Example:

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

get_certificate_authority_bundle(certificate_authority_id, **kwargs)

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

Parameters:
  • certificate_authority_id (str) – (required) The OCID of the certificate authority (CA).
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • version_number (int) – (optional) The version number of the certificate authority (CA).
  • certificate_authority_version_name (str) – (optional) The name of the certificate authority (CA). (This might be referred to as the name of the CA version, as every CA consists of at least one version.) Names are unique across versions of a given CA.
  • stage (str) –

    (optional) The rotation state of the certificate 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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. 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 CertificateAuthorityBundle
Return type:

Response
Example:

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

get_certificate_bundle(certificate_id, **kwargs)

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

By default, the private key is not included in the query result, and a CertificateBundlePublicOnly is returned. If the private key is needed, use the CertificateBundleTypeQueryParam parameter to get a CertificateBundleWithPrivateKey response.

Parameters:
  • certificate_id (str) – (required) The OCID of the certificate.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • version_number (int) – (optional) The version number of the certificate. The default value is 0, which means that this query parameter is ignored.
  • certificate_version_name (str) – (optional) The name of the certificate. (This might be referred to as the name of the certificate version, as every certificate consists of at least one version.) Names are unique across versions of a given certificate.
  • stage (str) –

    (optional) The rotation state of the certificate version.

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

  • certificate_bundle_type (str) –

    (optional) The type of certificate bundle. By default, the private key fields are not returned. When querying for certificate bundles, to return results with certificate contents, the private key in PEM format, and the private key passphrase, specify the value of this parameter as CERTIFICATE_CONTENT_WITH_PRIVATE_KEY.

    Allowed values are: “CERTIFICATE_CONTENT_PUBLIC_ONLY”, “CERTIFICATE_CONTENT_WITH_PRIVATE_KEY”

  • 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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. 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 CertificateBundle
Return type:

Response
Example:

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

list_certificate_authority_bundle_versions(certificate_authority_id, **kwargs)

Lists all certificate authority bundle versions for the specified certificate authority.

Parameters:
  • certificate_authority_id (str) – (required) The OCID of the certificate authority (CA).
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • sort_by (str) –

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

    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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. 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 CertificateAuthorityBundleVersionCollection
Return type:

Response
Example:

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

list_certificate_bundle_versions(certificate_id, **kwargs)

Lists all certificate bundle versions for the specified certificate.

Parameters:
  • certificate_id (str) – (required) The OCID of the certificate.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • sort_by (str) –

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

    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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. 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 CertificateBundleVersionCollection
Return type:

Response
Example:

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