Certificates Management Functions
Package: DBMS_CLOUD_OCI_CERTM_CERTIFICATES_MANAGEMENT
CANCEL_CERTIFICATE_AUTHORITY_DELETION Function
Cancels the scheduled deletion of the specified certificate authority (CA).
Syntax
FUNCTION cancel_certificate_authority_deletion (
certificate_authority_id varchar2,
opc_request_id varchar2 DEFAULT NULL,
if_match varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_certm_certificates_management_cancel_certificate_authority_deletion_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) The OCID of the certificate authority (CA). |
|
(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. |
|
(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. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://certificatesmanagement.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
CANCEL_CERTIFICATE_AUTHORITY_VERSION_DELETION Function
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.
Syntax
FUNCTION cancel_certificate_authority_version_deletion (
certificate_authority_id varchar2,
certificate_authority_version_number number,
opc_request_id varchar2 DEFAULT NULL,
if_match varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_certm_certificates_management_cancel_certificate_authority_version_deletion_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) The OCID of the certificate authority (CA). |
|
(required) The version number of the certificate authority (CA). |
|
(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. |
|
(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. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://certificatesmanagement.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
CANCEL_CERTIFICATE_DELETION Function
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.
Syntax
FUNCTION cancel_certificate_deletion (
certificate_id varchar2,
opc_request_id varchar2 DEFAULT NULL,
if_match varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_certm_certificates_management_cancel_certificate_deletion_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) The OCID of the certificate. |
|
(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. |
|
(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. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://certificatesmanagement.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
CANCEL_CERTIFICATE_VERSION_DELETION Function
Cancels the scheduled deletion of the specified certificate version.
Syntax
FUNCTION cancel_certificate_version_deletion (
certificate_id varchar2,
certificate_version_number number,
opc_request_id varchar2 DEFAULT NULL,
if_match varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_certm_certificates_management_cancel_certificate_version_deletion_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) The OCID of the certificate. |
|
(required) The version number of the certificate. |
|
(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. |
|
(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. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://certificatesmanagement.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
CHANGE_CA_BUNDLE_COMPARTMENT Function
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.
Syntax
FUNCTION change_ca_bundle_compartment (
ca_bundle_id varchar2,
change_ca_bundle_compartment_details dbms_cloud_oci_certificates_management_change_ca_bundle_compartment_details_t,
if_match varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
opc_retry_token varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_certm_certificates_management_change_ca_bundle_compartment_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) The OCID of the CA bundle. |
|
(required) The updated compartment details. |
|
(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. |
|
(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. |
|
(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). |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://certificatesmanagement.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
CHANGE_CERTIFICATE_AUTHORITY_COMPARTMENT Function
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.
Syntax
FUNCTION change_certificate_authority_compartment (
certificate_authority_id varchar2,
change_certificate_authority_compartment_details dbms_cloud_oci_certificates_management_change_certificate_authority_compartment_details_t,
if_match varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
opc_retry_token varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_certm_certificates_management_change_certificate_authority_compartment_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) The OCID of the certificate authority (CA). |
|
(required) The updated compartment details |
|
(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. |
|
(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. |
|
(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). |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://certificatesmanagement.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
CHANGE_CERTIFICATE_COMPARTMENT Function
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.
Syntax
FUNCTION change_certificate_compartment (
certificate_id varchar2,
change_certificate_compartment_details dbms_cloud_oci_certificates_management_change_certificate_compartment_details_t,
if_match varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
opc_retry_token varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_certm_certificates_management_change_certificate_compartment_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) The OCID of the certificate. |
|
(required) The updated compartment details. |
|
(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. |
|
(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. |
|
(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). |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://certificatesmanagement.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
CREATE_CA_BUNDLE Function
Creates a new CA bundle according to the details of the request.
Syntax
FUNCTION create_ca_bundle (
create_ca_bundle_details dbms_cloud_oci_certificates_management_create_ca_bundle_details_t,
opc_request_id varchar2 DEFAULT NULL,
opc_retry_token varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_certm_certificates_management_create_ca_bundle_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) The details of the request to create a new CA bundle. |
|
(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. |
|
(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). |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://certificatesmanagement.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
CREATE_CERTIFICATE Function
Creates a new certificate according to the details of the request.
Syntax
FUNCTION create_certificate (
create_certificate_details dbms_cloud_oci_certificates_management_create_certificate_details_t,
opc_request_id varchar2 DEFAULT NULL,
opc_retry_token varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_certm_certificates_management_create_certificate_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) The details of the request to create a new certificate. |
|
(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. |
|
(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). |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://certificatesmanagement.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
CREATE_CERTIFICATE_AUTHORITY Function
Creates a new certificate authority (CA) according to the details of the request.
Syntax
FUNCTION create_certificate_authority (
create_certificate_authority_details dbms_cloud_oci_certificates_management_create_certificate_authority_details_t,
opc_request_id varchar2 DEFAULT NULL,
opc_retry_token varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_certm_certificates_management_create_certificate_authority_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) The details of the request to create a new CA. |
|
(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. |
|
(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). |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://certificatesmanagement.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
DELETE_CA_BUNDLE Function
Deletes the specified CA bundle.
Syntax
FUNCTION delete_ca_bundle (
ca_bundle_id varchar2,
opc_request_id varchar2 DEFAULT NULL,
if_match varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_certm_certificates_management_delete_ca_bundle_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) The OCID of the CA bundle. |
|
(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. |
|
(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. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://certificatesmanagement.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
GET_ASSOCIATION Function
Gets details about the specified association.
Syntax
FUNCTION get_association (
association_id varchar2,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_certm_certificates_management_get_association_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) The OCID of an association between a certificate-related resource and another Oracle Cloud Infrastructure resource. |
|
(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. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://certificatesmanagement.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
GET_CA_BUNDLE Function
Gets details about the specified CA bundle.
Syntax
FUNCTION get_ca_bundle (
ca_bundle_id varchar2,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_certm_certificates_management_get_ca_bundle_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) The OCID of the CA bundle. |
|
(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. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://certificatesmanagement.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
GET_CERTIFICATE Function
Gets details about the specified certificate.
Syntax
FUNCTION get_certificate (
certificate_id varchar2,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_certm_certificates_management_get_certificate_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) The OCID of the certificate. |
|
(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. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://certificatesmanagement.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
GET_CERTIFICATE_AUTHORITY Function
Gets details about the specified certificate authority (CA).
Syntax
FUNCTION get_certificate_authority (
certificate_authority_id varchar2,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_certm_certificates_management_get_certificate_authority_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) The OCID of the certificate authority (CA). |
|
(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. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://certificatesmanagement.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
GET_CERTIFICATE_AUTHORITY_VERSION Function
Gets details about the specified certificate authority (CA) version.
Syntax
FUNCTION get_certificate_authority_version (
certificate_authority_id varchar2,
certificate_authority_version_number number,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_certm_certificates_management_get_certificate_authority_version_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) The OCID of the certificate authority (CA). |
|
(required) The version number of the certificate authority (CA). |
|
(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. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://certificatesmanagement.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
GET_CERTIFICATE_VERSION Function
Gets details about the specified version of a certificate.
Syntax
FUNCTION get_certificate_version (
certificate_id varchar2,
certificate_version_number number,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_certm_certificates_management_get_certificate_version_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) The OCID of the certificate. |
|
(required) The version number of the certificate. |
|
(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. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://certificatesmanagement.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
LIST_ASSOCIATIONS Function
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.
Syntax
FUNCTION list_associations (
opc_request_id varchar2 DEFAULT NULL,
compartment_id varchar2 DEFAULT NULL,
certificates_resource_id varchar2 DEFAULT NULL,
associated_resource_id varchar2 DEFAULT NULL,
association_id varchar2 DEFAULT NULL,
name varchar2 DEFAULT NULL,
sort_by varchar2 DEFAULT NULL,
sort_order varchar2 DEFAULT NULL,
limit number DEFAULT NULL,
page varchar2 DEFAULT NULL,
association_type varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_certm_certificates_management_list_associations_response_t;
Parameters
Parameter | Description |
---|---|
|
(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. |
|
(optional) A filter that returns only resources that match the given compartment OCID. |
|
(optional) A filter that returns only resources that match the given OCID of a certificate-related resource. |
|
(optional) A filter that returns only resources that match the given OCID of an associated Oracle Cloud Infrastructure resource. |
|
(optional) The OCID of the association. If the parameter is set to null, the service lists all associations. |
|
(optional) A filter that returns only resources that match the specified name. |
|
(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' |
|
(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). Allowed values are: 'ASC', 'DESC' |
|
(optional) The maximum number of items to return in a paginated \"List\" call. |
|
(optional) The value of the `opc-next-page` response header from the previous \"List\" call. |
|
(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' |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://certificatesmanagement.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
LIST_CA_BUNDLES Function
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.
Syntax
FUNCTION list_ca_bundles (
opc_request_id varchar2 DEFAULT NULL,
compartment_id varchar2 DEFAULT NULL,
lifecycle_state varchar2 DEFAULT NULL,
name varchar2 DEFAULT NULL,
sort_by varchar2 DEFAULT NULL,
sort_order varchar2 DEFAULT NULL,
limit number DEFAULT NULL,
page varchar2 DEFAULT NULL,
ca_bundle_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_certm_certificates_management_list_ca_bundles_response_t;
Parameters
Parameter | Description |
---|---|
|
(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. |
|
(optional) A filter that returns only resources that match the given compartment OCID. |
|
(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' |
|
(optional) A filter that returns only resources that match the specified name. |
|
(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' |
|
(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). Allowed values are: 'ASC', 'DESC' |
|
(optional) The maximum number of items to return in a paginated \"List\" call. |
|
(optional) The value of the `opc-next-page` response header from the previous \"List\" call. |
|
(optional) The OCID of the CA bundle. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://certificatesmanagement.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
LIST_CERTIFICATE_AUTHORITIES Function
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.
Syntax
FUNCTION list_certificate_authorities (
opc_request_id varchar2 DEFAULT NULL,
compartment_id varchar2 DEFAULT NULL,
lifecycle_state varchar2 DEFAULT NULL,
name varchar2 DEFAULT NULL,
issuer_certificate_authority_id varchar2 DEFAULT NULL,
certificate_authority_id varchar2 DEFAULT NULL,
sort_by varchar2 DEFAULT NULL,
sort_order varchar2 DEFAULT NULL,
limit number DEFAULT NULL,
page varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_certm_certificates_management_list_certificate_authorities_response_t;
Parameters
Parameter | Description |
---|---|
|
(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. |
|
(optional) A filter that returns only resources that match the given compartment OCID. |
|
(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' |
|
(optional) A filter that returns only resources that match the specified name. |
|
(optional) The OCID of the certificate authority (CA). If the parameter is set to null, the service lists all CAs. |
|
(optional) The OCID of the certificate authority (CA). If the parameter is set to null, the service lists all CAs. |
|
(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' |
|
(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). Allowed values are: 'ASC', 'DESC' |
|
(optional) The maximum number of items to return in a paginated \"List\" call. |
|
(optional) The value of the `opc-next-page` response header from the previous \"List\" call. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://certificatesmanagement.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
LIST_CERTIFICATE_AUTHORITY_VERSIONS Function
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.
Syntax
FUNCTION list_certificate_authority_versions (
certificate_authority_id varchar2,
opc_request_id varchar2 DEFAULT NULL,
version_number number DEFAULT NULL,
limit number DEFAULT NULL,
page varchar2 DEFAULT NULL,
sort_by varchar2 DEFAULT NULL,
sort_order varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_certm_certificates_management_list_certificate_authority_versions_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) The OCID of the certificate authority (CA). |
|
(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. |
|
(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. |
|
(optional) The maximum number of items to return in a paginated \"List\" call. |
|
(optional) The value of the `opc-next-page` response header from the previous \"List\" call. |
|
(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' |
|
(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). Allowed values are: 'ASC', 'DESC' |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://certificatesmanagement.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
LIST_CERTIFICATE_VERSIONS Function
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.
Syntax
FUNCTION list_certificate_versions (
certificate_id varchar2,
opc_request_id varchar2 DEFAULT NULL,
version_number number DEFAULT NULL,
limit number DEFAULT NULL,
page varchar2 DEFAULT NULL,
sort_by varchar2 DEFAULT NULL,
sort_order varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_certm_certificates_management_list_certificate_versions_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) The OCID of the certificate. |
|
(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. |
|
(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. |
|
(optional) The maximum number of items to return in a paginated \"List\" call. |
|
(optional) The value of the `opc-next-page` response header from the previous \"List\" call. |
|
(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' |
|
(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). Allowed values are: 'ASC', 'DESC' |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://certificatesmanagement.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
LIST_CERTIFICATES Function
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.
Syntax
FUNCTION list_certificates (
opc_request_id varchar2 DEFAULT NULL,
compartment_id varchar2 DEFAULT NULL,
lifecycle_state varchar2 DEFAULT NULL,
name varchar2 DEFAULT NULL,
sort_by varchar2 DEFAULT NULL,
sort_order varchar2 DEFAULT NULL,
limit number DEFAULT NULL,
page varchar2 DEFAULT NULL,
issuer_certificate_authority_id varchar2 DEFAULT NULL,
certificate_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_certm_certificates_management_list_certificates_response_t;
Parameters
Parameter | Description |
---|---|
|
(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. |
|
(optional) A filter that returns only resources that match the given compartment OCID. |
|
(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' |
|
(optional) A filter that returns only resources that match the specified name. |
|
(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' |
|
(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). Allowed values are: 'ASC', 'DESC' |
|
(optional) The maximum number of items to return in a paginated \"List\" call. |
|
(optional) The value of the `opc-next-page` response header from the previous \"List\" call. |
|
(optional) The OCID of the certificate authority (CA). If the parameter is set to null, the service lists all CAs. |
|
(optional) The OCID of the certificate. If the parameter is set to null, the service lists all certificates. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://certificatesmanagement.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
REVOKE_CERTIFICATE_AUTHORITY_VERSION Function
Revokes a certificate authority (CA) version.
Syntax
FUNCTION revoke_certificate_authority_version (
certificate_authority_id varchar2,
certificate_authority_version_number number,
revoke_certificate_authority_version_details dbms_cloud_oci_certificates_management_revoke_certificate_authority_version_details_t,
opc_request_id varchar2 DEFAULT NULL,
opc_retry_token varchar2 DEFAULT NULL,
if_match varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_certm_certificates_management_revoke_certificate_authority_version_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) The OCID of the certificate authority (CA). |
|
(required) The version number of the certificate authority (CA). |
|
(required) The details of the request to revoke a CA version. |
|
(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. |
|
(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). |
|
(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. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://certificatesmanagement.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
REVOKE_CERTIFICATE_VERSION Function
Revokes the specified certificate version.
Syntax
FUNCTION revoke_certificate_version (
certificate_id varchar2,
certificate_version_number number,
revoke_certificate_version_details dbms_cloud_oci_certificates_management_revoke_certificate_version_details_t,
opc_request_id varchar2 DEFAULT NULL,
opc_retry_token varchar2 DEFAULT NULL,
if_match varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_certm_certificates_management_revoke_certificate_version_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) The OCID of the certificate. |
|
(required) The version number of the certificate. |
|
(required) The details of the request to revoke a certificate version. |
|
(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. |
|
(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). |
|
(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. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://certificatesmanagement.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
SCHEDULE_CERTIFICATE_AUTHORITY_DELETION Function
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`.
Syntax
FUNCTION schedule_certificate_authority_deletion (
certificate_authority_id varchar2,
schedule_certificate_authority_deletion_details dbms_cloud_oci_certificates_management_schedule_certificate_authority_deletion_details_t,
opc_request_id varchar2 DEFAULT NULL,
if_match varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_certm_certificates_management_schedule_certificate_authority_deletion_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) The OCID of the certificate authority (CA). |
|
(required) The details of the request to schedule the deletion of a CA. |
|
(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. |
|
(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. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://certificatesmanagement.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
SCHEDULE_CERTIFICATE_AUTHORITY_VERSION_DELETION Function
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`.
Syntax
FUNCTION schedule_certificate_authority_version_deletion (
certificate_authority_id varchar2,
certificate_authority_version_number number,
schedule_certificate_authority_version_deletion_details dbms_cloud_oci_certificates_management_schedule_certificate_authority_version_deletion_details_t,
opc_request_id varchar2 DEFAULT NULL,
if_match varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_certm_certificates_management_schedule_certificate_authority_version_deletion_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) The OCID of the certificate authority (CA). |
|
(required) The version number of the certificate authority (CA). |
|
(required) The details of the request to delete a CA version. |
|
(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. |
|
(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. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://certificatesmanagement.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
SCHEDULE_CERTIFICATE_DELETION Function
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.
Syntax
FUNCTION schedule_certificate_deletion (
certificate_id varchar2,
schedule_certificate_deletion_details dbms_cloud_oci_certificates_management_schedule_certificate_deletion_details_t,
opc_request_id varchar2 DEFAULT NULL,
if_match varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_certm_certificates_management_schedule_certificate_deletion_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) The OCID of the certificate. |
|
(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. |
|
(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. |
|
(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. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://certificatesmanagement.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
SCHEDULE_CERTIFICATE_VERSION_DELETION Function
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.
Syntax
FUNCTION schedule_certificate_version_deletion (
certificate_id varchar2,
certificate_version_number number,
schedule_certificate_version_deletion_details dbms_cloud_oci_certificates_management_schedule_certificate_version_deletion_details_t,
opc_request_id varchar2 DEFAULT NULL,
if_match varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_certm_certificates_management_schedule_certificate_version_deletion_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) The OCID of the certificate. |
|
(required) The version number of the certificate. |
|
(required) The details of the request to delete a certificate version. |
|
(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. |
|
(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. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://certificatesmanagement.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
UPDATE_CA_BUNDLE Function
Updates the properties of a CA bundle.
Syntax
FUNCTION update_ca_bundle (
ca_bundle_id varchar2,
update_ca_bundle_details dbms_cloud_oci_certificates_management_update_ca_bundle_details_t,
opc_request_id varchar2 DEFAULT NULL,
if_match varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_certm_certificates_management_update_ca_bundle_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) The OCID of the CA bundle. |
|
(required) The details of the request to update a CA bundle. |
|
(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. |
|
(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. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://certificatesmanagement.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
UPDATE_CERTIFICATE Function
Updates the properties of a certificate.
Syntax
FUNCTION update_certificate (
certificate_id varchar2,
update_certificate_details dbms_cloud_oci_certificates_management_update_certificate_details_t,
opc_request_id varchar2 DEFAULT NULL,
if_match varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_certm_certificates_management_update_certificate_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) The OCID of the certificate. |
|
(required) The details of the request to update a certificate. |
|
(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. |
|
(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. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://certificatesmanagement.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
UPDATE_CERTIFICATE_AUTHORITY Function
Updates the properties of the specified certificate authority (CA).
Syntax
FUNCTION update_certificate_authority (
certificate_authority_id varchar2,
update_certificate_authority_details dbms_cloud_oci_certificates_management_update_certificate_authority_details_t,
opc_request_id varchar2 DEFAULT NULL,
if_match varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_certm_certificates_management_update_certificate_authority_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) The OCID of the certificate authority (CA). |
|
(required) The details of the request to update a CA. |
|
(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. |
|
(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. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://certificatesmanagement.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |