interface AuditQuery

Query criteria for IAuditStorage.query. Every field is optional and combines as AND. An omitted field does not constrain.

Properties

optional
action: string

Matches entries whose action equals this value exactly.

optional
resource: string

Matches entries whose resource equals this value exactly.

optional
resourceId: string

Matches entries whose resourceId equals this value exactly.

optional
userId: string

Matches entries whose userId equals this value exactly.

optional
result: "success" | "failure"

Matches entries whose outcome equals this value.

optional
from: number

Lower time bound, inclusive (epoch ms).

optional
to: number

Upper time bound, inclusive (epoch ms).

optional
limit: number

Cap on returned count, applied after filtering and ordering.

Usage

import { type AuditQuery } from "audit-plugin/src/index.ts";