Interface IAuditLogResource

Hierarchy

  • IAuditLogResource

Properties

Properties

id: string | string[]

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

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

EXAMPLE. In an example social website domain, the value can represent post id, comment id, etc. For singleton resources the name can be used as a resource identifier, e.g. "site_settings" for global site settings that you want to audit.

type: string

Type of the resource. This field may be used to distinguish different kinds of resources 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 resource types can be used:

  • POST for content post;
  • COMMENT for comment to a post.

BEST PRACTICE.

  • Match resource types according to your business domain model.
  • Keep the variety of resource types under control. This will make it easier to filter and analyze records.

Generated using TypeDoc