Create a User Action

Edit on GitHubEdit MD

This API is used to create an User Action. Specifying an Id on the URI will instruct FusionAuth to use that Id when creating the User Action. Otherwise, FusionAuth will generate an Id for the User Action.

Request#

Create a User Action with a randomly generated Id

POST/api/user-action

OpenAPI Spec

Create a User Action with the provided unique Id

POST/api/user-action/{userActionId}

OpenAPI Spec

Request Parameters#

userActionId UUID optional Defaults to secure random UUID Immutable

The Id to use for the new User Action. If not specified a secure random UUID will be generated.

Request Body#

userAction.cancelEmailTemplateId UUID optional

The Id of the Email Template that is used when User Actions are canceled.

userAction.endEmailTemplateId UUID optional

The Id of the Email Template that is used when User Actions expired automatically (end).

userAction.includeEmailInEventJSON Boolean optional

Whether to include the email information in the JSON that is sent to the Webhook when a user action is taken.

userAction.localizedNames Map<Locale, String> optional

A mapping of localized names for this User Action. The key is the Locale and the value is the name of the User Action for that language.

userAction.modifyEmailTemplateId UUID optional

The Id of the Email Template that is used when User Actions are modified.

userAction.name String required

The name of this User Action.

userAction.options Array optional

The list of User Action Options.

userAction.options[x].localizedNames Map<Locale, String> optional

A mapping of localized names for this User Action Option. The key is the Locale and the value is the name of the User Action Option for that language.

userAction.options[x].name String optional

The name of this User Action Option.

userAction.preventLogin Boolean optional Defaults to false

Whether or not this User Action will prevent user login. When this value is set to true the action must also be marked as a time based action. See temporal.

userAction.sendEndEvent Boolean optional Defaults to true

Whether or not FusionAuth will send events to any registered Webhooks when this User Action expires.

Prior to version 1.36.7 this value defaulted to false. The default value was modified to be true by default to reduce confusion because in most cases when utilizing User Action events, the end event is desired.

userAction.startEmailTemplateId UUID optional

The Id of the Email Template that is used when User Actions are started (created).

userAction.temporal Boolean optional Defaults to false

Whether or not this User Action is time-based (temporal). Time based actions are temporary and once expired the action will no longer be considered active and will not affect the user.

An action that prevents login must be time based.

Time based actions can still be applied to a user for an indefinite amount of time. A time based action is one that may be canceled or modified. A non time-based action may not be modified or canceled.

An example of a non time-based action would be a reward, such as sending a user a coupon. This action cannot be canceled, or modified. When a non time-based action is taken, it is immediately complete and will show up in the user action history.

userAction.userEmailingEnabled Boolean optional Defaults to false

Whether or not email is enabled for this User Action. If this is true, a checkbox will appear in the FusionAuth UI for this User Action that allows admins to specify that they want to email the User.

userAction.userNotificationsEnabled Boolean optional Defaults to false

Whether or not user notifications are enabled for this User Action. If this is true, a checkbox will appear in the FusionAuth UI for this User Action that allows admins to specify that they want to "notify users". What this does is send an additional flag named notifyUser in the event JSON that is sent to any registered Webhooks.

Example Request JSON

{
  "userAction": {
    "cancelEmailTemplateId": "00000000-0000-0000-0000-000000000001",
    "endEmailTemplateId": "00000000-0000-0000-0000-000000000002",
    "includeEmailInEventJSON": true,
    "localizedNames": {
      "de": "Dauerhaft Verbieten"
    },
    "modifyEmailTemplateId": "00000000-0000-0000-0000-000000000003",
    "name": "Permanently Ban",
    "options": [
      {
        "name": "Nicely",
        "localizedNames": {
          "de": "Schön"
        }
      },
      {
        "name": "Meanly",
        "localizedNames": {
          "de": "Bedeuten"
        }
      }
    ],
    "preventLogin": true,
    "sendEndEvent": true,
    "startEmailTemplateId": "00000000-0000-0000-0000-000000000004",
    "temporal": true,
    "userEmailingEnabled": true,
    "userNotificationsEnabled": true
  }
}

Response#

The response for this API contains the information for the User Action that was created.

Response Codes

Code	Description
200	The request was successful. The response will contain a JSON body.
400	The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present.
401	You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See Authentication.
500	There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty.
503	The search index is not available or encountered an exception so the request cannot be completed. The response will contain a JSON body.

Response Body#

userAction.active Boolean

Whether or not this User Action is active.

userAction.cancelEmailTemplateId UUID

The Id of the Email Template that is used when User Actions are canceled.

userAction.endEmailTemplateId UUID

The Id of the Email Template that is used when User Actions expired automatically (end).

userAction.id UUID

The Id of the User Action.

userAction.insertInstant Long

The instant when the User Action was created.

userAction.includeEmailInEventJSON Boolean

Whether to include the email information in the JSON that is sent to the Webhook when a user action is taken.

userAction.lastUpdateInstant Long

The instant when the User Action was last updated.

userAction.localizedNames Map<Locale, String>

A mapping of localized names for this User Action. The key is the Locale and the value is the name of the User Action for that language.

userAction.modifyEmailTemplateId UUID

The Id of the Email Template that is used when User Actions are modified.

userAction.modifyEmailTemplateId String

The name of this User Action.

userAction.options Array

The list of User Action Options.

userAction.options[x].localizedNames Map<Locale, String>

A mapping of localized names for this User Action Option. The key is the Locale and the value is the name of the User Action Option for that language.

userAction.options[x].name String

The name of this User Action Option.

userAction.preventLogin Boolean

Whether or not this User Action will prevent the User from logging in.

userAction.sendEndEvent Boolean

Whether or not FusionAuth will send events to any registered Webhooks when this User Action expires.

userAction.startEmailTemplateId UUID

The Id of the Email Template that is used when User Actions are started (created).

userAction.temporal Boolean

Whether or not this User Action is time-based (temporal). Time based actions are temporary and once expired the action will no longer be considered active and will not affect the user.

userAction.userEmailingEnabled Boolean

Whether or not email is enabled for this User Action. If this is true, a checkbox will appear in the FusionAuth UI for this User Action that allows admins to specify that they want to email the User.

userAction.userNotificationsEnabled Boolean

Whether or not user notifications are enabled for this User Action. If this is true, a checkbox will appear in the FusionAuth UI for this User Action that allows admins to specify that they want to "notify users". What is does is send an additional flag named notifyUser in the event JSON that is sent to any registered Webhooks.

Example Response JSON for a Single User Action

{
  "userAction": {
    "active": true,
    "cancelEmailTemplateId": "00000000-0000-0000-0000-000000000001",
    "endEmailTemplateId": "00000000-0000-0000-0000-000000000002",
    "id": "00000000-0000-0000-0000-000000000042",
    "includeEmailInEventJSON": true,
    "localizedNames": {
      "de": "Dauerhaft Verbieten"
    },
    "modifyEmailTemplateId": "00000000-0000-0000-0000-000000000003",
    "name": "Permanently Ban",
    "options": [
      {
        "name": "Nicely",
        "localizedNames": {
          "de": "Schön"
        }
      },
      {
        "name": "Meanly",
        "localizedNames": {
          "de": "Bedeuten"
        }
      }
    ],
    "preventLogin": true,
    "sendEndEvent": true,
    "startEmailTemplateId": "00000000-0000-0000-0000-000000000004",
    "temporal": true,
    "userEmailingEnabled": true,
    "userNotificationsEnabled": true
  }
}