Oracle Cloud Infrastructure Documentation

Secrets Common Types

DBMS_CLOUD_OCI_SECRETS_VARCHAR2_TBL Type

Nested table type of varchar2(32767).

Syntax

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

DBMS_CLOUD_OCI_SECRETS_SECRET_BUNDLE_CONTENT_DETAILS_T Type

The contents of the secret.

Syntax

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

Fields

Field Description

content_type

(required) The formatting type of the secret contents.

Allowed values are: 'BASE64'

DBMS_CLOUD_OCI_SECRETS_BASE64_SECRET_BUNDLE_CONTENT_DETAILS_T Type

The contents of the secret.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_secrets_base64_secret_bundle_content_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_secrets_secret_bundle_content_details_t (
  content varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_secrets_base64_secret_bundle_content_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_secrets_base64_secret_bundle_content_details_t (
    content_type varchar2,
    content varchar2
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_secrets_base64_secret_bundle_content_details_t is a subtype of the dbms_cloud_oci_secrets_secret_bundle_content_details_t type.

Fields

Field Description

content

(optional) The base64-encoded content of the secret.

DBMS_CLOUD_OCI_SECRETS_ERROR_T Type

An error.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_secrets_error_t FORCE AUTHID CURRENT_USER IS OBJECT (
  code varchar2(32767),
  message varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_secrets_error_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_secrets_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.

DBMS_CLOUD_OCI_SECRETS_SECRET_BUNDLE_T Type

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

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_secrets_secret_bundle_t FORCE AUTHID CURRENT_USER IS OBJECT (
  secret_id varchar2(32767),
  time_created timestamp with time zone,
  version_number number,
  version_name varchar2(32767),
  secret_bundle_content dbms_cloud_oci_secrets_secret_bundle_content_details_t,
  time_of_deletion timestamp with time zone,
  time_of_expiry timestamp with time zone,
  stages dbms_cloud_oci_secrets_varchar2_tbl,
  metadata json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_secrets_secret_bundle_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_secrets_secret_bundle_t (
    secret_id varchar2,
    time_created timestamp with time zone,
    version_number number,
    version_name varchar2,
    secret_bundle_content dbms_cloud_oci_secrets_secret_bundle_content_details_t,
    time_of_deletion timestamp with time zone,
    time_of_expiry timestamp with time zone,
    stages dbms_cloud_oci_secrets_varchar2_tbl,
    metadata json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

secret_id

(required) The OCID of the secret.

time_created

(optional) The time when the secret bundle was created.

version_number

(required) The version number of the secret.

version_name

(optional) The name of the secret version. Labels are unique across the different versions of a particular secret.

secret_bundle_content

(optional)

time_of_deletion

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

time_of_expiry

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

stages

(optional) A list of possible rotation states for the secret version.

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

metadata

(optional) Customer-provided contextual metadata for the secret.

DBMS_CLOUD_OCI_SECRETS_SECRET_BUNDLE_VERSION_SUMMARY_T Type

The properties of the secret bundle. (Secret bundle version summary objects do not include the actual contents of the secret.)

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_secrets_secret_bundle_version_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  secret_id varchar2(32767),
  time_created timestamp with time zone,
  version_number number,
  version_name varchar2(32767),
  time_of_deletion timestamp with time zone,
  time_of_expiry timestamp with time zone,
  stages dbms_cloud_oci_secrets_varchar2_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_secrets_secret_bundle_version_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_secrets_secret_bundle_version_summary_t (
    secret_id varchar2,
    time_created timestamp with time zone,
    version_number number,
    version_name varchar2,
    time_of_deletion timestamp with time zone,
    time_of_expiry timestamp with time zone,
    stages dbms_cloud_oci_secrets_varchar2_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

secret_id

(required) The OCID of the secret.

time_created

(optional) The time when the secret bundle was created.

version_number

(required) The version number of the secret.

version_name

(optional) The version name of the secret bundle, as provided when the secret was created or last rotated.

time_of_deletion

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

time_of_expiry

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

stages

(optional) A list of possible rotation states for the secret bundle.

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