Class AuditTrail
An audit trail represents the source of audit records that provides documentary evidence of the sequence of activities in the target database. Configuring audit trails in Data Safe, and enabling audit data collection on the audit trails copies the audit records from the target database's audit trail into the Data Safe repository.
Inherited Members
Namespace: Oci.DatasafeService.Models
Assembly: OCI.DotNetSDK.Datasafe.dll
Syntax
public class AuditTrail
Properties
AuditCollectionStartTime
Declaration
[JsonProperty(PropertyName = "auditCollectionStartTime")]
public DateTime? AuditCollectionStartTime { get; set; }
Property Value
Type | Description |
---|---|
DateTime? | The date from which the audit trail must start collecting data, in the format defined by RFC3339. |
AuditProfileId
Declaration
[Required(ErrorMessage = "AuditProfileId is required.")]
[JsonProperty(PropertyName = "auditProfileId")]
public string AuditProfileId { get; set; }
Property Value
Type | Description |
---|---|
string | The OCID of the parent audit. |
Remarks
Required
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 that contains the audit trail and is the same as the compartment of the audit profile resource. |
Remarks
Required
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
|
Description
Declaration
[JsonProperty(PropertyName = "description")]
public string Description { get; set; }
Property Value
Type | Description |
---|---|
string | The description of the audit trail. |
DisplayName
Declaration
[Required(ErrorMessage = "DisplayName is required.")]
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }
Property Value
Type | Description |
---|---|
string | The display name of the audit trail. |
Remarks
Required
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
|
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 trail. |
Remarks
Required
IsAutoPurgeEnabled
Declaration
[JsonProperty(PropertyName = "isAutoPurgeEnabled")]
public bool? IsAutoPurgeEnabled { get; set; }
Property Value
Type | Description |
---|---|
bool? | Indicates if auto purge is enabled on the target database, which helps delete audit data in the target database every seven days so that the database's audit trail does not become too large. |
LifecycleDetails
Declaration
[JsonProperty(PropertyName = "lifecycleDetails")]
public string LifecycleDetails { get; set; }
Property Value
Type | Description |
---|---|
string | Details about the current state of the audit trail in Data Safe. |
LifecycleState
Declaration
[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public AuditTrailLifecycleState? LifecycleState { get; set; }
Property Value
Type | Description |
---|---|
AuditTrailLifecycleState? | The current state of the audit trail. |
Remarks
Required
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. |
PurgeJobDetails
Declaration
[JsonProperty(PropertyName = "purgeJobDetails")]
public string PurgeJobDetails { get; set; }
Property Value
Type | Description |
---|---|
string | The details of the audit trail purge job that ran at the time specified by purgeJobTime". |
PurgeJobStatus
Declaration
[JsonProperty(PropertyName = "purgeJobStatus")]
[JsonConverter(typeof(ResponseEnumConverter))]
public AuditTrail.PurgeJobStatusEnum? PurgeJobStatus { get; set; }
Property Value
Type | Description |
---|---|
AuditTrail.PurgeJobStatusEnum? | The current status of the audit trail purge job. |
PurgeJobTime
Declaration
[JsonProperty(PropertyName = "purgeJobTime")]
public DateTime? PurgeJobTime { get; set; }
Property Value
Type | Description |
---|---|
DateTime? | The date and time of the last purge job. The purge job deletes audit data in the target database every seven days so that the database's audit trail does not become too large. In the format defined by RFC3339. |
Status
Declaration
[Required(ErrorMessage = "Status is required.")]
[JsonProperty(PropertyName = "status")]
[JsonConverter(typeof(ResponseEnumConverter))]
public AuditTrailStatus? Status { get; set; }
Property Value
Type | Description |
---|---|
AuditTrailStatus? | The current sub-state of the audit trail. |
Remarks
Required
SystemTags
Declaration
[JsonProperty(PropertyName = "systemTags")]
public Dictionary<string, Dictionary<string, object>> SystemTags { get; set; }
Property Value
Type | Description |
---|---|
Dictionary<string, Dictionary<string, object>> | System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud": {"free-tier-retained": "true"}} |
TargetId
Declaration
[Required(ErrorMessage = "TargetId is required.")]
[JsonProperty(PropertyName = "targetId")]
public string TargetId { get; set; }
Property Value
Type | Description |
---|---|
string | The OCID of the Data Safe target for which the audit trail is created. |
Remarks
Required
TimeCreated
Declaration
[Required(ErrorMessage = "TimeCreated is required.")]
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }
Property Value
Type | Description |
---|---|
DateTime? | The date and time the audit trail was created, in the format defined by RFC3339. |
Remarks
Required
TimeLastCollected
Declaration
[JsonProperty(PropertyName = "timeLastCollected")]
public DateTime? TimeLastCollected { get; set; }
Property Value
Type | Description |
---|---|
DateTime? | The date and time until when the audit events were collected from the target database by the Data Safe audit trail collection process, in the format defined by RFC3339. |
TimeUpdated
Declaration
[Required(ErrorMessage = "TimeUpdated is required.")]
[JsonProperty(PropertyName = "timeUpdated")]
public DateTime? TimeUpdated { get; set; }
Property Value
Type | Description |
---|---|
DateTime? | The date and time the audit trail was updated, in the format defined by RFC3339. |
Remarks
Required
TrailLocation
Declaration
[JsonProperty(PropertyName = "trailLocation")]
public string TrailLocation { get; set; }
Property Value
Type | Description |
---|---|
string | An audit trail location represents the source of audit records that provides documentary evidence of the sequence of activities in the target database. |
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. |
WorkRequestId
Declaration
[JsonProperty(PropertyName = "workRequestId")]
public string WorkRequestId { get; set; }
Property Value
Type | Description |
---|---|
string | The OCID of the workrequest for audit trail which collects audit records. |