Metadata

metadata

The Metadata object describes the metadata associated with the event.

Attributes

CaptionNameTypeDescription
Correlation UIDcorrelation_uidString

The unique identifier used to correlate events.

Data Classificationdata_classificationData Classification[]

Group:context
The Data Classification object includes information about data classification levels and data category types.

🚧 WARNING: DEPRECATED

Data Classification has been deprecated since 1.4.0. Use the attribute data_classifications instead

Data Classificationdata_classificationsData Classification[]

Group:context
A list of Data Classification objects, that include information about data classification levels and data category types, indentified by a classifier.

Debug InformationdebugString[]

Debug information about non-fatal issues with this OCSF event. Each issue is a line in this string array.

Event Codeevent_codeString

The Event ID, Code, or Name that the product uses to primarily identify the event.

Schema ExtensionextensionSchema Extension[]

The schema extension used to create the event.

🚧 WARNING: DEPRECATED

Schema Extension has been deprecated since 1.1.0. Use the extensions attribute instead.

Schema ExtensionsextensionsSchema Extension[]

The schema extensions used to create the event.

LabelslabelsString[]

The list of labels attached to the event. For example: ["sample", "dev"]

Log Levellog_levelString

The audit level at which an event was generated.

Log Namelog_nameString

The event log name. For example, syslog file name or Windows logging subsystem: Security.

Log Providerlog_providerString

The logging provider or logging service that logged the event. For example, Microsoft-Windows-Security-Auditing.

Log Versionlog_versionString

The event log schema version that specifies the format of the original event. For example syslog version or Cisco Log Schema Version.

Logged Timelogged_timeTimestamp

The time when the logging system collected and logged the event.

This attribute is distinct from the event time in that event time typically contain the time extracted from the original event. Most of the time, these two times will be different.

LoggersloggersLogger[]

An array of Logger objects that describe the devices and logging products between the event source and its eventual destination. Note, this attribute can be used when there is a complex end-to-end path of event flow.

Modified Timemodified_timeTimestamp

The time when the event was last modified or enriched.

Original Timeoriginal_timeString

The original event time as reported by the event source. For example, the time in the original format from system event log such as Syslog on Unix/Linux and the System event file on Windows. Omit if event is generated instead of collected via logs.

Processed Timeprocessed_timeTimestamp

The event processed time, such as an ETL operation.

ProductproductProduct[]

The product that reported the event.

ProfilesprofilesString[]

The list of profiles used to create the event. Profiles should be referenced by their name attribute for core profiles, or extension/name for profiles from extensions.

Raw Dataraw_dataJSON

Group:context
The event data as received from the event source.

Record IDrecord_idString

Group:primary
Unique identifier for the object

Sequence NumbersequenceInteger

Sequence number of the event. The sequence number is a value available in some events, to make the exact ordering of events unambiguous, regardless of the event time precision.

TagstagsKey:Value object[]

The list of tags; {key:value} pairs associated to the event.

Tenant UIDtenant_uidString

The unique tenant identifier.

Event UIDuidString

The logging system-assigned unique identifier of an event instance.

UnmappedunmappedUnmapped[]

Data from the source that was not mapped into the schema.

VersionversionString

The version of the OCSF schema, using Semantic Versioning Specification (SemVer). For example: 1.0.0. Event consumers use the version to determine the available event attributes.

Relationships

Metadata shown in context

Inbound Relationships

These objects and events reference Metadata in their attributes:

Outbound Relationships

Metadata references the following objects and events in its attributes:

This page describes ocsf-1.4.0