OCSF.Actor (OCSF v0.1.0)

Copy Markdown View Source

OCSF Actor object.

Represents the entity (user and/or session) that initiated the action described by an OCSF event.

Corresponds to the OCSF Actor object.

Fields

  • :user -- %OCSF.User{} or nil. Classified as :identity.
  • :session -- session map or nil. Classified as :identifier.

PII classification

See OCSF.Classification for data class definitions. Call __ocsf_fields__/0 to inspect this module's field classifications.

See OCSF.User for the nested user object.

Summary

Functions

Return field classification metadata for PII policy enforcement.

Types

t()

@type t() :: %OCSF.Actor{session: map() | nil, user: OCSF.User.t() | nil}

Functions

__ocsf_fields__()

@spec __ocsf_fields__() :: keyword()

Return field classification metadata for PII policy enforcement.