API Details |
api |
context |
optional |
API |
Describes details about a typical API (Application Programming Interface) call. |
Activity |
activity_name |
classification |
optional |
String |
The event activity name, as defined by the activity_id. |
Activity ID |
activity_id |
classification |
required |
Integer |
The normalized identifier of the activity that triggered the event.
0 | Unknown The event activity is unknown. | |
99 | Other The event activity is not mapped. See the activity_name attribute, which contains a data source specific value. | |
|
Category |
category_name |
classification |
optional |
String |
The event category name, as defined by category_uid value. |
Category ID |
category_uid |
classification |
required |
Integer |
The category unique identifier of the event. |
Class |
class_name |
classification |
optional |
String |
The event class name, as defined by class_uid value: Base Event . |
Class ID |
class_uid |
classification |
required |
Integer |
The unique identifier of a class. A class describes the attributes available in an event.
0 | Base Event The base event is a generic and concrete event. It also defines a set of attributes available in most event classes. As a generic event that does not belong to any event category, it could be used to log events that are not otherwise defined by the schema. | |
|
Cloud |
cloud |
primary |
required |
Cloud |
Describes details about the Cloud environment where the event was originally created or logged. |
Count |
count |
occurrence |
optional |
Integer |
The number of times that events in the same logical group occurred during the event Start Time to End Time period. |
Duration Milliseconds |
duration |
occurrence |
optional |
Long |
The event duration or aggregate time, the amount of time the event covers from start_time to end_time in milliseconds. |
End Time |
end_time |
occurrence |
optional |
Timestamp |
The end time of a time period, or the time of the most recent event included in the aggregate event. |
End Time |
end_time_dt |
occurrence |
optional |
Datetime |
The end time of a time period, or the time of the most recent event included in the aggregate event. |
Enrichments |
enrichments |
context |
optional |
Enrichment Array |
The additional information from an external data source, which is associated with the event or a finding. For example add location information for the IP address in the DNS answers:[{"name": "answers.ip", "value": "92.24.47.250", "type": "location", "data": {"city": "Socotra", "continent": "Asia", "coordinates": [-25.4153, 17.0743], "country": "YE", "desc": "Yemen"}}] |
Event Time |
time |
occurrence |
required |
Timestamp |
The normalized event occurrence time or the finding creation time. |
Event Time |
time_dt |
occurrence |
optional |
Datetime |
The normalized event occurrence time or the finding creation time. |
Message |
message |
primary |
recommended |
String |
The description of the event/finding, as defined by the source. |
Metadata |
metadata |
context |
required |
Metadata |
The metadata associated with the event or a finding. |
OSINT |
osint |
primary |
required |
OSINT Array |
The OSINT (Open Source Intelligence) object contains details related to an indicator such as the indicator itself, related indicators, geolocation, registrar information, subdomains, analyst commentary, and other contextual information. This information can be used to further enrich a detection or finding by providing decisioning support to other analysts and engineers. |
Observables |
observables |
primary |
recommended |
Observable Array |
The observables associated with the event or a finding. |
Raw Data |
raw_data |
context |
optional |
String |
The raw event/finding data as received from the source. |
Severity |
severity |
classification |
optional |
String |
The event/finding severity, normalized to the caption of the severity_id value. In the case of 'Other', it is defined by the source. |
Severity ID |
severity_id |
classification |
required |
Integer |
The normalized identifier of the event/finding severity. The normalized severity is a measurement the effort and expense required to manage and resolve an event or incident. Smaller numerical values represent lower impact events, and larger numerical values represent higher impact events.
0 | Unknown The event/finding severity is unknown. | |
1 | Informational Informational message. No action required. | |
2 | Low The user decides if action is needed. | |
3 | Medium Action is required but the situation is not serious at this time. | |
4 | High Action is required immediately. | |
5 | Critical Action is required immediately and the scope is broad. | |
6 | Fatal An error occurred but it is too late to take remedial action. | |
99 | Other The event/finding severity is not mapped. See the severity attribute, which contains a data source specific value. | |
|
Start Time |
start_time |
occurrence |
optional |
Timestamp |
The start time of a time period, or the time of the least recent event included in the aggregate event. |
Start Time |
start_time_dt |
occurrence |
optional |
Datetime |
The start time of a time period, or the time of the least recent event included in the aggregate event. |
Status |
status |
primary |
recommended |
String |
The event status, normalized to the caption of the status_id value. In the case of 'Other', it is defined by the event source. |
Status Code |
status_code |
primary |
recommended |
String |
The event status code, as reported by the event source.
For example, in a Windows Failed Authentication event, this would be the value of 'Failure Code', e.g. 0x18. |
Status Detail |
status_detail |
primary |
recommended |
String |
The status detail contains additional information about the event/finding outcome. |
Status ID |
status_id |
primary |
recommended |
Integer |
The normalized identifier of the event status.
0 | Unknown The status is unknown. | |
1 | Success | |
2 | Failure | |
99 | Other The event status is not mapped. See the status attribute, which contains a data source specific value. | |
|
Timezone Offset |
timezone_offset |
occurrence |
recommended |
Integer |
The number of minutes that the reported event time is ahead or behind UTC, in the range -1,080 to +1,080. |
Type ID |
type_uid |
classification |
required |
Long |
The event/finding type ID. It identifies the event's semantics and structure. The value is calculated by the logging system as: class_uid * 100 + activity_id .
0 | Base Event: Unknown | |
99 | Base Event: Other | |
|
Type Name |
type_name |
classification |
optional |
String |
The event/finding type name, as defined by the type_uid. |
Unmapped Data |
unmapped |
context |
optional |
Object |
The attributes that are not mapped to the event schema. The names and values of those attributes are specific to the event source. |