Skip to content

API Activity (6003)

API events describe general CRUD (Create, Read, Update, Delete) API activities, e.g. (AWS Cloudtrail)

  • Category: Application Activity
  • Extends: application
  • UID: 6003

Attributes

Section titled “Attributes”

Classification

Section titled “Classification”

activity_id

  • Type: integer_t
  • Requirement: required
  • Values:
    • 0 - Unknown: The event activity is unknown.
    • 1 - Create: The API call in the event pertains to a ‘create’ activity.
    • 2 - Read: The API call in the event pertains to a ‘read’ activity.
    • 3 - Update: The API call in the event pertains to a ‘update’ activity.
    • 4 - Delete: The API call in the event pertains to a ‘delete’ activity.
    • 99 - Other: The event activity is not mapped. See the activity_name attribute, which contains a data source specific value.

The normalized identifier of the activity that triggered the event.

category_uid

  • Type: integer_t
  • Requirement: required
  • Values:
    • 6 - Application Activity: Application Activity events report detailed information about the behavior of applications and services.

The category unique identifier of the event.

class_uid

  • Type: integer_t
  • Requirement: required
  • Values:
    • 6003 - API Activity: API events describe general CRUD (Create, Read, Update, Delete) API activities, e.g. (AWS Cloudtrail)

The unique identifier of a class. A class describes the attributes available in an event.

severity_id

  • Type: integer_t
  • Requirement: required
  • Values:
    • 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.

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.

type_uid

  • Type: long_t
  • Requirement: required
  • Values:
    • 600300 - API Activity: Unknown
    • 600301 - API Activity: Create: The API call in the event pertains to a ‘create’ activity.
    • 600302 - API Activity: Read: The API call in the event pertains to a ‘read’ activity.
    • 600303 - API Activity: Update: The API call in the event pertains to a ‘update’ activity.
    • 600304 - API Activity: Delete: The API call in the event pertains to a ‘delete’ activity.
    • 600399 - API Activity: Other

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.

activity_name

  • Type: string_t
  • Requirement: optional

The event activity name, as defined by the activity_id.

category_name

  • Type: string_t
  • Requirement: optional

The event category name, as defined by category_uid value: Application Activity.

class_name

  • Type: string_t
  • Requirement: optional

The event class name, as defined by class_uid value: API Activity.

severity

  • Type: string_t
  • Requirement: optional

The event/finding severity, normalized to the caption of the severity_id value. In the case of ‘Other’, it is defined by the source.

type_name

  • Type: string_t
  • Requirement: optional

The event/finding type name, as defined by the type_uid.

Context

Section titled “Context”

metadata

The metadata associated with the event or a finding.

enrichments

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"}}]

raw_data

  • Type: string_t
  • Requirement: optional

The raw event/finding data as received from the source.

unmapped

  • Type: object
  • Requirement: optional

The attributes that are not mapped to the event schema. The names and values of those attributes are specific to the event source.

Occurrence

Section titled “Occurrence”

time

  • Type: timestamp_t
  • Requirement: required

The normalized event occurrence time or the finding creation time.

timezone_offset

  • Type: integer_t
  • Requirement: recommended

The number of minutes that the reported event time is ahead or behind UTC, in the range -1,080 to +1,080.

count

  • Type: integer_t
  • Requirement: optional

The number of times that events in the same logical group occurred during the event Start Time to End Time period.

duration

  • Type: long_t
  • Requirement: optional

The event duration or aggregate time, the amount of time the event covers from start_time to end_time in milliseconds.

end_time

  • Type: timestamp_t
  • Requirement: optional

The end time of a time period, or the time of the most recent event included in the aggregate event.

end_time_dt datetime

  • Type: datetime_t
  • Requirement: optional

The end time of a time period, or the time of the most recent event included in the aggregate event.

start_time

  • Type: timestamp_t
  • Requirement: optional

The start time of a time period, or the time of the least recent event included in the aggregate event.

start_time_dt datetime

  • Type: datetime_t
  • Requirement: optional

The start time of a time period, or the time of the least recent event included in the aggregate event.

time_dt datetime

  • Type: datetime_t
  • Requirement: optional

The normalized event occurrence time or the finding creation time.

Primary

Section titled “Primary”

actor

  • Type: actor
  • Requirement: required

The actor object describes details about the user/role/process that was the source of the activity.

api

  • Type: api
  • Requirement: required

Describes details about a typical API (Application Programming Interface) call.

cloud cloud

  • Type: cloud
  • Requirement: required

Describes details about the Cloud environment where the event was originally created or logged.

osint osint

  • Type: osint
  • Requirement: required

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.

src_endpoint

Details about the source of the activity.

dst_endpoint

The network destination endpoint.

http_request

Details about the underlying http request.

message

  • Type: string_t
  • Requirement: recommended

The description of the event/finding, as defined by the source.

observables

The observables associated with the event or a finding.

resources

Details about resources that were affected by the activity/event.

status

  • Type: string_t
  • Requirement: recommended

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

  • Type: string_t
  • Requirement: recommended

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

  • Type: string_t
  • Requirement: recommended

The status detail contains additional information about the event/finding outcome.

status_id

  • Type: integer_t
  • Requirement: recommended
  • Values:
    • 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.

The normalized identifier of the event status.

Objects Used

Section titled “Objects Used”