Oracle Cloud Infrastructure Documentation
Try Free Tier

Certificates Common Types

DBMS_CLOUD_OCI_CERTIFICATES_VARCHAR2_TBL Type

Nested table type of varchar2(32767).

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_certificates_varchar2_tbl FORCE IS TABLE OF (varchar2(32767)) NOT PERSISTABLE;

DBMS_CLOUD_OCI_CERTIFICATES_CA_BUNDLE_T Type

The contents of the CA bundle (root and intermediate certificates), properties of the CA bundle, and user-provided contextual metadata for the CA bundle.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_certificates_ca_bundle_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  name varchar2(32767),
  ca_bundle_pem varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_certificates_ca_bundle_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_certificates_ca_bundle_t (
    id varchar2,
    name varchar2,
    ca_bundle_pem varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the CA bundle.

name

(required) A user-friendly name for the CA bundle. Names are unique within a compartment. Valid characters include uppercase or lowercase letters, numbers, hyphens, underscores, and periods.

ca_bundle_pem

(required) Certificates (in PEM format) in the CA bundle. Can be of arbitrary length.

DBMS_CLOUD_OCI_CERTIFICATES_VALIDITY_T Type

An object that describes a period of time during which an entity is valid.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_certificates_validity_t FORCE AUTHID CURRENT_USER IS OBJECT (
  time_of_validity_not_before timestamp with time zone,
  time_of_validity_not_after timestamp with time zone,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_certificates_validity_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_certificates_validity_t (
    time_of_validity_not_before timestamp with time zone,
    time_of_validity_not_after timestamp with time zone
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

time_of_validity_not_before

(required) The date on which the certificate validity period begins, expressed in RFC 3339 timestamp format. Example: `2019-04-03T21:10:29.600Z`

time_of_validity_not_after

(required) The date on which the certificate validity period ends, expressed in RFC 3339 timestamp format. Example: `2019-04-03T21:10:29.600Z`

DBMS_CLOUD_OCI_CERTIFICATES_REVOCATION_STATUS_T Type

The current revocation status of the certificate or certificate authority (CA).

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_certificates_revocation_status_t FORCE AUTHID CURRENT_USER IS OBJECT (
  time_revoked timestamp with time zone,
  revocation_reason varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_certificates_revocation_status_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_certificates_revocation_status_t (
    time_revoked timestamp with time zone,
    revocation_reason varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

time_revoked

(required) The time when the certificate or CA was revoked.

revocation_reason

(required) The reason that the certificate or CA was revoked.

Allowed values are: 'UNSPECIFIED', 'KEY_COMPROMISE', 'CA_COMPROMISE', 'AFFILIATION_CHANGED', 'SUPERSEDED', 'CESSATION_OF_OPERATION', 'PRIVILEGE_WITHDRAWN', 'AA_COMPROMISE'

DBMS_CLOUD_OCI_CERTIFICATES_CERTIFICATE_AUTHORITY_BUNDLE_T Type

The contents of the certificate, properties of the certificate (and certificate version), and user-provided contextual metadata for the certificate.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_certificates_certificate_authority_bundle_t FORCE AUTHID CURRENT_USER IS OBJECT (
  certificate_authority_id varchar2(32767),
  certificate_authority_name varchar2(32767),
  serial_number varchar2(32767),
  certificate_pem varchar2(32767),
  cert_chain_pem varchar2(32767),
  version_name varchar2(32767),
  time_created timestamp with time zone,
  version_number number,
  validity dbms_cloud_oci_certificates_validity_t,
  stages dbms_cloud_oci_certificates_varchar2_tbl,
  revocation_status dbms_cloud_oci_certificates_revocation_status_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_certificates_certificate_authority_bundle_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_certificates_certificate_authority_bundle_t (
    certificate_authority_id varchar2,
    certificate_authority_name varchar2,
    serial_number varchar2,
    certificate_pem varchar2,
    cert_chain_pem varchar2,
    version_name varchar2,
    time_created timestamp with time zone,
    version_number number,
    validity dbms_cloud_oci_certificates_validity_t,
    stages dbms_cloud_oci_certificates_varchar2_tbl,
    revocation_status dbms_cloud_oci_certificates_revocation_status_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

certificate_authority_id

(required) The OCID of the certificate authority (CA).

certificate_authority_name

(required) The name of the CA.

serial_number

(required) A unique certificate identifier used in certificate revocation tracking, formatted as octets. Example: `03 AC FC FA CC B3 CB 02 B8 F8 DE F5 85 E7 7B FF`

certificate_pem

(required) The certificate (in PEM format) for this CA version.

cert_chain_pem

(optional) The certificate chain (in PEM format) for this CA version.

version_name

(optional) The name of the CA.

time_created

(required) A property indicating when the CA was created, expressed in RFC 3339 timestamp format. Example: `2019-04-03T21:10:29.600Z`

version_number

(required) The version number of the CA.

validity

(required)

stages

(required) A list of rotation states for this CA.

Allowed values are: 'CURRENT', 'PENDING', 'LATEST', 'PREVIOUS', 'DEPRECATED', 'FAILED'

revocation_status

(optional)

DBMS_CLOUD_OCI_CERTIFICATES_CERTIFICATE_AUTHORITY_BUNDLE_VERSION_SUMMARY_T Type

The properties of a version of a bundle for a certificate authority (CA). Certificate authority bundle version summary objects do not include the actual contents of the certificate.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_certificates_certificate_authority_bundle_version_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  certificate_authority_id varchar2(32767),
  serial_number varchar2(32767),
  time_created timestamp with time zone,
  version_number number,
  version_name varchar2(32767),
  certificate_authority_name varchar2(32767),
  time_of_deletion timestamp with time zone,
  validity dbms_cloud_oci_certificates_validity_t,
  stages dbms_cloud_oci_certificates_varchar2_tbl,
  revocation_status dbms_cloud_oci_certificates_revocation_status_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_certificates_certificate_authority_bundle_version_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_certificates_certificate_authority_bundle_version_summary_t (
    certificate_authority_id varchar2,
    serial_number varchar2,
    time_created timestamp with time zone,
    version_number number,
    version_name varchar2,
    certificate_authority_name varchar2,
    time_of_deletion timestamp with time zone,
    validity dbms_cloud_oci_certificates_validity_t,
    stages dbms_cloud_oci_certificates_varchar2_tbl,
    revocation_status dbms_cloud_oci_certificates_revocation_status_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

certificate_authority_id

(required) The OCID of the certificate authority (CA).

serial_number

(optional) A unique certificate identifier used in certificate revocation tracking, formatted as octets. Example: `03 AC FC FA CC B3 CB 02 B8 F8 DE F5 85 E7 7B FF`

time_created

(required) An optional property indicating when the CA version was created, expressed in RFC 3339 timestamp format. Example: `2019-04-03T21:10:29.600Z`

version_number

(required) The version number of the CA.

version_name

(optional) The name of the CA version. When this value is not null, the name is unique across CA versions for a given CA.

certificate_authority_name

(required) The name of the CA.

time_of_deletion

(optional) An optional property indicating when to delete the CA version, expressed in RFC 3339 timestamp format. Example: `2019-04-03T21:10:29.600Z`

validity

(optional)

stages

(required) A list of rotation states for this CA version.

Allowed values are: 'CURRENT', 'PENDING', 'LATEST', 'PREVIOUS', 'DEPRECATED', 'FAILED'

revocation_status

(optional)

DBMS_CLOUD_OCI_CERTIFICATES_CERTIFICATE_AUTHORITY_BUNDLE_VERSION_SUMMARY_TBL Type

Nested table type of dbms_cloud_oci_certificates_certificate_authority_bundle_version_summary_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_certificates_certificate_authority_bundle_version_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_certificates_certificate_authority_bundle_version_summary_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_CERTIFICATES_CERTIFICATE_AUTHORITY_BUNDLE_VERSION_COLLECTION_T Type

The results of a certificate authority (CA) version search. Results contain CA version summary objects and other data.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_certificates_certificate_authority_bundle_version_collection_t FORCE AUTHID CURRENT_USER IS OBJECT (
  items dbms_cloud_oci_certificates_certificate_authority_bundle_version_summary_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_certificates_certificate_authority_bundle_version_collection_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_certificates_certificate_authority_bundle_version_collection_t (
    items dbms_cloud_oci_certificates_certificate_authority_bundle_version_summary_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

items

(required) A list of CA version summary objects.

DBMS_CLOUD_OCI_CERTIFICATES_CERTIFICATE_BUNDLE_T Type

The contents of the certificate, properties of the certificate (and certificate version), and user-provided contextual metadata for the certificate.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_certificates_certificate_bundle_t FORCE AUTHID CURRENT_USER IS OBJECT (
  certificate_bundle_type varchar2(32767),
  certificate_id varchar2(32767),
  certificate_name varchar2(32767),
  version_number number,
  serial_number varchar2(32767),
  certificate_pem varchar2(32767),
  cert_chain_pem varchar2(32767),
  time_created timestamp with time zone,
  validity dbms_cloud_oci_certificates_validity_t,
  version_name varchar2(32767),
  stages dbms_cloud_oci_certificates_varchar2_tbl,
  revocation_status dbms_cloud_oci_certificates_revocation_status_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_certificates_certificate_bundle_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_certificates_certificate_bundle_t (
    certificate_bundle_type varchar2,
    certificate_id varchar2,
    certificate_name varchar2,
    version_number number,
    serial_number varchar2,
    certificate_pem varchar2,
    cert_chain_pem varchar2,
    time_created timestamp with time zone,
    validity dbms_cloud_oci_certificates_validity_t,
    version_name varchar2,
    stages dbms_cloud_oci_certificates_varchar2_tbl,
    revocation_status dbms_cloud_oci_certificates_revocation_status_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE NOT FINAL;

Fields

Field Description

certificate_bundle_type

(required) The type of certificate bundle, which indicates whether the private key fields are included.

Allowed values are: 'CERTIFICATE_CONTENT_PUBLIC_ONLY', 'CERTIFICATE_CONTENT_WITH_PRIVATE_KEY'

certificate_id

(required) The OCID of the certificate.

certificate_name

(required) The name of the certificate.

version_number

(required) The version number of the certificate.

serial_number

(required) A unique certificate identifier used in certificate revocation tracking, formatted as octets. Example: `03 AC FC FA CC B3 CB 02 B8 F8 DE F5 85 E7 7B FF`

certificate_pem

(optional) The certificate in PEM format.

cert_chain_pem

(optional) The certificate chain (in PEM format) for the certificate bundle.

time_created

(required) An optional property indicating when the certificate version was created, expressed in RFC 3339 timestamp format. Example: `2019-04-03T21:10:29.600Z`

validity

(required)

version_name

(optional) The name of the certificate version.

stages

(required) A list of rotation states for the certificate bundle.

Allowed values are: 'CURRENT', 'PENDING', 'LATEST', 'PREVIOUS', 'DEPRECATED', 'FAILED'

revocation_status

(optional)

DBMS_CLOUD_OCI_CERTIFICATES_CERTIFICATE_BUNDLE_PUBLIC_ONLY_T Type

A certificate bundle, not including the private key.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_certificates_certificate_bundle_public_only_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_certificates_certificate_bundle_t (
  CONSTRUCTOR FUNCTION dbms_cloud_oci_certificates_certificate_bundle_public_only_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_certificates_certificate_bundle_public_only_t (
    certificate_bundle_type varchar2,
    certificate_id varchar2,
    certificate_name varchar2,
    version_number number,
    serial_number varchar2,
    certificate_pem varchar2,
    cert_chain_pem varchar2,
    time_created timestamp with time zone,
    validity dbms_cloud_oci_certificates_validity_t,
    version_name varchar2,
    stages dbms_cloud_oci_certificates_varchar2_tbl,
    revocation_status dbms_cloud_oci_certificates_revocation_status_t
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_certificates_certificate_bundle_public_only_t is a subtype of the dbms_cloud_oci_certificates_certificate_bundle_t type.

DBMS_CLOUD_OCI_CERTIFICATES_CERTIFICATE_BUNDLE_VERSION_SUMMARY_T Type

The properties of the certificate bundle. Certificate bundle version summary objects do not include the actual contents of the certificate.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_certificates_certificate_bundle_version_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  certificate_id varchar2(32767),
  serial_number varchar2(32767),
  version_name varchar2(32767),
  certificate_name varchar2(32767),
  version_number number,
  time_created timestamp with time zone,
  validity dbms_cloud_oci_certificates_validity_t,
  time_of_deletion timestamp with time zone,
  stages dbms_cloud_oci_certificates_varchar2_tbl,
  revocation_status dbms_cloud_oci_certificates_revocation_status_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_certificates_certificate_bundle_version_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_certificates_certificate_bundle_version_summary_t (
    certificate_id varchar2,
    serial_number varchar2,
    version_name varchar2,
    certificate_name varchar2,
    version_number number,
    time_created timestamp with time zone,
    validity dbms_cloud_oci_certificates_validity_t,
    time_of_deletion timestamp with time zone,
    stages dbms_cloud_oci_certificates_varchar2_tbl,
    revocation_status dbms_cloud_oci_certificates_revocation_status_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

certificate_id

(required) The OCID of the certificate.

serial_number

(optional) A unique certificate identifier used in certificate revocation tracking, formatted as octets. Example: `03 AC FC FA CC B3 CB 02 B8 F8 DE F5 85 E7 7B FF`

version_name

(optional) The name of the certificate version.

certificate_name

(required) The name of the certificate.

version_number

(required) The version number of the certificate.

time_created

(required) An optional property indicating when the certificate version was created, expressed in RFC 3339 timestamp format. Example: `2019-04-03T21:10:29.600Z`

validity

(optional)

time_of_deletion

(optional) An optional property indicating when to delete the certificate version, expressed in RFC 3339 timestamp format. Example: `2019-04-03T21:10:29.600Z`

stages

(required) A list of rotation states for this certificate bundle version.

Allowed values are: 'CURRENT', 'PENDING', 'LATEST', 'PREVIOUS', 'DEPRECATED', 'FAILED'

revocation_status

(optional)

DBMS_CLOUD_OCI_CERTIFICATES_CERTIFICATE_BUNDLE_VERSION_SUMMARY_TBL Type

Nested table type of dbms_cloud_oci_certificates_certificate_bundle_version_summary_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_certificates_certificate_bundle_version_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_certificates_certificate_bundle_version_summary_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_CERTIFICATES_CERTIFICATE_BUNDLE_VERSION_COLLECTION_T Type

The results of a certificate bundle versions search. Results contain certificate bundle version summary objects.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_certificates_certificate_bundle_version_collection_t FORCE AUTHID CURRENT_USER IS OBJECT (
  items dbms_cloud_oci_certificates_certificate_bundle_version_summary_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_certificates_certificate_bundle_version_collection_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_certificates_certificate_bundle_version_collection_t (
    items dbms_cloud_oci_certificates_certificate_bundle_version_summary_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

items

(required) A list of certificate bundle version summary objects.

DBMS_CLOUD_OCI_CERTIFICATES_CERTIFICATE_BUNDLE_WITH_PRIVATE_KEY_T Type

A certificate bundle, including the private key.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_certificates_certificate_bundle_with_private_key_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_certificates_certificate_bundle_t (
  private_key_pem varchar2(32767),
  private_key_pem_passphrase varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_certificates_certificate_bundle_with_private_key_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_certificates_certificate_bundle_with_private_key_t (
    certificate_bundle_type varchar2,
    certificate_id varchar2,
    certificate_name varchar2,
    version_number number,
    serial_number varchar2,
    certificate_pem varchar2,
    cert_chain_pem varchar2,
    time_created timestamp with time zone,
    validity dbms_cloud_oci_certificates_validity_t,
    version_name varchar2,
    stages dbms_cloud_oci_certificates_varchar2_tbl,
    revocation_status dbms_cloud_oci_certificates_revocation_status_t,
    private_key_pem varchar2,
    private_key_pem_passphrase varchar2
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_certificates_certificate_bundle_with_private_key_t is a subtype of the dbms_cloud_oci_certificates_certificate_bundle_t type.

Fields

Field Description

private_key_pem

(required) The private key (in PEM format) for the certificate.

private_key_pem_passphrase

(optional) An optional passphrase for the private key.

DBMS_CLOUD_OCI_CERTIFICATES_ERROR_T Type

An error.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_certificates_error_t FORCE AUTHID CURRENT_USER IS OBJECT (
  code varchar2(32767),
  message varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_certificates_error_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_certificates_error_t (
    code varchar2,
    message varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

code

(required) A short error code that defines the error, meant for programmatic parsing. See API Errors.

message

(required) A human-readable error string.

Was this article helpful?