FusionAuth developer image
FusionAuth developer logo
  • Back to site
  • Expert Advice
  • Blog
  • Developers
  • Downloads
  • Account
  • Contact sales
Navigate to...
  • Welcome
  • Getting Started
  • 5-Minute Setup Guide
  • Release Notes
  • Core Concepts
    • Overview
    • Users
    • Roles
    • Groups
    • Entity Management
    • Registrations
    • Applications
    • Tenants
    • Identity Providers
    • Key Master
    • SCIM
    • Search
    • Authentication and Authorization
    • Integration Points
    • Localization and Internationalization
    • Editions and Features
    • Roadmap
  • Installation Guide
    • Overview
    • System Requirements
    • Server Layout
    • Cloud
    • Cluster
    • Docker
    • Fast Path
    • Kubernetes
      • Overview
      • Deployment Guide
      • Minikube Setup
      • Amazon EKS Setup
      • Google GKE Setup
      • Microsoft AKS Setup
    • Kickstart™
    • Homebrew
    • Packages
    • Database
    • FusionAuth App
    • FusionAuth Search
    • Common Configuration
  • Admin Guide
    • Overview
    • Account Portal
    • Config Management
    • Licensing
    • Monitoring
    • Proxy Setup
    • Securing
    • Technical Support
    • Troubleshooting
    • Upgrading
  • Migration Guide
    • Overview
    • General
    • Auth0
    • Keycloak
    • Amazon Cognito
    • Firebase
    • Tutorial
  • APIs
    • Overview
    • Authentication
    • Errors
    • Actioning Users
    • API Keys
    • Applications
    • Audit Logs
    • Connectors
      • Overview
      • Generic
      • LDAP
    • Consents
    • Emails
    • Entity Management
      • Overview
      • Entities
      • Entity Types
      • Grants
    • Event Logs
    • Families
    • Forms
    • Form Fields
    • Groups
    • Identity Providers
      • Overview
      • Links
      • Apple
      • External JWT
      • Epic Games
      • Facebook
      • Google
      • HYPR
      • LinkedIn
      • Nintendo
      • OpenID Connect
      • SAML v2
      • SAML v2 IdP Initiated
      • Sony PlayStation Network
      • Steam
      • Twitch
      • Twitter
      • Xbox
    • Integrations
    • IP Access Control Lists
    • JWT
    • Keys
    • Lambdas
    • Login
    • Message Templates
    • Messengers
      • Overview
      • Generic
      • Kafka
      • Twilio
    • Multi-Factor/Two Factor
    • Passwordless
    • Reactor
    • Registrations
    • Reports
    • SCIM
      • Overview
      • SCIM EnterpriseUser
      • SCIM Group
      • SCIM Service Provider Config.
      • SCIM User
    • System
    • Tenants
    • Themes
    • Users
    • User Actions
    • User Action Reasons
    • User Comments
    • Webhooks
  • Client Libraries
    • Overview
    • Dart
    • Go
    • Java
    • JavaScript
    • .NET Core
    • Node
    • OpenAPI
    • PHP
    • Python
    • Ruby
    • Typescript
  • Themes
    • Overview
    • Examples
    • Helpers
    • Localization
    • Template Variables
  • Email & Templates
    • Overview
    • Configure Email
    • Email Templates
    • Email Variables
    • Message Templates
  • Events & Webhooks
    • Overview
    • Writing a Webhook
    • Securing Webhooks
    • Events
      • Overview
      • Audit Log Create
      • Event Log Create
      • JWT Public Key Update
      • JWT Refresh
      • JWT Refresh Token Revoke
      • Kickstart Success
      • User Action
      • User Bulk Create
      • User Create
      • User Create Complete
      • User Deactivate
      • User Delete
      • User Delete Complete
      • User Email Update
      • User Email Verified
      • User IdP Link
      • User IdP Unlink
      • User Login Failed
      • User Login Id Duplicate Create
      • User Login Id Duplicate Update
      • User Login New Device
      • User Login Success
      • User Login Suspicious
      • User Password Breach
      • User Password Reset Send
      • User Password Reset Start
      • User Password Reset Success
      • User Password Update
      • User Reactivate
      • User Registration Create
      • User Registration Create Complete
      • User Registration Delete
      • User Registration Delete Complete
      • User Registration Update
      • User Registration Update Complete
      • User Registration Verified
      • User Two Factor Method Add
      • User Two Factor Method Remove
      • User Update
      • User Update Complete
  • Example Apps
    • Overview
    • Dart
    • Go
    • Java
    • JavaScript
    • .NET Core
    • PHP
    • Python
    • Ruby
  • Lambdas
    • Overview
    • Apple Reconcile
    • Client Cred. JWT Populate
    • Epic Games Reconcile
    • External JWT Reconcile
    • Facebook Reconcile
    • Google Reconcile
    • HYPR Reconcile
    • JWT Populate
    • LDAP Connector Reconcile
    • LinkedIn Reconcile
    • Nintendo Reconcile
    • OpenID Connect Reconcile
    • SAML v2 Populate
    • SAML v2 Reconcile
    • SCIM Group Req. Converter
    • SCIM Group Resp. Converter
    • SCIM User Req. Converter
    • SCIM User Resp. Converter
    • Sony PSN Reconcile
    • Steam Reconcile
    • Twitch Reconcile
    • Twitter Reconcile
    • Xbox Reconcile
  • Identity Providers
    • Overview
    • Apple
    • Epic Games
    • External JWT
      • Overview
      • Example
    • Facebook
    • Google
    • HYPR
    • LinkedIn
    • Nintendo
    • OpenID Connect
      • Overview
      • Azure AD
      • Discord
      • Github
    • Sony PlayStation Network
    • Steam
    • Twitch
    • Twitter
    • SAML v2
      • Overview
      • ADFS
    • SAML v2 IdP Initiated
      • Overview
      • Okta
    • Xbox
  • Messengers
    • Overview
    • Generic Messenger
    • Kafka Messenger
    • Twilio Messenger
  • Connectors
    • Overview
    • Generic Connector
    • LDAP Connector
    • FusionAuth Connector
  • Self Service Account Mgmt
    • Overview
    • Updating User Data & Password
    • Add Two-Factor Authenticator
    • Add Two-Factor Email
    • Add Two-Factor SMS
    • Customizing
    • Troubleshooting
  • Advanced Threat Detection
    • Overview
  • Integrations
    • Overview
    • CleanSpeak
    • Kafka
    • Twilio
  • OpenID Connect & OAuth 2.0
    • Overview
    • Endpoints
    • Tokens
  • SAML v2 IdP
    • Overview
    • Google
    • Zendesk
  • Plugins
    • Plugins
    • Writing a Plugin
    • Custom Password Hashing
  • Guides
    • Overview
    • Advanced Registration Forms
    • Breached Password Detection
    • Multi-Factor Authentication
    • Multi-Tenant
    • Passwordless
    • Securing Your APIs
    • Silent Mode
    • Single Sign-on
  • Tutorials
    • Overview
    • User Control & Gating
      • Gate Unverified Users
      • Gate Unverified Registrations
      • User Account Lockout
    • Setup Wizard & First Login
    • Register/Login a User
    • Start and Stop FusionAuth
    • Authentication Tokens
    • Key Rotation
    • JSON Web Tokens
    • Prometheus Setup
    • Switch Search Engines
    • Two Factor (pre 1.26)
  • Reference
    • CORS
    • Configuration
    • Data Types
    • Known Limitations
    • Password Hashes

    User Action

    User Action

    This event is generated when a User Action is taken on a user and when temporal actions transition between phases.

    A temporal action is one that has a start time and and a duration. When a phase transition occurs for a temporal action, an event will be sent to the webhook. See the event.phase in the message body.

    Event type
    user.action

    Event Scope

    This is a tenant or application scoped event. It can be sent to all applications in a tenant or to one or more specified applications.

    The ability to limit the generation of an event for only certain applications is legacy functionality and may be modified in the future. You almost certainly want to enable this event at the tenant level and optionally filter on the applicationId when consuming the event.

    Event Body

    event.action [String]

    This parameter specifies the name of the action that is occurring.

    event.actionId [UUID]

    This parameter specifies the unique Id of the action that is occurring.

    event.actioneeUserId [UUID]

    This parameter specifies the unique identifier of the user the action is being performed on.

    event.actionerUserId [UUID]

    This parameter specifies the Id of the User that performed the action that resulted in the notification being sent. If the action was initiated by FusionAuth this value will not be provided.

    event.applicationIds [Array<UUID>]

    This parameter if provided specifies the scope of the User Action. When an Action is scoped to one or more Applications the Application Ids will be provided in this parameter.

    event.comment [String]

    An optional comment left to possibly indicate why the action was taken, modified or canceled.

    event.createInstant [Long]

    The instant that the event was generated.

    event.email [Object]

    When the action is configured to send the email in the event body, FusionAuth will render the email and provide the result in the event body. This can be used to send an email through a third party provider. See Example POST body below for fields.

    event.emailedUser [Boolean]

    This parameter will indicate if FusionAuth has already sent an email to the user as a result of this event. When true an email was sent to the user, and if false an email was not sent to the user.

    event.expiry [Long]

    The instant that the action will expire, if the action expires.

    event.id [UUID]

    The unique Id of the event. You may receive an event more than once based upon your transaction settings. This Id may be used to identify a duplicate event.

    event.info.data [Object] Available since 1.30.0

    An object that can hold any information about the event that should be persisted.

    event.info.deviceDescription [String] Available since 1.30.0

    The description of the device associated with the event.

    event.info.deviceName [String] Available since 1.30.0

    The device name associated with the event.

    event.info.deviceType [String] Available since 1.30.0

    The type of device associated with the event.

    event.info.ipAddress [String] Available since 1.27.0

    The source IP address of the event.

    event.info.location.city [String] Available since 1.30.0

    The city where the event originated.

    Note: A paid edition of FusionAuth is required to utilize event info location.

    event.info.location.country [String] Available since 1.30.0

    The country where the event originated.

    Note: A paid edition of FusionAuth is required to utilize event info location.

    event.info.location.latitude [String] Available since 1.30.0

    The latitude where the event originated.

    Note: A paid edition of FusionAuth is required to utilize event info location.

    event.info.location.longitude [String] Available since 1.30.0

    The longitude where the event originated.

    Note: A paid edition of FusionAuth is required to utilize event info location.

    event.info.location.region [String] Available since 1.30.0

    The geographic location where the event originated.

    Note: A paid edition of FusionAuth is required to utilize event info location.

    event.info.location.zipcode [String] Available since 1.30.0

    The zip code where the event originated.

    Note: A paid edition of FusionAuth is required to utilize event info location.

    event.info.os [String] Available since 1.30.0

    The operating system associated with the event.

    event.info.userAgent [String] Available since 1.30.0

    The user agent associated with the event.

    event.localizedAction [String]

    This parameter specifies the localized version of the action field, based on the user’s preferred languages.

    event.localizedDuration [String]

    The duration of the action in a human readable format that is localized based on the user’s preferred languages.

    event.localizedOption [String]

    This parameter specifies the localized version of the option field, based on the user’s preferred languages.

    event.localizedReason [String]

    This parameter specifies the localized reason of the reason field, based on the user’s preferred languages.

    event.notifyUser [Boolean]

    This parameter specifies whether the user should be notified. FusionAuth will only set this value based upon the event configuration, it is simply an indicator to the event consumer to notify the user.

    event.option [String]

    An optional value to provide additional context to the Action. This value is free form and defined by the User Action.

    event.phase [Boolean]

    If the Action is temporal, this parameter will be provided to indicate the current phase of the action. The following are the possible Action states:

    • start - The event has started.

    • modify - The event has been modified.

    • cancel - The event has been canceled, the end phase will not be reached.

    • end - The event has ended.

      When the action is started by an admin, the phase will be "start". If an admin changes the duration of the action, the phase will be "modify". If an admin cancels an action it will be "cancel" or the action expires, the phase will be "end". If the action is key-based, the phase will be "start".

    event.reason [String]

    The reason the admin selected. Reasons may be configured in the FusionAuth UI, navigate to Settings → User Actions → Reasons. This value will be omitted when no reasons are selected (or configured).

    event.reasonCode [String]

    The reason code the admin selected. Reasons may be configured in the FusionAuth UI, navigate to Settings → User Actions → Reasons. This value will be omitted when no reasons are selected (or configured).

    event.tenantId [UUID] Available since 1.8.0

    The unique tenant identifier. This value may not be returned if not applicable.

    event.type [String]

    The event type, this value will always be user.action.

    Example Event JSON
    {
      "event": {
        "action": "Mute",
        "actionId": "8c10cd8d-251b-4ebc-9171-6a7a2e8ed390",
        "actioneeId": "32ac49fe-1f7f-40b6-a3a1-02611a10945a",
        "actionerId": "1219c8e2-c0c2-4efc-9323-6ee9062e9c1f",
        "applicationIds": [
          "2a6972a9-d332-458f-9c11-aa0eb74cfefc",
          "a1d7c8d2-be38-4530-8c61-b32245f94f0c",
          "def77957-1818-4fd5-b052-004777acb6fa",
          "96ebce2f-f9c0-44f6-a92f-6f476e08b678",
          "563215b9-b819-4ec5-b983-88174f26e390"
        ],
        "comment": "a comment",
        "createInstant": 1505762615056,
        "email": {
          "attachments": [],
          "bcc": [],
          "cc": [],
          "from": {
            "address": "moderator@yourorganization.com",
            "display": "Moderator"
          },
          "html": "<p>Please review the code of conduct to avoid being removed from the community.</p>",
          "replyTo": {
            "address": "no-reply@yourorganization.com",
            "display": "no-reply@yourorganization.com"
          },
          "subject": "You've received a Misconduct action",
          "text": "Please review the code of conduct to avoid being removed from the community.",
          "to": [
            {
              "address": "Allan249@example.com",
              "display": "Allan"
            }
          ]
        },
        "emailedUser": false,
        "expiry": 1408554564119,
        "id": "e502168a-b469-45d9-a079-fd45f83e0406",
        "localizedAction": "Mute",
        "localizedDuration": "2 days",
        "localizedOption": "soft",
        "localizedReason": "Misconduct",
        "notifyUser": true,
        "option": "soft",
        "phase": "start",
        "reason": "Misconduct",
        "reasonCode": "123",
        "tenantId": "e872a880-b14f-6d62-c312-cb40f22af465",
        "type": "user.action"
      }
    }

    Feedback

    How helpful was this page?

    See a problem?

    File an issue in our docs repo

    © 2021 FusionAuth
    Subscribe for developer updates