WorkOS · Schema

AuditLogExportCreationDto

AuthenticationIdentity ProviderSSOSAMLOIDCSCIMDirectory SyncAuthorizationFGAAudit LogsMFAB2B SaaSAgentsMCP

Properties

Name Type Description
organization_id string The unique ID of the Organization.
range_start string ISO-8601 value for start of the export range.
range_end string ISO-8601 value for end of the export range.
actions array List of actions to filter against.
actors array Deprecated. Use `actor_names` instead.
actor_names array List of actor names to filter against.
actor_ids array List of actor IDs to filter against.
targets array List of target types to filter against.
View JSON Schema on GitHub

JSON Schema

workos-auditlogexportcreationdto-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/AuditLogExportCreationDto",
  "title": "AuditLogExportCreationDto",
  "type": "object",
  "properties": {
    "organization_id": {
      "type": "string",
      "description": "The unique ID of the Organization.",
      "example": "org_01EHZNVPK3SFK441A1RGBFSHRT"
    },
    "range_start": {
      "type": "string",
      "description": "ISO-8601 value for start of the export range.",
      "example": "2022-07-02T18:09:06.996Z"
    },
    "range_end": {
      "type": "string",
      "description": "ISO-8601 value for end of the export range.",
      "example": "2022-09-02T18:09:06.996Z"
    },
    "actions": {
      "description": "List of actions to filter against.",
      "example": [
        "user.signed_in"
      ],
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "actors": {
      "description": "Deprecated. Use `actor_names` instead.",
      "deprecated": true,
      "example": [
        "Jon Smith"
      ],
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "actor_names": {
      "description": "List of actor names to filter against.",
      "example": [
        "Jon Smith"
      ],
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "actor_ids": {
      "description": "List of actor IDs to filter against.",
      "example": [
        "user_01GBZK5MP7TD1YCFQHFR22180V"
      ],
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "targets": {
      "description": "List of target types to filter against.",
      "example": [
        "team"
      ],
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "required": [
    "organization_id",
    "range_start",
    "range_end"
  ]
}