Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace 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.

Properties

Optional auditCollectionStartTime

auditCollectionStartTime: Date

The date from which the audit trail must start collecting data, in the format defined by RFC3339.

auditProfileId

auditProfileId: string

The OCID of the parent audit.

compartmentId

compartmentId: string

The OCID of the compartment that contains the audit trail and is the same as the compartment of the audit profile resource.

Optional definedTags

definedTags: undefined | object

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags

Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}}

Optional description

description: undefined | string

The description of the audit trail.

displayName

displayName: string

The display name of the audit trail.

Optional freeformTags

freeformTags: undefined | object

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: {@code {\"Department\": \"Finance\"}}

id

id: string

The OCID of the audit trail.

Optional isAutoPurgeEnabled

isAutoPurgeEnabled: undefined | false | true

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.

Optional lifecycleDetails

lifecycleDetails: undefined | string

Details about the current state of the audit trail in Data Safe.

lifecycleState

lifecycleState: AuditTrailLifecycleState

The current state of the audit trail.

Optional peerTargetDatabaseKey

peerTargetDatabaseKey: undefined | number

The secondary id assigned for the peer database registered with Data Safe. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional purgeJobDetails

purgeJobDetails: undefined | string

The details of the audit trail purge job that ran at the time specified by purgeJobTime".

Optional purgeJobStatus

purgeJobStatus: PurgeJobStatus

The current status of the audit trail purge job.

Optional purgeJobTime

purgeJobTime: Date

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

The current sub-state of the audit trail.

Optional systemTags

systemTags: undefined | object

System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {@code {"orcl-cloud": {"free-tier-retained": "true"}}}

targetId

targetId: string

The OCID of the Data Safe target for which the audit trail is created.

timeCreated

timeCreated: Date

The date and time the audit trail was created, in the format defined by RFC3339.

Optional timeLastCollected

timeLastCollected: Date

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

timeUpdated: Date

The date and time the audit trail was updated, in the format defined by RFC3339.

Optional trailLocation

trailLocation: undefined | string

An audit trail location represents the source of audit records that provides documentary evidence of the sequence of activities in the target database.

Optional trailSource

trailSource: model.AuditTrailSource

The underlying source of unified audit trail.

Optional workRequestId

workRequestId: undefined | string

The OCID of the workrequest for audit trail which collects audit records.

Functions

getDeserializedJsonObj

getJsonObj