Use case: Configure registration email invites in ForgeRock Identity Cloud

Use case overview

The sending of registration invites to new users is a common use case that is easily implemented in ForgeRock Identity Cloud. This allows you to send an email to a new user with a link inviting them to register an account.

This simple use case demonstrates how to create a journey that prompts a new user to enter their email address. It then sends a registration email with a link for the user to finalize the registration. Once the user has completed the registration details, a user account is created in Identity Cloud.

Steps to achieve this use case

  1. Sign in to the Identity Cloud admin UI using your admin tenant URL, in the format https://<tenant-name>/am/XUI/?realm=/#/.

  2. Go to Journeys > New Journey.

  3. Enter a unique name for the journey, select which identities will authenticate using this journey, (optionally) enter a journey description, and click Save.

  4. Create a journey similar to this:

    Node descriptions:

    • Attribute Collector - Collects the values of attributes for use later in the flow. In this case, we’ll collect the user’s email address. See the Attribute Collector node for further information.
    • Email Suspend Node - Generates and sends an email to a user, based on an email template. See Email Suspend node for further information.
    • Page Node node descriptions:
      • Platform Username - Prompts the user to enter their username, and stores it in a configurable state attribute. See Platform Username node for more information.
      • Attribute Collector - Collects the values of attributes to populate the new account. See the Attribute Collector node for further information.
      • Platform Password - Collects the user’s password. See Platform Password node for more information.
      • KBA Definition - Collects Knowledge-Based Authentication (KBA) questions and answers and saves them to the user’s profile. See KBA Definition node for more information.
      • Terms and Conditions Decision - Verifies the user has accepted the active set of terms and conditions. See Terms and Conditions Decision node for more information.
    • Create Object - Creates a new user object in Identity Cloud based on information collected during registration. See Create Object node for further information.
    • Increment Login Count - Increments the successful login count property of a managed object. See Increment Login Count node for further information.
  5. Click on the initial Attribute Collector node and enter mail in the Attributes to Collect field.

  6. Click on the Email Suspend node and add the message that will inform the user that an email has been sent. For example, “An email has been sent to the address you entered. Click the link in that email to finalize the process”.

    Note that the Email Suspend node uses the “registration” email template. You can configure this template in Email > Templates > Registration. See Using email templates for further information.

  7. Click Done and then Save.

  8. Click on the Page Node and enter an appropriate Page Header and Page Description. These will be displayed to the user when they finalize their registration. For example:

    • Page Header: Finalize your registration
    • Page Description: You have been invited to register, please finalize your registration.

  9. Click on the Attribute Collector node (on the Page Node):

    • Enter the attributes to be collected from the user when they register an account, in this case, givenName, sn, mail, preferences/marketing, preferences/updates.
    • Select the All Attributes Required and Validate Input check boxes.

  10. Click Save to save the journey.

Testing the use case

To test the use case, ensure that your test end user has an email address that you can access.

  1. In the Identity Cloud admin UI, go to Journeys.

  2. Click the registration journey you created in the previous steps and copy the Preview URL.

  3. Paste the preview URL into a browser using Incognito or Browsing mode.

  4. Enter the test user’s email address and click Next.

    A message is displayed with the instruction text you configured in the journey.

  5. Locate and open the email message in the test user’s inbox. The email message will look similar to this:

  6. Click the Email Verification Link.

  7. Finalize the registration by completing the details.

  8. Click Next.

    Once the user’s account has been created you are successfully logged in as the test user.

Additional resources


Training videos: