Oracle Cloud Infrastructure Documentation
Try Free Tier

Audit Common Types

DBMS_CLOUD_OCI_AUDIT_VARCHAR2_TBL Type

Nested table type of varchar2(32767).

Syntax

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

DBMS_CLOUD_OCI_AUDIT_IDENTITY_T Type

A container object for identity attributes.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_audit_identity_t FORCE AUTHID CURRENT_USER IS OBJECT (
  principal_name varchar2(32767),
  principal_id varchar2(32767),
  auth_type varchar2(32767),
  caller_name varchar2(32767),
  caller_id varchar2(32767),
  tenant_id varchar2(32767),
  ip_address varchar2(32767),
  credentials varchar2(32767),
  user_agent varchar2(32767),
  console_session_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_audit_identity_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_audit_identity_t (
    principal_name varchar2,
    principal_id varchar2,
    auth_type varchar2,
    caller_name varchar2,
    caller_id varchar2,
    tenant_id varchar2,
    ip_address varchar2,
    credentials varchar2,
    user_agent varchar2,
    console_session_id varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

principal_name

(optional) The name of the user or service. This value is the friendly name associated with `principalId`. Example: `ExampleName`

principal_id

(optional) The OCID of the principal.

auth_type

(optional) The type of authentication used. Example: `natv`

caller_name

(optional) The name of the user or service. This value is the friendly name associated with `callerId`.

caller_id

(optional) The OCID of the caller. The caller that made a request on behalf of the prinicpal.

tenant_id

(optional) The OCID of the tenant.

ip_address

(optional) The IP address of the source of the request. Example: `172.24.80.88`

credentials

(optional) The credential ID of the user. This value is extracted from the HTTP 'Authorization' request header. It consists of the tenantId, userId, and user fingerprint, all delimited by a slash (/).

user_agent

(optional) The user agent of the client that made the request. Example: `Jersey/2.23 (HttpUrlConnection 1.8.0_212)`

console_session_id

(optional) This value identifies any Console session associated with this request.

DBMS_CLOUD_OCI_AUDIT_REQUEST_T Type

A container object for request attributes.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_audit_request_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  path varchar2(32767),
  action varchar2(32767),
  parameters json_element_t,
  headers json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_audit_request_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_audit_request_t (
    id varchar2,
    path varchar2,
    action varchar2,
    parameters json_element_t,
    headers json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(optional) The opc-request-id of the request.

path

(optional) The full path of the API request. Example: `/20160918/instances/ocid1.instance.oc1.phx.<unique_ID>`

action

(optional) The HTTP method of the request. Example: `GET`

parameters

(optional) The parameters supplied by the caller during this operation.

headers

(optional) The HTTP header fields and values in the request. Example: ----- { \"opc-principal\": [ \"{\\\"tenantId\\\":\\\"ocid1.tenancy.oc1..<unique_ID>\\\",\\\"subjectId\\\":\\\"ocid1.user.oc1..<unique_ID>\\\",\\\"claims\\\":[{\\\"key\\\":\\\"pstype\\\",\\\"value\\\":\\\"natv\\\",\\\"issuer\\\":\\\"authService.oracle.com\\\"},{\\\"key\\\":\\\"h_host\\\",\\\"value\\\":\\\"iaas.r2.oracleiaas.com\\\",\\\"issuer\\\":\\\"h\\\"},{\\\"key\\\":\\\"h_opc-request-id\\\",\\\"value\\\":\\\"<unique_ID>\\\",\\\"issuer\\\":\\\"h\\\"},{\\\"key\\\":\\\"ptype\\\",\\\"value\\\":\\\"user\\\",\\\"issuer\\\":\\\"authService.oracle.com\\\"},{\\\"key\\\":\\\"h_date\\\",\\\"value\\\":\\\"Wed, 18 Sep 2019 00:10:58 UTC\\\",\\\"issuer\\\":\\\"h\\\"},{\\\"key\\\":\\\"h_accept\\\",\\\"value\\\":\\\"application/json\\\",\\\"issuer\\\":\\\"h\\\"},{\\\"key\\\":\\\"authorization\\\",\\\"value\\\":\\\"Signature headers=\\\\\\\"date (request-target) host accept opc-request-id\\\\\\\",keyId=\\\\\\\"ocid1.tenancy.oc1..<unique_ID>/ocid1.user.oc1..<unique_ID>/8c:b4:5f:18:e7:ec:db:08:b8:fa:d2:2a:7d:11:76:ac\\\\\\\",algorithm=\\\\\\\"rsa-pss-sha256\\\\\\\",signature=\\\\\\\"<unique_ID>\\\\\\\",version=\\\\\\\"1\\\\\\\"\\\",\\\"issuer\\\":\\\"h\\\"},{\\\"key\\\":\\\"h_(request-target)\\\",\\\"value\\\":\\\"get /20160918/instances/ocid1.instance.oc1.phx.<unique_ID>\\\",\\\"issuer\\\":\\\"h\\\"}]}\" ], \"Accept\": [ \"application/json\" ], \"X-Oracle-Auth-Client-CN\": [ \"splat-proxy-se-02302.node.ad2.r2\" ], \"X-Forwarded-Host\": [ \"compute-api.svc.ad1.r2\" ], \"Connection\": [ \"close\" ], \"User-Agent\": [ \"Jersey/2.23 (HttpUrlConnection 1.8.0_212)\" ], \"X-Forwarded-For\": [ \"172.24.80.88\" ], \"X-Real-IP\": [ \"172.24.80.88\" ], \"oci-original-url\": [ \"https://iaas.r2.oracleiaas.com/20160918/instances/ocid1.instance.oc1.phx.<unique_ID>\" ], \"opc-request-id\": [ \"<unique_ID>\" ], \"Date\": [ \"Wed, 18 Sep 2019 00:10:58 UTC\" ] } -----

DBMS_CLOUD_OCI_AUDIT_RESPONSE_T Type

A container object for response attributes.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_audit_response_t FORCE AUTHID CURRENT_USER IS OBJECT (
  status varchar2(32767),
  response_time timestamp with time zone,
  headers json_element_t,
  payload json_element_t,
  message varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_audit_response_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_audit_response_t (
    status varchar2,
    response_time timestamp with time zone,
    headers json_element_t,
    payload json_element_t,
    message varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

status

(optional) The status code of the response. Example: `200`

response_time

(optional) The time of the response to the audited request, expressed in RFC 3339 timestamp format. Example: `2019-09-18T00:10:59.278Z`

headers

(optional) The headers of the response. Example: ----- { \"ETag\": [ \"<unique_ID>\" ], \"Connection\": [ \"close\" ], \"Content-Length\": [ \"1828\" ], \"opc-request-id\": [ \"<unique_ID>\" ], \"Date\": [ \"Wed, 18 Sep 2019 00:10:59 GMT\" ], \"Content-Type\": [ \"application/json\" ] } -----

payload

(optional) This value is included for backward compatibility with the Audit version 1 schema, where it contained metadata of interest from the response payload. Example: ----- { \"resourceName\": \"my_instance\", \"id\": \"ocid1.instance.oc1.phx.<unique_ID>\" } -----

message

(optional) A friendly description of what happened during the operation. Use this for troubleshooting.

DBMS_CLOUD_OCI_AUDIT_STATE_CHANGE_T Type

A container object for state change attributes.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_audit_state_change_t FORCE AUTHID CURRENT_USER IS OBJECT (
  previous json_element_t,
  l_current json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_audit_state_change_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_audit_state_change_t (
    previous json_element_t,
    l_current json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

previous

(optional) Provides the previous state of fields that may have changed during an operation. To determine how the current operation changed a resource, compare the information in this attribute to `current`.

l_current

(optional) Provides the current state of fields that may have changed during an operation. To determine how the current operation changed a resource, compare the information in this attribute to `previous`.

DBMS_CLOUD_OCI_AUDIT_DATA_T Type

The payload of the event. Information within `data` comes from the resource emitting the event.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_audit_data_t FORCE AUTHID CURRENT_USER IS OBJECT (
  event_grouping_id varchar2(32767),
  event_name varchar2(32767),
  compartment_id varchar2(32767),
  compartment_name varchar2(32767),
  resource_name varchar2(32767),
  resource_id varchar2(32767),
  availability_domain varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  identity dbms_cloud_oci_audit_identity_t,
  request dbms_cloud_oci_audit_request_t,
  response dbms_cloud_oci_audit_response_t,
  state_change dbms_cloud_oci_audit_state_change_t,
  additional_details json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_audit_data_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_audit_data_t (
    event_grouping_id varchar2,
    event_name varchar2,
    compartment_id varchar2,
    compartment_name varchar2,
    resource_name varchar2,
    resource_id varchar2,
    availability_domain varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    identity dbms_cloud_oci_audit_identity_t,
    request dbms_cloud_oci_audit_request_t,
    response dbms_cloud_oci_audit_response_t,
    state_change dbms_cloud_oci_audit_state_change_t,
    additional_details json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

event_grouping_id

(optional) This value links multiple audit events that are part of the same API operation. For example, a long running API operations that emit an event at the start and the end of an operation would use the same value in this field for both events.

event_name

(optional) Name of the API operation that generated this event. Example: `GetInstance`

compartment_id

(optional) The OCID of the compartment of the resource emitting the event.

compartment_name

(optional) The name of the compartment. This value is the friendly name associated with compartmentId. This value can change, but the service logs the value that appeared at the time of the audit event. Example: `CompartmentA`

resource_name

(optional) The name of the resource emitting the event.

resource_id

(optional) An OCID or some other ID for the resource emitting the event.

availability_domain

(optional) The availability domain where the resource resides.

freeform_tags

(optional) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Exists for cross-compatibility only. For more information, see Resource Tags. Example: `{\"Department\": \"Finance\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`

identity

(optional)

request

(optional)

response

(optional)

state_change

(optional)

additional_details

(optional) A container object for attribues unique to the resource emitting the event. Example: ----- { \"imageId\": \"ocid1.image.oc1.phx.<unique_ID>\", \"shape\": \"VM.Standard1.1\", \"type\": \"CustomerVmi\" } -----

DBMS_CLOUD_OCI_AUDIT_AUDIT_EVENT_T Type

All the attributes of an audit event. For more information, see Viewing Audit Log Events.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_audit_audit_event_t FORCE AUTHID CURRENT_USER IS OBJECT (
  event_type varchar2(32767),
  cloud_events_version varchar2(32767),
  event_type_version varchar2(32767),
  source varchar2(32767),
  event_id varchar2(32767),
  event_time timestamp with time zone,
  content_type varchar2(32767),
  data dbms_cloud_oci_audit_data_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_audit_audit_event_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_audit_audit_event_t (
    event_type varchar2,
    cloud_events_version varchar2,
    event_type_version varchar2,
    source varchar2,
    event_id varchar2,
    event_time timestamp with time zone,
    content_type varchar2,
    data dbms_cloud_oci_audit_data_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

event_type

(required) The type of event that happened. The service that produces the event can also add, remove, or change the meaning of a field. A service implementing these type changes would publish a new version of an `eventType` and revise the `eventTypeVersion` field. Example: `com.oraclecloud.ComputeApi.GetInstance`

cloud_events_version

(required) The version of the CloudEvents specification. The structure of the envelope follows the CloudEvents industry standard format hosted by the Cloud Native Computing Foundation ( CNCF). Audit uses version 0.1 specification of the CloudEvents event envelope. Example: `0.1`

event_type_version

(required) The version of the event type. This version applies to the payload of the event, not the envelope. Use `cloudEventsVersion` to determine the version of the envelope. Example: `2.0`

source

(required) The source of the event. Example: `ComputeApi`

event_id

(required) The GUID of the event.

event_time

(required) The time the event occurred, expressed in RFC 3339 timestamp format. Example: `2019-09-18T00:10:59.252Z`

content_type

(required) The content type of the data contained in `data`. Example: `application/json`

data

(required)

DBMS_CLOUD_OCI_AUDIT_CONFIGURATION_T Type

The retention period setting, specified in days. For more information, see Setting Audit Log Retention Period.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_audit_configuration_t FORCE AUTHID CURRENT_USER IS OBJECT (
  retention_period_days number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_audit_configuration_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_audit_configuration_t (
    retention_period_days number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

retention_period_days

(optional) The retention period setting, specified in days. The minimum is 90, the maximum 365. Example: `90`

DBMS_CLOUD_OCI_AUDIT_ERROR_T Type

Syntax

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

message

(required) A human-readable error string. Example: `InvalidParameter`

DBMS_CLOUD_OCI_AUDIT_UPDATE_CONFIGURATION_DETAILS_T Type

The configuration details for the retention period setting, specified in days. For more information, see Setting Audit Log Retention Period.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_audit_update_configuration_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  retention_period_days number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_audit_update_configuration_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_audit_update_configuration_details_t (
    retention_period_days number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

retention_period_days

(required) The retention period setting, specified in days. The minimum is 90, the maximum 365. Example: `90`

Was this article helpful?