AuditLogEvent

An audit log event recording a notable action taken in the application, including who performed the action, what was affected, and when it occurred.

Properties

• id (string): Unique identifier for the audit log event.
• organization ([[Organization]]): The organization this event belongs to.
• action (string): The action that was performed (user.signed_in, user.deleted, document.shared, etc.).
• actor ([[Actor]]): The entity that performed the action.
• targets ([[Target]][]): The resources that were affected by the action.
• context (object): Additional context about where and how the action occurred.
• occurredAt (number): Timestamp when the event occurred (Unix timestamp).
• ipAddress (string): IP address where the action originated.
• userAgent (string): User agent string from the request.
• location ([[Location]]): Geographic location where action occurred.
• version (number): Event schema version.
• metadata (object): Custom key-value pairs for additional event data.
• created (number): Timestamp when event was recorded (Unix timestamp).

Actions

create

Create a new audit log event.

Input: [[AuditLogEvent]]
Output: [[AuditLogEvent]]

export

Export audit log events matching criteria.

Input: [[ExportRequest]]
Output: [[AuditLogExport]]

search

Search audit log events by filters.

Input: [[AuditLogSearch]]
Output: [[AuditLogEvent]][]

list

List audit log events with pagination.

Input: [[AuditLogListRequest]]
Output: [[AuditLogEvent]][]

Events

• created: Triggered when a new audit log event is recorded.
• exported: Triggered when audit logs are exported.