WorkOS · Schema

EventContextActorDto

The actor who performed the action.

AuthenticationIdentity ProviderSSOSAMLOIDCSCIMDirectory SyncAuthorizationFGAAudit LogsMFAB2B SaaSAgentsMCP

Properties

Name Type Description
id string Unique identifier of the actor.
source string The source of the actor that performed the action.
name stringnull The name of the actor.
View JSON Schema on GitHub

JSON Schema

workos-eventcontextactordto-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/EventContextActorDto",
  "title": "EventContextActorDto",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier of the actor.",
      "example": "user_01EHWNCE74X7JSDV0X3SZ3KJNY"
    },
    "source": {
      "type": "string",
      "enum": [
        "api",
        "dashboard",
        "admin_portal",
        "system"
      ],
      "description": "The source of the actor that performed the action."
    },
    "name": {
      "type": [
        "string",
        "null"
      ],
      "description": "The name of the actor.",
      "example": "Jane Doe"
    }
  },
  "required": [
    "id",
    "source",
    "name"
  ],
  "description": "The actor who performed the action."
}