WorkOS · Schema

AuditLogEventActorDto

AuthenticationIdentity ProviderSSOSAMLOIDCSCIMDirectory SyncAuthorizationFGAAudit LogsMFAB2B SaaSAgentsMCP

Properties

Name Type Description
id string Actor identifier.
type string Actor type.
name string Optional actor name.
metadata object Additional data associated with the event or entity.
View JSON Schema on GitHub

JSON Schema

workos-auditlogeventactordto-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/AuditLogEventActorDto",
  "title": "AuditLogEventActorDto",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Actor identifier.",
      "example": "user_TF4C5938"
    },
    "type": {
      "type": "string",
      "description": "Actor type.",
      "example": "user"
    },
    "name": {
      "type": "string",
      "description": "Optional actor name.",
      "example": "Jon Smith"
    },
    "metadata": {
      "type": "object",
      "description": "Additional data associated with the event or entity.",
      "example": {
        "owner": "user_01GBTCQ2"
      },
      "maxProperties": 50,
      "additionalProperties": false,
      "patternProperties": {
        "^[a-zA-Z0-9_-]{0,40}$": {
          "anyOf": [
            {
              "type": "string",
              "maxLength": 500
            },
            {
              "type": "number"
            },
            {
              "type": "boolean"
            }
          ]
        }
      }
    }
  },
  "required": [
    "id",
    "type"
  ]
}