AuditEventSummary¶
- class oci.data_safe.models.AuditEventSummary(**kwargs)¶
Bases:
objectThe resource represents the audit events collected from the target database by Oracle Data Safe.
Attributes:
A constant which can be used with the audit_location property of a AuditEventSummary.
A constant which can be used with the audit_type property of a AuditEventSummary.
A constant which can be used with the audit_type property of a AuditEventSummary.
A constant which can be used with the audit_type property of a AuditEventSummary.
A constant which can be used with the audit_type property of a AuditEventSummary.
A constant which can be used with the audit_type property of a AuditEventSummary.
A constant which can be used with the audit_type property of a AuditEventSummary.
A constant which can be used with the audit_type property of a AuditEventSummary.
A constant which can be used with the audit_type property of a AuditEventSummary.
A constant which can be used with the database_type property of a AuditEventSummary.
A constant which can be used with the database_type property of a AuditEventSummary.
A constant which can be used with the database_type property of a AuditEventSummary.
A constant which can be used with the operation_status property of a AuditEventSummary.
A constant which can be used with the operation_status property of a AuditEventSummary.
A constant which can be used with the target_class property of a AuditEventSummary.
A constant which can be used with the trail_source property of a AuditEventSummary.
A constant which can be used with the trail_source property of a AuditEventSummary.
Gets the action_taken of this AuditEventSummary.
Gets the application_contexts of this AuditEventSummary.
[Required] Gets the audit_event_time of this AuditEventSummary.
Gets the audit_location of this AuditEventSummary.
Gets the audit_policies of this AuditEventSummary.
Gets the audit_trail_id of this AuditEventSummary.
Gets the audit_type of this AuditEventSummary.
Gets the client_hostname of this AuditEventSummary.
Gets the client_id of this AuditEventSummary.
Gets the client_ip of this AuditEventSummary.
Gets the client_program of this AuditEventSummary.
Gets the command_param of this AuditEventSummary.
Gets the command_text of this AuditEventSummary.
[Required] Gets the compartment_id of this AuditEventSummary.
[Required] Gets the database_type of this AuditEventSummary. The type of the target database that was audited. Allowed values are - DATABASE_CLOUD_SERVICE - Represents Oracle Database Cloud Services. - AUTONOMOUS_DATABASE - Represents Oracle Autonomous Databases. - INSTALLED_DATABASE - Represents databases running on-premises or on compute instances.
Gets the database_unique_name of this AuditEventSummary.
Gets the db_user_name of this AuditEventSummary.
Gets the defined_tags of this AuditEventSummary.
Gets the error_code of this AuditEventSummary.
Gets the error_message of this AuditEventSummary.
Gets the event_name of this AuditEventSummary.
Gets the extended_event_attributes of this AuditEventSummary.
Gets the external_user_id of this AuditEventSummary.
Gets the fga_policy_name of this AuditEventSummary.
Gets the freeform_tags of this AuditEventSummary.
[Required] Gets the id of this AuditEventSummary.
[Required] Gets the is_alerted of this AuditEventSummary.
Gets the object_name of this AuditEventSummary.
Gets the object_owner of this AuditEventSummary.
Gets the object_type of this AuditEventSummary.
Gets the operation of this AuditEventSummary.
Gets the operation_status of this AuditEventSummary.
Gets the os_terminal of this AuditEventSummary.
Gets the os_user_name of this AuditEventSummary.
Gets the peer_target_database_key of this AuditEventSummary.
Gets the target_class of this AuditEventSummary.
[Required] Gets the target_id of this AuditEventSummary.
[Required] Gets the target_name of this AuditEventSummary.
Gets the target_user of this AuditEventSummary.
[Required] Gets the time_collected of this AuditEventSummary.
Gets the trail_source of this AuditEventSummary.
Methods:
__init__(**kwargs)Initializes a new AuditEventSummary object with values from keyword arguments.
- AUDIT_LOCATION_AUDIT_TABLE = 'AUDIT_TABLE'¶
A constant which can be used with the audit_location property of a AuditEventSummary. This constant has a value of “AUDIT_TABLE”
- AUDIT_TYPE_DATABASE_VAULT = 'DATABASE_VAULT'¶
A constant which can be used with the audit_type property of a AuditEventSummary. This constant has a value of “DATABASE_VAULT”
- AUDIT_TYPE_DATAPUMP = 'DATAPUMP'¶
A constant which can be used with the audit_type property of a AuditEventSummary. This constant has a value of “DATAPUMP”
- AUDIT_TYPE_DIRECT_PATH_API = 'DIRECT_PATH_API'¶
A constant which can be used with the audit_type property of a AuditEventSummary. This constant has a value of “DIRECT_PATH_API”
- AUDIT_TYPE_FINE_GRAINED = 'FINE_GRAINED'¶
A constant which can be used with the audit_type property of a AuditEventSummary. This constant has a value of “FINE_GRAINED”
- AUDIT_TYPE_LABEL_SECURITY = 'LABEL_SECURITY'¶
A constant which can be used with the audit_type property of a AuditEventSummary. This constant has a value of “LABEL_SECURITY”
- AUDIT_TYPE_RMAN = 'RMAN'¶
A constant which can be used with the audit_type property of a AuditEventSummary. This constant has a value of “RMAN”
- AUDIT_TYPE_STANDARD = 'STANDARD'¶
A constant which can be used with the audit_type property of a AuditEventSummary. This constant has a value of “STANDARD”
- AUDIT_TYPE_XS = 'XS'¶
A constant which can be used with the audit_type property of a AuditEventSummary. This constant has a value of “XS”
- DATABASE_TYPE_AUTONOMOUS_DATABASE = 'AUTONOMOUS_DATABASE'¶
A constant which can be used with the database_type property of a AuditEventSummary. This constant has a value of “AUTONOMOUS_DATABASE”
- DATABASE_TYPE_DATABASE_CLOUD_SERVICE = 'DATABASE_CLOUD_SERVICE'¶
A constant which can be used with the database_type property of a AuditEventSummary. This constant has a value of “DATABASE_CLOUD_SERVICE”
- DATABASE_TYPE_INSTALLED_DATABASE = 'INSTALLED_DATABASE'¶
A constant which can be used with the database_type property of a AuditEventSummary. This constant has a value of “INSTALLED_DATABASE”
- OPERATION_STATUS_FAILURE = 'FAILURE'¶
A constant which can be used with the operation_status property of a AuditEventSummary. This constant has a value of “FAILURE”
- OPERATION_STATUS_SUCCESS = 'SUCCESS'¶
A constant which can be used with the operation_status property of a AuditEventSummary. This constant has a value of “SUCCESS”
- TARGET_CLASS_DATABASE = 'DATABASE'¶
A constant which can be used with the target_class property of a AuditEventSummary. This constant has a value of “DATABASE”
- TRAIL_SOURCE_FILE = 'FILE'¶
A constant which can be used with the trail_source property of a AuditEventSummary. This constant has a value of “FILE”
- TRAIL_SOURCE_TABLE = 'TABLE'¶
A constant which can be used with the trail_source property of a AuditEventSummary. This constant has a value of “TABLE”
- __init__(**kwargs)¶
Initializes a new AuditEventSummary object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):
- Parameters
id (str) – The value to assign to the id property of this AuditEventSummary.
compartment_id (str) – The value to assign to the compartment_id property of this AuditEventSummary.
db_user_name (str) – The value to assign to the db_user_name property of this AuditEventSummary.
target_id (str) – The value to assign to the target_id property of this AuditEventSummary.
target_name (str) – The value to assign to the target_name property of this AuditEventSummary.
database_type (str) – The value to assign to the database_type property of this AuditEventSummary. Allowed values for this property are: “DATABASE_CLOUD_SERVICE”, “AUTONOMOUS_DATABASE”, “INSTALLED_DATABASE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
target_class (str) – The value to assign to the target_class property of this AuditEventSummary. Allowed values for this property are: “DATABASE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
audit_event_time (datetime) – The value to assign to the audit_event_time property of this AuditEventSummary.
time_collected (datetime) – The value to assign to the time_collected property of this AuditEventSummary.
os_user_name (str) – The value to assign to the os_user_name property of this AuditEventSummary.
operation (str) – The value to assign to the operation property of this AuditEventSummary.
operation_status (str) – The value to assign to the operation_status property of this AuditEventSummary. Allowed values for this property are: “SUCCESS”, “FAILURE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
event_name (str) – The value to assign to the event_name property of this AuditEventSummary.
error_code (str) – The value to assign to the error_code property of this AuditEventSummary.
error_message (str) – The value to assign to the error_message property of this AuditEventSummary.
object_type (str) – The value to assign to the object_type property of this AuditEventSummary.
object_name (str) – The value to assign to the object_name property of this AuditEventSummary.
object_owner (str) – The value to assign to the object_owner property of this AuditEventSummary.
client_hostname (str) – The value to assign to the client_hostname property of this AuditEventSummary.
client_ip (str) – The value to assign to the client_ip property of this AuditEventSummary.
audit_trail_id (str) – The value to assign to the audit_trail_id property of this AuditEventSummary.
is_alerted (bool) – The value to assign to the is_alerted property of this AuditEventSummary.
action_taken (str) – The value to assign to the action_taken property of this AuditEventSummary.
client_program (str) – The value to assign to the client_program property of this AuditEventSummary.
command_text (str) – The value to assign to the command_text property of this AuditEventSummary.
command_param (str) – The value to assign to the command_param property of this AuditEventSummary.
extended_event_attributes (str) – The value to assign to the extended_event_attributes property of this AuditEventSummary.
audit_location (str) – The value to assign to the audit_location property of this AuditEventSummary. Allowed values for this property are: “AUDIT_TABLE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
os_terminal (str) – The value to assign to the os_terminal property of this AuditEventSummary.
client_id (str) – The value to assign to the client_id property of this AuditEventSummary.
audit_policies (str) – The value to assign to the audit_policies property of this AuditEventSummary.
audit_type (str) – The value to assign to the audit_type property of this AuditEventSummary. Allowed values for this property are: “STANDARD”, “FINE_GRAINED”, “XS”, “DATABASE_VAULT”, “LABEL_SECURITY”, “RMAN”, “DATAPUMP”, “DIRECT_PATH_API”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
external_user_id (str) – The value to assign to the external_user_id property of this AuditEventSummary.
target_user (str) – The value to assign to the target_user property of this AuditEventSummary.
peer_target_database_key (int) – The value to assign to the peer_target_database_key property of this AuditEventSummary.
trail_source (str) – The value to assign to the trail_source property of this AuditEventSummary. Allowed values for this property are: “TABLE”, “FILE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
database_unique_name (str) – The value to assign to the database_unique_name property of this AuditEventSummary.
application_contexts (str) – The value to assign to the application_contexts property of this AuditEventSummary.
fga_policy_name (str) – The value to assign to the fga_policy_name property of this AuditEventSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this AuditEventSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this AuditEventSummary.
- property action_taken¶
Gets the action_taken of this AuditEventSummary. The action taken for this audit event.
- Returns
The action_taken of this AuditEventSummary.
- Return type
str
- property application_contexts¶
Gets the application_contexts of this AuditEventSummary. Semicolon-seperated list of application context namespace, attribute, value information in (APPCTX_NSPACE,APPCTX_ATTRIBUTE=<value>) format.
- Returns
The application_contexts of this AuditEventSummary.
- Return type
str
- property audit_event_time¶
[Required] Gets the audit_event_time of this AuditEventSummary. The time that the audit event occurs in the target database.
- Returns
The audit_event_time of this AuditEventSummary.
- Return type
datetime
- property audit_location¶
Gets the audit_location of this AuditEventSummary. The location of the audit. Currently the value is audit table.
Allowed values for this property are: “AUDIT_TABLE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The audit_location of this AuditEventSummary.
- Return type
str
- property audit_policies¶
Gets the audit_policies of this AuditEventSummary. Comma-seperated list of audit policies that caused the current audit event.
- Returns
The audit_policies of this AuditEventSummary.
- Return type
str
- property audit_trail_id¶
Gets the audit_trail_id of this AuditEventSummary. The OCID of the audit trail that generated this audit event. To be noted, this field has been deprecated.
- Returns
The audit_trail_id of this AuditEventSummary.
- Return type
str
- property audit_type¶
Gets the audit_type of this AuditEventSummary. The type of the auditing.
Allowed values for this property are: “STANDARD”, “FINE_GRAINED”, “XS”, “DATABASE_VAULT”, “LABEL_SECURITY”, “RMAN”, “DATAPUMP”, “DIRECT_PATH_API”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The audit_type of this AuditEventSummary.
- Return type
str
- property client_hostname¶
Gets the client_hostname of this AuditEventSummary. The name of the host machine from which the session was spawned.
- Returns
The client_hostname of this AuditEventSummary.
- Return type
str
- property client_id¶
Gets the client_id of this AuditEventSummary. The client identifier in each Oracle session.
- Returns
The client_id of this AuditEventSummary.
- Return type
str
- property client_ip¶
Gets the client_ip of this AuditEventSummary. The IP address of the host machine from which the session was spawned.
- Returns
The client_ip of this AuditEventSummary.
- Return type
str
- property client_program¶
Gets the client_program of this AuditEventSummary. The application from which the audit event was generated. For example SQL Plus or SQL Developer.
- Returns
The client_program of this AuditEventSummary.
- Return type
str
- property command_param¶
Gets the command_param of this AuditEventSummary. List of bind variables associated with the command text.
- Returns
The command_param of this AuditEventSummary.
- Return type
str
- property command_text¶
Gets the command_text of this AuditEventSummary. The SQL associated with the audit event.
- Returns
The command_text of this AuditEventSummary.
- Return type
str
- property compartment_id¶
[Required] Gets the compartment_id of this AuditEventSummary. The OCID of the compartment containing the audit event. The compartment is the same as that of audit profile of the target database resource.
- Returns
The compartment_id of this AuditEventSummary.
- Return type
str
- property database_type¶
[Required] Gets the database_type of this AuditEventSummary. The type of the target database that was audited. Allowed values are
DATABASE_CLOUD_SERVICE - Represents Oracle Database Cloud Services.
AUTONOMOUS_DATABASE - Represents Oracle Autonomous Databases.
INSTALLED_DATABASE - Represents databases running on-premises or on compute instances.
Allowed values for this property are: “DATABASE_CLOUD_SERVICE”, “AUTONOMOUS_DATABASE”, “INSTALLED_DATABASE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The database_type of this AuditEventSummary.
- Return type
str
- property database_unique_name¶
Gets the database_unique_name of this AuditEventSummary. Unique name of the database associated to the peer target database.
- Returns
The database_unique_name of this AuditEventSummary.
- Return type
str
- property db_user_name¶
Gets the db_user_name of this AuditEventSummary. The name of the database user whose actions were audited.
- Returns
The db_user_name of this AuditEventSummary.
- Return type
str
- property defined_tags¶
Gets the defined_tags of this AuditEventSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {“Operations”: {“CostCenter”: “42”}}
- Returns
The defined_tags of this AuditEventSummary.
- Return type
dict(str, dict(str, object))
- property error_code¶
Gets the error_code of this AuditEventSummary. Oracle Error code generated by the action. Zero indicates the action was successful.
- Returns
The error_code of this AuditEventSummary.
- Return type
str
- property error_message¶
Gets the error_message of this AuditEventSummary. The detailed message on why the error occurred.
- Returns
The error_message of this AuditEventSummary.
- Return type
str
- property event_name¶
Gets the event_name of this AuditEventSummary. The name of the detail action executed by the user on the target database. For example ALTER SEQUENCE, CREATE TRIGGER or CREATE INDEX.
- Returns
The event_name of this AuditEventSummary.
- Return type
str
- property extended_event_attributes¶
Gets the extended_event_attributes of this AuditEventSummary. List of all other attributes of the audit event seperated by a colon other than the one returned in audit record.
- Returns
The extended_event_attributes of this AuditEventSummary.
- Return type
str
- property external_user_id¶
Gets the external_user_id of this AuditEventSummary. The user ID of the external user of the audit event.
- Returns
The external_user_id of this AuditEventSummary.
- Return type
str
- property fga_policy_name¶
Gets the fga_policy_name of this AuditEventSummary. Fine-grained auditing (FGA) policy name that generated this audit record.
- Returns
The fga_policy_name of this AuditEventSummary.
- Return type
str
- property freeform_tags¶
Gets the freeform_tags of this AuditEventSummary. Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags
Example: {“Department”: “Finance”}
- Returns
The freeform_tags of this AuditEventSummary.
- Return type
dict(str, str)
- property id¶
[Required] Gets the id of this AuditEventSummary. The OCID of the audit event.
- Returns
The id of this AuditEventSummary.
- Return type
str
- property is_alerted¶
[Required] Gets the is_alerted of this AuditEventSummary. Indicates whether an alert was raised for this audit event.
- Returns
The is_alerted of this AuditEventSummary.
- Return type
bool
- property object_name¶
Gets the object_name of this AuditEventSummary. The name of the object affected by the action.
- Returns
The object_name of this AuditEventSummary.
- Return type
str
- property object_owner¶
Gets the object_owner of this AuditEventSummary. The schema name of the object affected by the action.
- Returns
The object_owner of this AuditEventSummary.
- Return type
str
- property object_type¶
Gets the object_type of this AuditEventSummary. The type of the object in the source database affected by the action. For example PL/SQL, SYNONYM or PACKAGE BODY.
- Returns
The object_type of this AuditEventSummary.
- Return type
str
- property operation¶
Gets the operation of this AuditEventSummary. The name of the action executed by the user on the target database. For example ALTER, CREATE or DROP.
- Returns
The operation of this AuditEventSummary.
- Return type
str
- property operation_status¶
Gets the operation_status of this AuditEventSummary. Indicates whether the operation was a success or a failure.
Allowed values for this property are: “SUCCESS”, “FAILURE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The operation_status of this AuditEventSummary.
- Return type
str
- property os_terminal¶
Gets the os_terminal of this AuditEventSummary. The operating system terminal of the user session.
- Returns
The os_terminal of this AuditEventSummary.
- Return type
str
- property os_user_name¶
Gets the os_user_name of this AuditEventSummary. The name of the operating system user for the database session.
- Returns
The os_user_name of this AuditEventSummary.
- Return type
str
- property peer_target_database_key¶
Gets the peer_target_database_key of this AuditEventSummary. The secondary id assigned for the peer database registered with Data Safe.
- Returns
The peer_target_database_key of this AuditEventSummary.
- Return type
int
- property target_class¶
Gets the target_class of this AuditEventSummary. The class of the target that was audited.
Allowed values for this property are: “DATABASE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The target_class of this AuditEventSummary.
- Return type
str
- property target_id¶
[Required] Gets the target_id of this AuditEventSummary. The OCID of the target database that was audited.
- Returns
The target_id of this AuditEventSummary.
- Return type
str
- property target_name¶
[Required] Gets the target_name of this AuditEventSummary. The name of the target database that was audited.
- Returns
The target_name of this AuditEventSummary.
- Return type
str
- property target_user¶
Gets the target_user of this AuditEventSummary. The user on whom the GRANT/REVOKE/AUDIT/NOAUDIT statement was executed.
- Returns
The target_user of this AuditEventSummary.
- Return type
str
- property time_collected¶
[Required] Gets the time_collected of this AuditEventSummary. The timestamp when this audit event was collected from the target database by Data Safe.
- Returns
The time_collected of this AuditEventSummary.
- Return type
datetime
- property trail_source¶
Gets the trail_source of this AuditEventSummary. The underlying source of unified audit trail.
Allowed values for this property are: “TABLE”, “FILE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The trail_source of this AuditEventSummary.
- Return type
str