WorkOS · Schema

AuditLogExportJson

AuthenticationIdentity ProviderSSOSAMLOIDCSCIMDirectory SyncAuthorizationFGAAudit LogsMFAB2B SaaSAgentsMCP

Properties

Name Type Description
object string Distinguishes the Audit Log Export object.
id string The unique ID of the Audit Log Export.
state string The state of the export. Possible values: pending, ready, error.
url stringnull A URL to the CSV file. Only defined when the Audit Log Export is ready.
created_at string An ISO 8601 timestamp.
updated_at string An ISO 8601 timestamp.
View JSON Schema on GitHub

JSON Schema

workos-auditlogexportjson-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/AuditLogExportJson",
  "title": "AuditLogExportJson",
  "type": "object",
  "properties": {
    "object": {
      "type": "string",
      "description": "Distinguishes the Audit Log Export object.",
      "example": "audit_log_export",
      "const": "audit_log_export"
    },
    "id": {
      "type": "string",
      "description": "The unique ID of the Audit Log Export.",
      "example": "audit_log_export_01GBZK5MP7TD1YCFQHFR22180V"
    },
    "state": {
      "type": "string",
      "enum": [
        "pending",
        "ready",
        "error"
      ],
      "description": "The state of the export. Possible values: pending, ready, error.",
      "example": "ready"
    },
    "url": {
      "type": [
        "string",
        "null"
      ],
      "description": "A URL to the CSV file. Only defined when the Audit Log Export is ready.",
      "example": "https://exports.audit-logs.com/audit-log-exports/export.csv"
    },
    "created_at": {
      "format": "date-time",
      "type": "string",
      "description": "An ISO 8601 timestamp.",
      "example": "2026-01-15T12:00:00.000Z"
    },
    "updated_at": {
      "format": "date-time",
      "type": "string",
      "description": "An ISO 8601 timestamp.",
      "example": "2026-01-15T12:00:00.000Z"
    }
  },
  "required": [
    "object",
    "id",
    "state",
    "created_at",
    "updated_at"
  ]
}