WorkOS.ActionContext (WorkOS SDK for Elixir v3.1.0)

A verified, deserialized AuthKit Action request.

WorkOS sends a flat context object discriminated by object, not the webhook event envelope:

"authentication_action_context" — user, organization, organization_membership, issuer
"user_registration_action_context" — user_data, invitation

authentication_method, ip_address, user_agent, and device_fingerprint are shared by both context types; fields specific to the other variant are nil.

Summary

Types

t()

Types

t()

@type t() :: %WorkOS.ActionContext{
  authentication_method:
    WorkOS.AuthenticateResponseAuthenticationMethod.t() | nil,
  device_fingerprint: String.t() | nil,
  id: String.t() | nil,
  invitation: WorkOS.Invitation.t() | nil,
  ip_address: String.t() | nil,
  issuer: String.t() | nil,
  object: String.t() | nil,
  organization: WorkOS.Organization.t() | nil,
  organization_membership: WorkOS.OrganizationMembership.t() | nil,
  user: WorkOS.User.t() | nil,
  user_agent: String.t() | nil,
  user_data: WorkOS.ActionUserData.t() | nil
}