API Activity
API events describe general CRUD (Create, Read, Update, Delete) API activities, e.g. (AWS Cloudtrail)
Attributes
| Caption | Name | Type | Description |
|---|---|---|---|
| Activity ID | activity_id |
Integer |
The normalized identifier of the activity that triggered the event.
|
| Activity | activity_name |
String | The event activity name, as defined by the activity_id. |
| Actor | actor |
Actor[] |
The actor that performed the operation or the action.
|
| API Details | api |
API[] | Describes details about a typical API (Application Programming Interface) call. |
| Category | category_name |
String | The event category name, as defined by category_uid value. |
| Category ID | category_uid |
Integer |
The category unique identifier of the event.
|
| Class | class_name |
String | The event class name, as defined by class_uid value. |
| Class ID | class_uid |
Integer |
The unique identifier of a class. A class describes the attributes available in an event.
|
| Cloud | cloud |
Cloud[] | Describes details about the Cloud environment where the event was originally created or logged. |
| Confidence | confidence |
Integer |
The confidence of the reported event severity as a percentage: 0%-100%.
|
| Count | count |
Integer | The number of times that events in the same logical group occurred during the event Start Time to End Time period. |
| Data | data |
JSON |
Additional data that is associated with the event.
|
| Device | device |
Device[] |
The device that reported the event.
|
| Destination Endpoint | dst_endpoint |
Network Endpoint[] | The network destination endpoint. |
| Duration | duration |
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 |
Timestamp | The end time of a time period, or the time of the most recent event included in the aggregate event. |
| Enrichments | enrichments |
Enrichment[] |
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"}}]
|
| HTTP Request | http_request |
HTTP Request[] | Details about the underlying http request. |
| Message | message |
String | The description of the event/finding, as defined by the source. |
| Metadata | metadata |
Metadata[] | The metadata associated with the event or a finding. |
| Observables | observables |
Observable[] | The observables associated with the event or a finding. |
| OSINT | osint |
OSINT[] | 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. |
| Raw Data | raw_data |
JSON | The event data as received from the event source. |
| Record ID | record_id |
String | Unique idenifier for the event |
| Resources Array | resources |
Resource Details[] | Details about resources that were affected by the activity/event. |
| Severity | severity |
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 |
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.
|
| Source Endpoint | src_endpoint |
Network Endpoint[] | Details about the source of the activity. |
| Start Time | start_time |
Timestamp | The start time of a time period, or the time of the least recent event included in the aggregate event. |
| Status | status |
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 |
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 Details | status_detail |
String | The status detail contains additional information about the event/finding outcome. |
| Status ID | status_id |
Integer |
The normalized identifier of the event status.
|
| Event Time | time |
Timestamp | The normalized event occurrence time or the finding creation time. |
| Timezone Offset | timezone_offset |
Integer |
The number of minutes that the reported event time is ahead or behind UTC, in the range -1,080 to +1,080.
|
| Type Name | type_name |
String | The event/finding type name, as defined by the type_uid. |
| Type ID | type_uid |
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.
|
| Unmapped Data | unmapped |
Unmapped[] | The attributes that are not mapped to the event schema. The names and values of those attributes are specific to the event source. |
Relationships
Outbound Relationships
API Activity references the following objects and events in its attributes:
- Unmapped
- Resource Details
- HTTP Request
- Metadata
- Cloud
- OSINT
- Actor
- API
- Network Endpoint
- Enrichment
- Device
- Observable
This page describes qdm-1.3.2+ocsf-1.3.0
Updated 2 months ago