Oracle Cloud Infrastructure Documentation

Access Governance CP Common Types

DBMS_CLOUD_OCI_ACCESS_GOVERNANCE_CP_VARCHAR2_TBL Type

Nested table type of varchar2(32767).

Syntax

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

DBMS_CLOUD_OCI_ACCESS_GOVERNANCE_CP_CHANGE_GOVERNANCE_INSTANCE_COMPARTMENT_DETAILS_T Type

The details of a GovernanceInstance to be updated for a compartment change.

Syntax

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

Fields

Field Description

compartment_id

(required) The OCID of the compartment where the GovernanceInstance resides.

DBMS_CLOUD_OCI_ACCESS_GOVERNANCE_CP_CREATE_GOVERNANCE_INSTANCE_DETAILS_T Type

The details about a new GovernanceInstance.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_access_governance_cp_create_governance_instance_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  display_name varchar2(32767),
  description varchar2(32767),
  license_type varchar2(32767),
  tenancy_namespace varchar2(32767),
  compartment_id varchar2(32767),
  idcs_access_token varchar2(32767),
  defined_tags json_element_t,
  freeform_tags json_element_t,
  system_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_access_governance_cp_create_governance_instance_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_access_governance_cp_create_governance_instance_details_t (
    display_name varchar2,
    description varchar2,
    license_type varchar2,
    tenancy_namespace varchar2,
    compartment_id varchar2,
    idcs_access_token varchar2,
    defined_tags json_element_t,
    freeform_tags json_element_t,
    system_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

display_name

(required) The name for the GovernanceInstance.

description

(optional) The description of the GovernanceInstance.

license_type

(required) The licenseType being used.

Allowed values are: 'NEW_LICENSE', 'BRING_YOUR_OWN_LICENSE', 'AG_ORACLE_WORKLOADS', 'AG_OCI'

tenancy_namespace

(required) The namespace for tenancy object storage.

compartment_id

(required) The OCID of the compartment where the GovernanceInstance resides.

idcs_access_token

(required) IDCS access token identifying a stripe and service administrator user.

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`

freeform_tags

(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`

system_tags

(optional) Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`

DBMS_CLOUD_OCI_ACCESS_GOVERNANCE_CP_ERROR_T Type

Error Information.

Syntax

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

message

(required) A human-readable error string.

DBMS_CLOUD_OCI_ACCESS_GOVERNANCE_CP_GOVERNANCE_INSTANCE_T Type

The details of a GovenanceInstance.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_access_governance_cp_governance_instance_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  display_name varchar2(32767),
  compartment_id varchar2(32767),
  time_created timestamp with time zone,
  time_updated timestamp with time zone,
  lifecycle_state varchar2(32767),
  description varchar2(32767),
  license_type varchar2(32767),
  tenancy_namespace varchar2(32767),
  instance_url varchar2(32767),
  defined_tags json_element_t,
  freeform_tags json_element_t,
  system_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_access_governance_cp_governance_instance_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_access_governance_cp_governance_instance_t (
    id varchar2,
    display_name varchar2,
    compartment_id varchar2,
    time_created timestamp with time zone,
    time_updated timestamp with time zone,
    lifecycle_state varchar2,
    description varchar2,
    license_type varchar2,
    tenancy_namespace varchar2,
    instance_url varchar2,
    defined_tags json_element_t,
    freeform_tags json_element_t,
    system_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(optional) The unique OCID of the GovernanceInstance.

display_name

(required) The name for the GovernanceInstance.

compartment_id

(required) The OCID of the compartment where the GovernanceInstance resides.

time_created

(required) The time the the GovernanceInstance was created in an RFC3339 formatted datetime string.

time_updated

(optional) The time the GovernanceInstance was updated in an RFC3339 formatted datetime string.

lifecycle_state

(required) The current state of the GovernanceInstance.

Allowed values are: 'CREATING', 'ACTIVE', 'DELETING', 'DELETED', 'NEEDS_ATTENTION'

description

(optional) The description of the GovernanceInstance.

license_type

(optional) The licenseType being used.

Allowed values are: 'NEW_LICENSE', 'BRING_YOUR_OWN_LICENSE', 'AG_ORACLE_WORKLOADS', 'AG_OCI'

tenancy_namespace

(optional) The namespace for tenancy object storage.

instance_url

(optional) The access URL of the GovernanceInstance.

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`

freeform_tags

(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`

system_tags

(optional) Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`

DBMS_CLOUD_OCI_ACCESS_GOVERNANCE_CP_GOVERNANCE_INSTANCE_SUMMARY_T Type

The summary of an GovernanceInstance.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_access_governance_cp_governance_instance_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  display_name varchar2(32767),
  description varchar2(32767),
  compartment_id varchar2(32767),
  time_created timestamp with time zone,
  time_updated timestamp with time zone,
  lifecycle_state varchar2(32767),
  license_type varchar2(32767),
  instance_url varchar2(32767),
  defined_tags json_element_t,
  freeform_tags json_element_t,
  system_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_access_governance_cp_governance_instance_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_access_governance_cp_governance_instance_summary_t (
    id varchar2,
    display_name varchar2,
    description varchar2,
    compartment_id varchar2,
    time_created timestamp with time zone,
    time_updated timestamp with time zone,
    lifecycle_state varchar2,
    license_type varchar2,
    instance_url varchar2,
    defined_tags json_element_t,
    freeform_tags json_element_t,
    system_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(optional) The unique OCID of the GovernanceInstance.

display_name

(required) The name for the GovernanceInstance.

description

(optional) The description of the GovernanceInstance.

compartment_id

(required) The OCID of the compartment where the GovernanceInstance resides.

time_created

(required) The time the the GovernanceInstance was created in an RFC3339 formatted datetime string.

time_updated

(optional) The time the GovernanceInstance was updated in an RFC3339 formatted datetime string.

lifecycle_state

(required) The current state of the GovernanceInstance.

Allowed values are: 'CREATING', 'ACTIVE', 'DELETING', 'DELETED', 'NEEDS_ATTENTION'

license_type

(optional) The licenseType being used.

Allowed values are: 'NEW_LICENSE', 'BRING_YOUR_OWN_LICENSE', 'AG_ORACLE_WORKLOADS', 'AG_OCI'

instance_url

(optional) The access URL of the GovernanceInstance.

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`

freeform_tags

(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`

system_tags

(optional) Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`

DBMS_CLOUD_OCI_ACCESS_GOVERNANCE_CP_GOVERNANCE_INSTANCE_SUMMARY_TBL Type

Nested table type of dbms_cloud_oci_access_governance_cp_governance_instance_summary_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_access_governance_cp_governance_instance_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_access_governance_cp_governance_instance_summary_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_ACCESS_GOVERNANCE_CP_GOVERNANCE_INSTANCE_COLLECTION_T Type

Results of a GovernanceInstance search.

Syntax

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

Fields

Field Description

items

(required) List of GovernanceInstances.

DBMS_CLOUD_OCI_ACCESS_GOVERNANCE_CP_SENDER_CONFIG_T Type

The sender information for email notifications sent by GovernanceInstance.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_access_governance_cp_sender_config_t FORCE AUTHID CURRENT_USER IS OBJECT (
  display_name varchar2(32767),
  email varchar2(32767),
  is_verified number,
  time_verify_response_expiry timestamp with time zone,
  is_inbox_configured number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_access_governance_cp_sender_config_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_access_governance_cp_sender_config_t (
    display_name varchar2,
    email varchar2,
    is_verified number,
    time_verify_response_expiry timestamp with time zone,
    is_inbox_configured number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

display_name

(optional) The sender's displayName.

email

(optional) The sender's email.

is_verified

(optional) Whether or not the sender's email has been verified.

time_verify_response_expiry

(optional) The time when the verify response needs to be received by.

is_inbox_configured

(optional) Whether the sender email has inbox configured to receive emails.

DBMS_CLOUD_OCI_ACCESS_GOVERNANCE_CP_GOVERNANCE_INSTANCE_CONFIGURATION_T Type

The tenancy-wide configuration for GovernanceInstances.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_access_governance_cp_governance_instance_configuration_t FORCE AUTHID CURRENT_USER IS OBJECT (
  sender_info dbms_cloud_oci_access_governance_cp_sender_config_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_access_governance_cp_governance_instance_configuration_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_access_governance_cp_governance_instance_configuration_t (
    sender_info dbms_cloud_oci_access_governance_cp_sender_config_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

sender_info

(required)

DBMS_CLOUD_OCI_ACCESS_GOVERNANCE_CP_UPDATE_SENDER_CONFIG_T Type

Update to a sender information for email notifications sent by GovernanceInstance.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_access_governance_cp_update_sender_config_t FORCE AUTHID CURRENT_USER IS OBJECT (
  display_name varchar2(32767),
  email varchar2(32767),
  is_inbox_configured number,
  is_resend_notification_email number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_access_governance_cp_update_sender_config_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_access_governance_cp_update_sender_config_t (
    display_name varchar2,
    email varchar2,
    is_inbox_configured number,
    is_resend_notification_email number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

display_name

(optional) The sender's displayName.

email

(required) The sender's email.

is_inbox_configured

(required) Whether the sender email has inbox configured to receive emails.

is_resend_notification_email

(optional) Whether there is a need to resend the verification email.

DBMS_CLOUD_OCI_ACCESS_GOVERNANCE_CP_UPDATE_GOVERNANCE_INSTANCE_CONFIGURATION_DETAILS_T Type

The details of a tenancy-wide configuration for GovernanceInstances to be updated.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_access_governance_cp_update_governance_instance_configuration_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  sender_info dbms_cloud_oci_access_governance_cp_update_sender_config_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_access_governance_cp_update_governance_instance_configuration_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_access_governance_cp_update_governance_instance_configuration_details_t (
    sender_info dbms_cloud_oci_access_governance_cp_update_sender_config_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

sender_info

(optional)

DBMS_CLOUD_OCI_ACCESS_GOVERNANCE_CP_UPDATE_GOVERNANCE_INSTANCE_DETAILS_T Type

The details of a GovernanceInstance to be updated.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_access_governance_cp_update_governance_instance_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  display_name varchar2(32767),
  description varchar2(32767),
  license_type varchar2(32767),
  defined_tags json_element_t,
  freeform_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_access_governance_cp_update_governance_instance_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_access_governance_cp_update_governance_instance_details_t (
    display_name varchar2,
    description varchar2,
    license_type varchar2,
    defined_tags json_element_t,
    freeform_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

display_name

(optional) The name for the GovernanceInstance.

description

(optional) The description of the GovernanceInstance.

license_type

(optional) The licenseType being used.

Allowed values are: 'NEW_LICENSE', 'BRING_YOUR_OWN_LICENSE', 'AG_ORACLE_WORKLOADS', 'AG_OCI'

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`

freeform_tags

(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`