Skip to content

Home > @opengovsg/logging > ResourceAudit

ResourceAudit interface ​

Resource/entity lifecycle audit events (category resource).

The **mutation** side of generic business entities (forms, projects, documents, …) — complements dataAccess (the read/export side) and userManagement (accounts specifically). Downstream of auth: the actor (user_id) and client_ip are scope-read. Log the resource type/id and *what* changed (field names), never the contents.

Signature:

typescript
export interface ResourceAudit

Methods ​

MethodDescription
created(input)A resource was created. Fires at notice.
deleted(input)A resource was deleted. Fires at notice.
ownershipTransferred(input)A resource's ownership was transferred to another user. Fires at notice.
updated(input)A resource was updated. Fires at notice.