Interface IAuditLogActor

Hierarchy

  • IAuditLogActor

Properties

Properties

agent?: string

The device's user-agent of actor that make request

id: string | string[]

Domain/application specific identifier of the actor. This field uniquely identifies the actor who triggered the operation. The id must be unique within a type.

REQUIREMENTS. Configurable defaults: The value must be at most 256 bytes in length.

BEST PRACTICE.

  • The id may refer to a user (staff, customer, etc) or to a system (service account, etc), depending on the context of the operation.
  • This field is required. If, for any reason, there is a case when it is impossible or not desirable to provide actor identity, use a consistent stub value like "unknown".
ip?: string

The device's IP of actor that make request

type: string

Type of the actor. This field may be used to distinguish different kinds of actors from each other.

REQUIREMENTS. Configurable defaults: The value must be at most 256 bytes in length.

EXAMPLE. In an example social website domain, the following actor types can be used:

  • USER for a person that updates the post;
  • SERVICE_ACCOUNT for a system that automatically archives posts when they become outdated.

Generated using TypeDoc