Links

Create user account

The Create user account action node creates a new user in the solution or can optionally update an existing user. Roles can be assigned to determine the user's permissions. A welcome email can be automatically triggered, enabling the user to login immediately.

Usage

This action node is used when you would like client users to be able to give other people access to the apps in a solution. For example, a client user with a custom Administrator role may be granted the permission to add users with a Coordinator role.
Users in a solution must have unique email addresses. The default behavior of Create user account is to throw an error (UserAccountAlreadyExistException: Appfarm error code 14007) when run with an email that is already assigned to user in the solution. To allow existing users, and optionally update their User object, select the Accept Existing User checkbox.
When the action node successfully completes, the User object is immediately created in the database. It is not necessary to persist any changes.
Important
  • The user running this action node must have a role with the appropriate permissions to create a new user and assign any selected role. Read more under Users.
  • The appropriate user account manipulation properties must be enabled for the relevant environment.

Properties

Property
Description
Email
The user's email address. Must be unique in the solution. If the email is already registered in the solution and Accept Existing User is not selected, the action node will fail.
First Name
The user's first name.
Last Name
The user's last name.
Phone
The user's phone number.
Role Memberships
The roles that the user should be a member of.
Accept Existing User
Run the action node even if a user with the specified Email already exists in the solution. If this property is not selected and the user does already exist, the action node will fail. See Usage for more information. If Add to Data Source is configured, the User object will be added there. The welcome email will not be sent, even if Send Welcome Mail is selected.
Update User Properties
Available if Accept Existing User is selected. Update an existing user with the First Name, Last Name, and Phone values.
Add Roles
Available if Accept Existing User is selected. Add the roles selected under Role Memberships to an existing user.
Add to Data Source
Add the User object to the selected data source. If the data source is many-cardinality, the object will be added. If the data source is single-cardinality, the object will replace any existing object.
Send Welcome Mail
Send an email with a login link. This email template can be customized in a Login configuration, or overridden for this action node only by selecting Override Welcome Mail.
Override Welcome Mail
Available if Send Welcome Email is selected.
Override the subject and body of the welcome email.
Password Link TTL
Available if Override Welcome Email is selected.
Specify how long the reset password or login link in the welcome email will be valid, in seconds, up to a maximum of 1 week. The default is 86,400 seconds (24 hours).
Login Link Redirect Path
Available if Override Welcome Email is selected. Redirect the user to the specified path after they click the login link. The path must start at the domain root, for example: /READABLE_ID/VIEW_NAME/SUBVIEW_NAME?URL_PARAM=value.
Subject
Available if Override Welcome Email is selected. Override the subject of the welcome email.
Body Text Template
Available if Override Welcome Email is selected. Override the plain text email body. See Login configuration for available parameters.
Body HTML Template
Available if Override Welcome Email is selected. Override the HTML email body. See Login configuration for available parameters. A Body Text Template is also required when you specify an HTML template.