View Source WorkOS.AuditLogs (WorkOS SDK for Elixir v1.1.0)

Manage Audit Logs in WorkOS.

@see https://workos.com/docs/reference/audit-logs

Summary

Functions

Link to this function

create_event(client \\ WorkOS.client(), opts)

View Source
@spec create_event(WorkOS.Client.t(), map()) ::
  WorkOS.Client.response(WorkOS.Empty.t())

Creates an Audit Log Event.

Parameter options:

  • :organization_id - The unique ID of the Organization. (required)
  • :event - The Audit Log Event to be created. (required)
  • :idempotency_key - A unique string as the value. Each subsequent request matching this unique string will return the same response.
Link to this function

create_export(client \\ WorkOS.client(), opts)

View Source

Creates an Audit Log Export.

Parameter options:

  • :organization_id - The unique ID of the Organization. (required)
  • :range_start - ISO-8601 value for start of the export range. (required)
  • :range_end - ISO-8601 value for end of the export range. (required)
  • :actions - List of actions to filter against.
  • :actors - List of actor names to filter against.
  • :targets - List of target types to filter against.
Link to this function

get_export(client \\ WorkOS.client(), audit_log_export_id)

View Source

Gets an Audit Log Export given an ID.