WorkOS · Schema

AuditLogSchemaJson

AuthenticationIdentity ProviderSSOSAMLOIDCSCIMDirectory SyncAuthorizationFGAAudit LogsMFAB2B SaaSAgentsMCP

Properties

Name	Type	Description
object	string	Distinguishes the Audit Log Schema object.
version	integer	The version of the schema.
actor	object	The metadata schema for the actor.
targets	array	The list of targets for the schema.
metadata	object	Additional data associated with the event or entity.
created_at	string	The timestamp when the Audit Log Schema was created.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/AuditLogSchemaJson",
  "title": "AuditLogSchemaJson",
  "type": "object",
  "properties": {
    "object": {
      "type": "string",
      "description": "Distinguishes the Audit Log Schema object.",
      "example": "audit_log_schema",
      "const": "audit_log_schema"
    },
    "version": {
      "type": "integer",
      "description": "The version of the schema.",
      "example": 1
    },
    "actor": {
      "type": "object",
      "properties": {
        "metadata": {
          "type": "object",
          "additionalProperties": {},
          "description": "The JSON Schema definition for actor metadata."
        }
      },
      "required": [
        "metadata"
      ],
      "description": "The metadata schema for the actor.",
      "example": {
        "metadata": {
          "type": "object",
          "properties": {
            "role": {
              "type": "string"
            }
          }
        }
      }
    },
    "targets": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "description": "The type of the target resource.",
            "example": "invoice"
          },
          "metadata": {
            "type": "object",
            "additionalProperties": {},
            "description": "Additional data associated with the event or entity.",
            "example": {
              "type": "object",
              "properties": {
                "cost": {
                  "type": "number"
                }
              }
            }
          }
        },
        "required": [
          "type"
        ]
      },
      "description": "The list of targets for the schema.",
      "example": [
        {
          "type": "invoice",
          "metadata": {
            "type": "object",
            "properties": {
              "cost": {
                "type": "number"
              }
            }
          }
        }
      ]
    },
    "metadata": {
      "type": "object",
      "additionalProperties": {},
      "description": "Additional data associated with the event or entity.",
      "example": {
        "type": "object",
        "properties": {
          "transactionId": {
            "type": "string"
          }
        }
      }
    },
    "created_at": {
      "format": "date-time",
      "type": "string",
      "description": "The timestamp when the Audit Log Schema was created.",
      "example": "2026-01-15T12:00:00.000Z"
    }
  },
  "required": [
    "object",
    "version",
    "targets",
    "created_at"
  ]
}