CertificatesManagementClient¶

class oci.certificates_management.CertificatesManagementClient(config, **kwargs)¶

API for managing certificates.

Methods

`__init__`(config, **kwargs)	Creates a new service client
`cancel_certificate_authority_deletion`(…)	Cancels the scheduled deletion of the specified certificate authority (CA).
`cancel_certificate_authority_version_deletion`(…)	Cancels the scheduled deletion of the specified certificate authority (CA) version.
`cancel_certificate_deletion`(certificate_id, …)	Cancels the pending deletion of the specified certificate.
`cancel_certificate_version_deletion`(…)	Cancels the scheduled deletion of the specified certificate version.
`change_ca_bundle_compartment`(ca_bundle_id, …)	Moves a CA bundle to a different compartment in the same tenancy.
`change_certificate_authority_compartment`(…)	Moves a certificate authority (CA) to a different compartment within the same tenancy.
`change_certificate_compartment`(…)	Moves a certificate to a different compartment within the same tenancy.
`create_ca_bundle`(create_ca_bundle_details, …)	Creates a new CA bundle according to the details of the request.
`create_certificate`(…)	Creates a new certificate according to the details of the request.
`create_certificate_authority`(…)	Creates a new certificate authority (CA) according to the details of the request.
`delete_ca_bundle`(ca_bundle_id, **kwargs)	Deletes the specified CA bundle.
`get_association`(association_id, **kwargs)	Gets details about the specified association.
`get_ca_bundle`(ca_bundle_id, **kwargs)	Gets details about the specified CA bundle.
`get_certificate`(certificate_id, **kwargs)	Gets details about the specified certificate.
`get_certificate_authority`(…)	Gets details about the specified certificate authority (CA).
`get_certificate_authority_version`(…)	Gets details about the specified certificate authority (CA) version.
`get_certificate_version`(certificate_id, …)	Gets details about the specified version of a certificate.
`list_associations`(**kwargs)	Lists all associations that match the query parameters.
`list_ca_bundles`(**kwargs)	Lists all CA bundles that match the query parameters.
`list_certificate_authorities`(**kwargs)	Lists all certificate authorities (CAs) in the specified compartment.
`list_certificate_authority_versions`(…)	Lists all versions for the specified certificate authority (CA).
`list_certificate_versions`(certificate_id, …)	Lists all certificate versions for the specified certificate.
`list_certificates`(**kwargs)	Lists all certificates that match the query parameters.
`revoke_certificate_authority_version`(…)	Revokes a certificate authority (CA) version.
`revoke_certificate_version`(certificate_id, …)	Revokes the specified certificate version.
`schedule_certificate_authority_deletion`(…)	Schedules the deletion of the specified certificate authority (CA).
`schedule_certificate_authority_version_deletion`(…)	Schedules the deletion of the specified certificate authority (CA) version.
`schedule_certificate_deletion`(…)	Schedules the deletion of the specified certificate.
`schedule_certificate_version_deletion`(…)	Schedules the deletion of the specified certificate version.
`update_ca_bundle`(ca_bundle_id, …)	Updates the properties of a CA bundle.
`update_certificate`(certificate_id, …)	Updates the properties of a certificate.
`update_certificate_authority`(…)	Updates the properties of the specified certificate authority (CA).

__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.

cancel_certificate_authority_deletion(certificate_authority_id, **kwargs)¶

Cancels the scheduled deletion of the specified certificate authority (CA).

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 provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. 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 None
Return type:	`Response`
Example:

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

cancel_certificate_authority_version_deletion(certificate_authority_id, certificate_authority_version_number, **kwargs)¶

Cancels the scheduled deletion of the specified certificate authority (CA) version. Canceling a scheduled deletion restores the CA version’s lifecycle state to what it was before its scheduled deletion.

Parameters:	certificate_authority_id (str) – (required) The OCID of the certificate authority (CA). certificate_authority_version_number (int) – (required) The version number of the certificate authority (CA). opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. 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 None
Return type:	`Response`
Example:

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

cancel_certificate_deletion(certificate_id, **kwargs)¶

Cancels the pending deletion of the specified certificate. Canceling a scheduled deletion restores the certificate’s lifecycle state to what it was before you scheduled the certificate for deletion.

Parameters:	certificate_id (str) – (required) The OCID of the certificate. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. 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 None
Return type:	`Response`
Example:

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

cancel_certificate_version_deletion(certificate_id, certificate_version_number, **kwargs)¶

Cancels the scheduled deletion of the specified certificate version.

Parameters:	certificate_id (str) – (required) The OCID of the certificate. certificate_version_number (int) – (required) The version number of the certificate. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. 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 None
Return type:	`Response`
Example:

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

change_ca_bundle_compartment(ca_bundle_id, change_ca_bundle_compartment_details, **kwargs)¶

Moves a CA bundle to a different compartment in the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

When provided, if-match is checked against the ETag values of the secret.

Parameters:	ca_bundle_id (str) – (required) The OCID of the CA bundle. change_ca_bundle_compartment_details (oci.certificates_management.models.ChangeCaBundleCompartmentDetails) – (required) The updated compartment details. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected). 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 None
Return type:	`Response`
Example:

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

change_certificate_authority_compartment(certificate_authority_id, change_certificate_authority_compartment_details, **kwargs)¶

Moves a certificate authority (CA) to a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

When provided, If-Match is checked against the ETag values of the source.

Parameters:	certificate_authority_id (str) – (required) The OCID of the certificate authority (CA). change_certificate_authority_compartment_details (oci.certificates_management.models.ChangeCertificateAuthorityCompartmentDetails) – (required) The updated compartment details if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected). 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 None
Return type:	`Response`
Example:

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

change_certificate_compartment(certificate_id, change_certificate_compartment_details, **kwargs)¶

Moves a certificate to a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

When provided, if-match is checked against the ETag values of the secret.

Parameters:	certificate_id (str) – (required) The OCID of the certificate. change_certificate_compartment_details (oci.certificates_management.models.ChangeCertificateCompartmentDetails) – (required) The updated compartment details. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected). 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 None
Return type:	`Response`
Example:

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

create_ca_bundle(create_ca_bundle_details, **kwargs)¶

Creates a new CA bundle according to the details of the request.

Parameters:	create_ca_bundle_details (oci.certificates_management.models.CreateCaBundleDetails) – (required) The details of the request to create a new CA bundle. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected). 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 create_ca_bundle API.

create_certificate(create_certificate_details, **kwargs)¶

Creates a new certificate according to the details of the request.

Parameters:	create_certificate_details (oci.certificates_management.models.CreateCertificateDetails) – (required) The details of the request to create a new certificate. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected). 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 `Certificate`
Return type:	`Response`
Example:

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

create_certificate_authority(create_certificate_authority_details, **kwargs)¶

Creates a new certificate authority (CA) according to the details of the request.

Parameters:	create_certificate_authority_details (oci.certificates_management.models.CreateCertificateAuthorityDetails) – (required) The details of the request to create a new CA. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected). 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 `CertificateAuthority`
Return type:	`Response`
Example:

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

delete_ca_bundle(ca_bundle_id, **kwargs)¶

Deletes the specified CA 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 provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. 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 None
Return type:	`Response`
Example:

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

get_association(association_id, **kwargs)¶

Gets details about the specified association.

Parameters:	association_id (str) – (required) The OCID of an association between a certificate-related resource and another Oracle Cloud Infrastructure resource. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service. 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 `Association`
Return type:	`Response`
Example:

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

get_ca_bundle(ca_bundle_id, **kwargs)¶

Gets details about the specified CA 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 provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service. 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(certificate_id, **kwargs)¶

Gets details about 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 provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service. 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 `Certificate`
Return type:	`Response`
Example:

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

get_certificate_authority(certificate_authority_id, **kwargs)¶

Gets details about the specified certificate authority (CA).

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 provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service. 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 `CertificateAuthority`
Return type:	`Response`
Example:

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

get_certificate_authority_version(certificate_authority_id, certificate_authority_version_number, **kwargs)¶

Gets details about the specified certificate authority (CA) version.

Parameters:	certificate_authority_id (str) – (required) The OCID of the certificate authority (CA). certificate_authority_version_number (int) – (required) The version number of the certificate authority (CA). opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service. 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 `CertificateAuthorityVersion`
Return type:	`Response`
Example:

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

get_certificate_version(certificate_id, certificate_version_number, **kwargs)¶

Gets details about the specified version of a certificate.

Parameters:	certificate_id (str) – (required) The OCID of the certificate. certificate_version_number (int) – (required) The version number of the certificate. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service. 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 `CertificateVersion`
Return type:	`Response`
Example:

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

list_associations(**kwargs)¶

Lists all associations that match the query parameters. Optionally, you can use the parameter FilterByAssociationIdQueryParam to limit the result set to a single item that matches the specified association.

Parameters:	opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service. compartment_id (str) – (optional) A filter that returns only resources that match the given compartment OCID. certificates_resource_id (str) – (optional) A filter that returns only resources that match the given OCID of a certificate-related resource. associated_resource_id (str) – (optional) A filter that returns only resources that match the given OCID of an associated Oracle Cloud Infrastructure resource. association_id (str) – (optional) The OCID of the association. If the parameter is set to null, the service lists all associations. name (str) – (optional) A filter that returns only resources that match the specified name. sort_by (str) – (optional) The field to sort by. You can specify only one sort order. The default order for TIMECREATED is descending. The default order for NAME is ascending. Allowed values are: “NAME”, “TIMECREATED” sort_order (str) – (optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: “ASC”, “DESC” limit (int) – (optional) The maximum number of items to return in a paginated “List” call. page (str) – (optional) The value of the opc-next-page response header from the previous “List” call. association_type (str) – (optional) Type of associations to list. If the parameter is set to null, the service lists all types of associations. Allowed values are: “CERTIFICATE”, “CERTIFICATE_AUTHORITY”, “CA_BUNDLE” 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 `AssociationCollection`
Return type:	`Response`
Example:

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

list_ca_bundles(**kwargs)¶

Lists all CA bundles that match the query parameters. Optionally, you can use the parameter FilterByCaBundleIdQueryParam to limit the result set to a single item that matches the specified CA bundle.

Parameters:	opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service. compartment_id (str) – (optional) A filter that returns only resources that match the given compartment OCID. lifecycle_state (str) – (optional) A filter that returns only resources that match the given lifecycle state. The state value is case-insensitive. Allowed values are: “CREATING”, “ACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED” name (str) – (optional) A filter that returns only resources that match the specified name. sort_by (str) – (optional) The field to sort by. You can specify only one sort order. The default order for TIMECREATED is descending. The default order for NAME is ascending. Allowed values are: “NAME”, “TIMECREATED” sort_order (str) – (optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: “ASC”, “DESC” limit (int) – (optional) The maximum number of items to return in a paginated “List” call. page (str) – (optional) The value of the opc-next-page response header from the previous “List” call. ca_bundle_id (str) – (optional) The OCID of the CA bundle. 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 `CaBundleCollection`
Return type:	`Response`
Example:

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

list_certificate_authorities(**kwargs)¶

Lists all certificate authorities (CAs) in the specified compartment. Optionally, you can use the parameter FilterByCertificateAuthorityIdQueryParam to limit the results to a single item that matches the specified CA.

Parameters:	opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service. compartment_id (str) – (optional) A filter that returns only resources that match the given compartment OCID. lifecycle_state (str) – (optional) A filter that returns only resources that match the given lifecycle state. The state value is case-insensitive. Allowed values are: “CREATING”, “ACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “SCHEDULING_DELETION”, “PENDING_DELETION”, “CANCELLING_DELETION”, “FAILED” name (str) – (optional) A filter that returns only resources that match the specified name. issuer_certificate_authority_id (str) – (optional) The OCID of the certificate authority (CA). If the parameter is set to null, the service lists all CAs. certificate_authority_id (str) – (optional) The OCID of the certificate authority (CA). If the parameter is set to null, the service lists all CAs. sort_by (str) – (optional) The field to sort by. You can specify only one sort order. The default order for EXPIRATIONDATE and ‘TIMECREATED’ is descending. The default order for NAME is ascending. Allowed values are: “NAME”, “EXPIRATIONDATE”, “TIMECREATED” sort_order (str) – (optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: “ASC”, “DESC” limit (int) – (optional) The maximum number of items to return in a paginated “List” call. page (str) – (optional) The value of the opc-next-page response header from the previous “List” call. 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 `CertificateAuthorityCollection`
Return type:	`Response`
Example:

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

list_certificate_authority_versions(certificate_authority_id, **kwargs)¶

Lists all versions for the specified certificate authority (CA). Optionally, you can use the parameter FilterByVersionNumberQueryParam to limit the results to a single item that matches the specified version number.

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 provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service. version_number (int) – (optional) A filter that returns only resources that match the specified version number. The default value is 0, which means that this filter is not applied. limit (int) – (optional) The maximum number of items to return in a paginated “List” call. page (str) – (optional) The value of the opc-next-page response header from the previous “List” call. 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 `CertificateAuthorityVersionCollection`
Return type:	`Response`
Example:

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

list_certificate_versions(certificate_id, **kwargs)¶

Lists all certificate versions for the specified certificate. Optionally, you can use the parameter FilterByVersionNumberQueryParam to limit the result set to a single item that matches the specified version number.

Parameters:	certificate_id (str) – (required) The OCID of the certificate. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service. version_number (int) – (optional) A filter that returns only resources that match the specified version number. The default value is 0, which means that this filter is not applied. limit (int) – (optional) The maximum number of items to return in a paginated “List” call. page (str) – (optional) The value of the opc-next-page response header from the previous “List” call. 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 `CertificateVersionCollection`
Return type:	`Response`
Example:

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

list_certificates(**kwargs)¶

Lists all certificates that match the query parameters. Optionally, you can use the parameter FilterByCertificateIdQueryParam to limit the result set to a single item that matches the specified certificate.

Parameters:	opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service. compartment_id (str) – (optional) A filter that returns only resources that match the given compartment OCID. lifecycle_state (str) – (optional) A filter that returns only resources that match the given lifecycle state. The state value is case-insensitive. Allowed values are: “CREATING”, “ACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “SCHEDULING_DELETION”, “PENDING_DELETION”, “CANCELLING_DELETION”, “FAILED” name (str) – (optional) A filter that returns only resources that match the specified name. sort_by (str) – (optional) The field to sort by. You can specify only one sort order. The default order for EXPIRATIONDATE and ‘TIMECREATED’ is descending. The default order for NAME is ascending. Allowed values are: “NAME”, “EXPIRATIONDATE”, “TIMECREATED” sort_order (str) – (optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: “ASC”, “DESC” limit (int) – (optional) The maximum number of items to return in a paginated “List” call. page (str) – (optional) The value of the opc-next-page response header from the previous “List” call. issuer_certificate_authority_id (str) – (optional) The OCID of the certificate authority (CA). If the parameter is set to null, the service lists all CAs. certificate_id (str) – (optional) The OCID of the certificate. If the parameter is set to null, the service lists all certificates. 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 `CertificateCollection`
Return type:	`Response`
Example:

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

revoke_certificate_authority_version(certificate_authority_id, certificate_authority_version_number, revoke_certificate_authority_version_details, **kwargs)¶

Revokes a certificate authority (CA) version.

Parameters:	certificate_authority_id (str) – (required) The OCID of the certificate authority (CA). certificate_authority_version_number (int) – (required) The version number of the certificate authority (CA). revoke_certificate_authority_version_details (oci.certificates_management.models.RevokeCertificateAuthorityVersionDetails) – (required) The details of the request to revoke a CA version. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected). if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. 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 None
Return type:	`Response`
Example:

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

revoke_certificate_version(certificate_id, certificate_version_number, revoke_certificate_version_details, **kwargs)¶

Revokes the specified certificate version.

Parameters:	certificate_id (str) – (required) The OCID of the certificate. certificate_version_number (int) – (required) The version number of the certificate. revoke_certificate_version_details (oci.certificates_management.models.RevokeCertificateVersionDetails) – (required) The details of the request to revoke a certificate version. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected). if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. 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 None
Return type:	`Response`
Example:

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

schedule_certificate_authority_deletion(certificate_authority_id, schedule_certificate_authority_deletion_details, **kwargs)¶

Schedules the deletion of the specified certificate authority (CA). This sets the lifecycle state of the CA to PENDING_DELETION and then deletes it after the specified retention period ends. If needed, you can determine the status of the deletion by using GetCertificateAuthority.

Parameters:	certificate_authority_id (str) – (required) The OCID of the certificate authority (CA). schedule_certificate_authority_deletion_details (oci.certificates_management.models.ScheduleCertificateAuthorityDeletionDetails) – (required) The details of the request to schedule the deletion of a CA. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. 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 None
Return type:	`Response`
Example:

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

schedule_certificate_authority_version_deletion(certificate_authority_id, certificate_authority_version_number, schedule_certificate_authority_version_deletion_details, **kwargs)¶

Schedules the deletion of the specified certificate authority (CA) version. This sets the lifecycle state of the CA version to PENDING_DELETION and then deletes it after the specified retention period ends. If needed, you can determine the status of the deletion by using GetCertificateAuthorityVersion.

Parameters:	certificate_authority_id (str) – (required) The OCID of the certificate authority (CA). certificate_authority_version_number (int) – (required) The version number of the certificate authority (CA). schedule_certificate_authority_version_deletion_details (oci.certificates_management.models.ScheduleCertificateAuthorityVersionDeletionDetails) – (required) The details of the request to delete a CA version. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. 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 None
Return type:	`Response`
Example:

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

schedule_certificate_deletion(certificate_id, schedule_certificate_deletion_details, **kwargs)¶

Schedules the deletion of the specified certificate. This sets the lifecycle state of the certificate to PENDING_DELETION and then deletes it after the specified retention period ends. You can subsequently use GetCertificate to determine the current deletion status.

Parameters:	certificate_id (str) – (required) The OCID of the certificate. schedule_certificate_deletion_details (oci.certificates_management.models.ScheduleCertificateDeletionDetails) – (required) The details of the request to schedule a certificate deletion. This sets the lifecycle state of the certificate to PENDING_DELETION and then deletes it after the specified retention period ends. You can subsequently use GetCertificate to determine the current deletion status. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. 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 None
Return type:	`Response`
Example:

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

schedule_certificate_version_deletion(certificate_id, certificate_version_number, schedule_certificate_version_deletion_details, **kwargs)¶

Schedules the deletion of the specified certificate version. This sets the lifecycle state of the certificate version to PENDING_DELETION and then deletes it after the specified retention period ends. You can only delete a certificate version if the certificate version rotation state is marked as DEPRECATED.

You can subsequently use GetCertificateVersion to determine the current certificate version deletion status.

Parameters:	certificate_id (str) – (required) The OCID of the certificate. certificate_version_number (int) – (required) The version number of the certificate. schedule_certificate_version_deletion_details (oci.certificates_management.models.ScheduleCertificateVersionDeletionDetails) – (required) The details of the request to delete a certificate version. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. 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 None
Return type:	`Response`
Example:

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

update_ca_bundle(ca_bundle_id, update_ca_bundle_details, **kwargs)¶

Updates the properties of a CA bundle.

Parameters:	ca_bundle_id (str) – (required) The OCID of the CA bundle. update_ca_bundle_details (oci.certificates_management.models.UpdateCaBundleDetails) – (required) The details of the request to update a CA bundle. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. 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 update_ca_bundle API.

update_certificate(certificate_id, update_certificate_details, **kwargs)¶

Updates the properties of a certificate.

Parameters:	certificate_id (str) – (required) The OCID of the certificate. update_certificate_details (oci.certificates_management.models.UpdateCertificateDetails) – (required) The details of the request to update a certificate. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. 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 `Certificate`
Return type:	`Response`
Example:

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

update_certificate_authority(certificate_authority_id, update_certificate_authority_details, **kwargs)¶

Updates the properties of the specified certificate authority (CA).

Parameters:	certificate_authority_id (str) – (required) The OCID of the certificate authority (CA). update_certificate_authority_details (oci.certificates_management.models.UpdateCertificateAuthorityDetails) – (required) The details of the request to update a CA. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. 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 `CertificateAuthority`
Return type:	`Response`
Example:

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