Class AuditEventSummary

The resource represents the audit events collected from the target database by Oracle Data Safe.

Inheritance

object

AuditEventSummary

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.DatasafeService.Models

Assembly: OCI.DotNetSDK.Datasafe.dll

Syntax

public class AuditEventSummary

Properties

ActionTaken

Declaration

[JsonProperty(PropertyName = "actionTaken")]
public string ActionTaken { get; set; }

Property Value

Type	Description
string	The action taken for this audit event.

ApplicationContexts

Declaration

[JsonProperty(PropertyName = "applicationContexts")]
public string ApplicationContexts { get; set; }

Property Value

Type	Description
string

AuditEventTime

Declaration

[Required(ErrorMessage = "AuditEventTime is required.")]
[JsonProperty(PropertyName = "auditEventTime")]
public DateTime? AuditEventTime { get; set; }

Property Value

Type	Description
DateTime?	The time that the audit event occurs in the target database.

Remarks

Required

AuditLocation

Declaration

[JsonProperty(PropertyName = "auditLocation")]
[JsonConverter(typeof(ResponseEnumConverter))]
public AuditEventSummary.AuditLocationEnum? AuditLocation { get; set; }

Property Value

Type	Description
AuditEventSummary.AuditLocationEnum?	The location of the audit. Currently the value is audit table.

AuditPolicies

Declaration

[JsonProperty(PropertyName = "auditPolicies")]
public string AuditPolicies { get; set; }

Property Value

Type	Description
string	Comma-seperated list of audit policies that caused the current audit event.

AuditTrailId

Declaration

[JsonProperty(PropertyName = "auditTrailId")]
public string AuditTrailId { get; set; }

Property Value

Type	Description
string	The OCID of the audit trail that generated this audit event. To be noted, this field has been deprecated.

AuditType

Declaration

[JsonProperty(PropertyName = "auditType")]
[JsonConverter(typeof(ResponseEnumConverter))]
public AuditEventSummary.AuditTypeEnum? AuditType { get; set; }

Property Value

Type	Description
AuditEventSummary.AuditTypeEnum?	The type of the auditing.

ClientHostname

Declaration

[JsonProperty(PropertyName = "clientHostname")]
public string ClientHostname { get; set; }

Property Value

Type	Description
string	The name of the host machine from which the session was spawned.

ClientId

Declaration

[JsonProperty(PropertyName = "clientId")]
public string ClientId { get; set; }

Property Value

Type	Description
string	The client identifier in each Oracle session.

ClientIp

Declaration

[JsonProperty(PropertyName = "clientIp")]
public string ClientIp { get; set; }

Property Value

Type	Description
string	The IP address of the host machine from which the session was spawned.

ClientProgram

Declaration

[JsonProperty(PropertyName = "clientProgram")]
public string ClientProgram { get; set; }

Property Value

Type	Description
string	The application from which the audit event was generated. For example SQL Plus or SQL Developer.

CommandParam

Declaration

[JsonProperty(PropertyName = "commandParam")]
public string CommandParam { get; set; }

Property Value

Type	Description
string	List of bind variables associated with the command text.

CommandText

Declaration

[JsonProperty(PropertyName = "commandText")]
public string CommandText { get; set; }

Property Value

Type	Description
string	The SQL associated with the audit event.

CompartmentId

Declaration

[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }

Property Value

Type	Description
string	The OCID of the compartment containing the audit event. The compartment is the same as that of audit profile of the target database resource.

Remarks

Required

DatabaseType

Declaration

[Required(ErrorMessage = "DatabaseType is required.")]
[JsonProperty(PropertyName = "databaseType")]
[JsonConverter(typeof(ResponseEnumConverter))]
public AuditEventSummary.DatabaseTypeEnum? DatabaseType { get; set; }

Property Value

Type	Description
AuditEventSummary.DatabaseTypeEnum?	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.

Type

Description

AuditEventSummary.DatabaseTypeEnum?

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.

Remarks

Required

DatabaseUniqueName

Declaration

[JsonProperty(PropertyName = "databaseUniqueName")]
public string DatabaseUniqueName { get; set; }

Property Value

Type	Description
string	Unique name of the database associated to the peer target database.

DbUserName

Declaration

[JsonProperty(PropertyName = "dbUserName")]
public string DbUserName { get; set; }

Property Value

Type	Description
string	The name of the database user whose actions were audited.

DefinedTags

Declaration

[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }

Property Value

Type	Description
Dictionary<string, Dictionary<string, object>>	Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations": {"CostCenter": "42"}}

ErrorCode

Declaration

[JsonProperty(PropertyName = "errorCode")]
public string ErrorCode { get; set; }

Property Value

Type	Description
string	Oracle Error code generated by the action. Zero indicates the action was successful.

ErrorMessage

Declaration

[JsonProperty(PropertyName = "errorMessage")]
public string ErrorMessage { get; set; }

Property Value

Type	Description
string	The detailed message on why the error occurred.

EventName

Declaration

[JsonProperty(PropertyName = "eventName")]
public string EventName { get; set; }

Property Value

Type	Description
string	The name of the detail action executed by the user on the target database. For example ALTER SEQUENCE, CREATE TRIGGER or CREATE INDEX.

ExtendedEventAttributes

Declaration

[JsonProperty(PropertyName = "extendedEventAttributes")]
public string ExtendedEventAttributes { get; set; }

Property Value

Type	Description
string	List of all other attributes of the audit event seperated by a colon other than the one returned in audit record.

FgaPolicyName

Declaration

[JsonProperty(PropertyName = "fgaPolicyName")]
public string FgaPolicyName { get; set; }

Property Value

Type	Description
string	Fine-grained auditing (FGA) policy name that generated this audit record.

FreeformTags

Declaration

[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }

Property Value

Type	Description
Dictionary<string, string>	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"}

Id

Declaration

[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }

Property Value

Type	Description
string	The OCID of the audit event.

Remarks

Required

IsAlerted

Declaration

[Required(ErrorMessage = "IsAlerted is required.")]
[JsonProperty(PropertyName = "isAlerted")]
public bool? IsAlerted { get; set; }

Property Value

Type	Description
bool?	Indicates whether an alert was raised for this audit event.

Remarks

Required

ObjectName

Declaration

[JsonProperty(PropertyName = "objectName")]
public string ObjectName { get; set; }

Property Value

Type	Description
string	The name of the object affected by the action.

ObjectOwner

Declaration

[JsonProperty(PropertyName = "objectOwner")]
public string ObjectOwner { get; set; }

Property Value

Type	Description
string	The schema name of the object affected by the action.

ObjectType

Declaration

[JsonProperty(PropertyName = "objectType")]
public string ObjectType { get; set; }

Property Value

Type	Description
string	The type of the object in the source database affected by the action. For example PL/SQL, SYNONYM or PACKAGE BODY.

Operation

Declaration

[JsonProperty(PropertyName = "operation")]
public string Operation { get; set; }

Property Value

Type	Description
string	The name of the action executed by the user on the target database. For example ALTER, CREATE or DROP.

OperationStatus

Declaration

[JsonProperty(PropertyName = "operationStatus")]
[JsonConverter(typeof(ResponseEnumConverter))]
public AuditEventSummary.OperationStatusEnum? OperationStatus { get; set; }

Property Value

Type	Description
AuditEventSummary.OperationStatusEnum?	Indicates whether the operation was a success or a failure.

OsTerminal

Declaration

[JsonProperty(PropertyName = "osTerminal")]
public string OsTerminal { get; set; }

Property Value

Type	Description
string	The operating system terminal of the user session.

OsUserName

Declaration

[JsonProperty(PropertyName = "osUserName")]
public string OsUserName { get; set; }

Property Value

Type	Description
string	The name of the operating system user for the database session.

PeerTargetDatabaseKey

Declaration

[JsonProperty(PropertyName = "peerTargetDatabaseKey")]
public int? PeerTargetDatabaseKey { get; set; }

Property Value

Type	Description
int?	The secondary id assigned for the peer database registered with Data Safe.

TargetClass

Declaration

[JsonProperty(PropertyName = "targetClass")]
[JsonConverter(typeof(ResponseEnumConverter))]
public AuditEventSummary.TargetClassEnum? TargetClass { get; set; }

Property Value

Type	Description
AuditEventSummary.TargetClassEnum?	The class of the target that was audited.

TargetId

Declaration

[Required(ErrorMessage = "TargetId is required.")]
[JsonProperty(PropertyName = "targetId")]
public string TargetId { get; set; }

Property Value

Type	Description
string	The OCID of the target database that was audited.

Remarks

Required

TargetName

Declaration

[Required(ErrorMessage = "TargetName is required.")]
[JsonProperty(PropertyName = "targetName")]
public string TargetName { get; set; }

Property Value

Type	Description
string	The name of the target database that was audited.

Remarks

Required

TimeCollected

Declaration

[Required(ErrorMessage = "TimeCollected is required.")]
[JsonProperty(PropertyName = "timeCollected")]
public DateTime? TimeCollected { get; set; }

Property Value

Type	Description
DateTime?	The timestamp when this audit event was collected from the target database by Data Safe.

Remarks

Required

TrailSource

Declaration

[JsonProperty(PropertyName = "trailSource")]
[JsonConverter(typeof(ResponseEnumConverter))]
public AuditTrailSource? TrailSource { get; set; }

Property Value

Type	Description
AuditTrailSource?	The underlying source of unified audit trail.