Interface IAuditLogOperation

Hierarchy

  • IAuditLogOperation

Properties

Properties

id: string | string[]

Domain/application specific identifier of the operation. This field identifies the operation that is audited.

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

EXAMPLE. A few examples on how the operation for creating a post comment can be identified:

  • Simple identifier like "CreateComment"
  • Event name, e.g. "CommentCreated"
  • API operation for HTTP, e.g. "POST /posts/101/comments"
  • API operation for gRPC, e.g. "example.v1.PostService/CreateComment"
  • Serverless function name
  • etc.
status?: "UNSPECIFIED" | "SUCCEEDED" | "FAILED"

Enumerates available operation statuses.

  • UNSPECIFIED: Operation status not provided or unknown.
  • SUCCEEDED: Operation succeeded.
  • FAILED: Operation failed.
type: string

Type of the operation. This field may be used to categorize operations / actions / events.

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

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

  • CREATE when the post or comment is created;
  • UPDATE when the post or comment post is updated;
  • DELETE when the post or comment post is deleted.

BEST PRACTICE.

  • Use type for high-level categorization and id for identification. For example, there can be multiple ways to create the resource: a user can create a resource from an app, an administrator can create a resource from the back office, a batch of resources can be created from the API - all of these operations can be of type CREATE.

Generated using TypeDoc