Certificates Functions

Package: DBMS_CLOUD_OCI_CERT_CERTIFICATES

GET_CA_BUNDLE Function

Gets a ca-bundle 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_cert_certificates_get_ca_bundle_response_t;

Parameters

Parameter	Description
`ca_bundle_id`	(required) The OCID of the CA bundle.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://certificates.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_CERTIFICATE_AUTHORITY_BUNDLE Function

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

Syntax

FUNCTION get_certificate_authority_bundle (
  certificate_authority_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  version_number number DEFAULT NULL,
  certificate_authority_version_name varchar2 DEFAULT NULL,
  stage varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cert_certificates_get_certificate_authority_bundle_response_t;

Parameters

Parameter	Description
`certificate_authority_id`	(required) The OCID of the certificate authority (CA).
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`version_number`	(optional) The version number of the certificate authority (CA).
`certificate_authority_version_name`	(optional) The name of the certificate authority (CA). (This might be referred to as the name of the CA version, as every CA consists of at least one version.) Names are unique across versions of a given CA.
`stage`	(optional) The rotation state of the certificate version. Allowed values are: 'CURRENT', 'PENDING', 'LATEST', 'PREVIOUS', 'DEPRECATED'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://certificates.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_CERTIFICATE_BUNDLE Function

Gets a certificate bundle that matches either the specified `stage`, `versionName`, or `versionNumber` parameter. If none of these parameters are provided, the bundle for the certificate version marked as `CURRENT` will be returned. By default, the private key is not included in the query result, and a CertificateBundlePublicOnly is returned. If the private key is needed, use the CertificateBundleTypeQueryParam parameter to get a CertificateBundleWithPrivateKey response.

Syntax

FUNCTION get_certificate_bundle (
  certificate_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  version_number number DEFAULT NULL,
  certificate_version_name varchar2 DEFAULT NULL,
  stage varchar2 DEFAULT NULL,
  certificate_bundle_type varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cert_certificates_get_certificate_bundle_response_t;

Parameters

Parameter	Description
`certificate_id`	(required) The OCID of the certificate.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`version_number`	(optional) The version number of the certificate. The default value is 0, which means that this query parameter is ignored.
`certificate_version_name`	(optional) The name of the certificate. (This might be referred to as the name of the certificate version, as every certificate consists of at least one version.) Names are unique across versions of a given certificate.
`stage`	(optional) The rotation state of the certificate version. Allowed values are: 'CURRENT', 'PENDING', 'LATEST', 'PREVIOUS', 'DEPRECATED'
`certificate_bundle_type`	(optional) The type of certificate bundle. By default, the private key fields are not returned. When querying for certificate bundles, to return results with certificate contents, the private key in PEM format, and the private key passphrase, specify the value of this parameter as `CERTIFICATE_CONTENT_WITH_PRIVATE_KEY`. Allowed values are: 'CERTIFICATE_CONTENT_PUBLIC_ONLY', 'CERTIFICATE_CONTENT_WITH_PRIVATE_KEY'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://certificates.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_CERTIFICATE_AUTHORITY_BUNDLE_VERSIONS Function

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

Syntax

FUNCTION list_certificate_authority_bundle_versions (
  certificate_authority_id varchar2,
  opc_request_id 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_cert_certificates_list_certificate_authority_bundle_versions_response_t;

Parameters

Parameter	Description
`certificate_authority_id`	(required) The OCID of the certificate authority (CA).
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`sort_by`	(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`	(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). Allowed values are: 'ASC', 'DESC'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://certificates.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_CERTIFICATE_BUNDLE_VERSIONS Function

Lists all certificate bundle versions for the specified certificate.

Syntax

FUNCTION list_certificate_bundle_versions (
  certificate_id varchar2,
  opc_request_id 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_cert_certificates_list_certificate_bundle_versions_response_t;

Parameters

Parameter	Description
`certificate_id`	(required) The OCID of the certificate.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`sort_by`	(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`	(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). Allowed values are: 'ASC', 'DESC'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://certificates.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

Oracle Cloud Infrastructure Documentation Try Free Tier

GET_CA_BUNDLE Function 🔗

GET_CERTIFICATE_AUTHORITY_BUNDLE Function 🔗

GET_CERTIFICATE_BUNDLE Function 🔗

LIST_CERTIFICATE_AUTHORITY_BUNDLE_VERSIONS Function 🔗

LIST_CERTIFICATE_BUNDLE_VERSIONS Function 🔗

Oracle Cloud Infrastructure Documentation
Try Free Tier

GET_CA_BUNDLE Function

GET_CERTIFICATE_AUTHORITY_BUNDLE Function

GET_CERTIFICATE_BUNDLE Function

LIST_CERTIFICATE_AUTHORITY_BUNDLE_VERSIONS Function

LIST_CERTIFICATE_BUNDLE_VERSIONS Function