Use Cases: Configure an update policy form using Forms

Forms for Actions allows you to create custom privacy policies flows and store the consent under the app_metadata object.

The sections below outline how you can create an Update Policy form using nodes and flows, along with steps for adding your form to a Post Login Action.

To create a new information gathering form, follow these steps:

1. Navigate to Auth0 Dashboard > Actions > Forms.

2. Select Actions > Forms to open the Form editor in a new tab.

3. Select Create form > Start from scratch.

By default, a new form contains a Start node, a Step node, and an Ending screen node.

The Step node is the graphical interface visible to users. Add Fields to the Step node to collect the new agreement acceptance value by following these steps:

1. Drag a Rich text field from the Components menu into the Step node.

   • Rich text: Enter a description of your privacy policies updates.

2. Drag a Legal field into the Step node.

   • ID: Enter privacy_policies.

   • Required: Enable the checkbox.

   • Legal: Enter I agree to the Privacy Policy.

3. Select Publish to save.

Add a Flow node after the Step node to update the app_metadata and resume the authentication flow by following these steps:

Step 1 - Create FlowStep 2 - Add Flow Actions

1. Select Flow from the bottom of the Form editor.

2. Remove the existing link between the Step and Ending Screen nodes.

3. Select the new Flow > Click to add a flow > Create a new flow.

   • Enter Update app_metadata in the Name field.

   • Select Create.

4. Link the Flow node to the Step and Ending Screen nodes as pictured below.

5. Select Publish to save.

Retrieve your form embed code to visually render the form with a custom Post Login Action by following these steps:

• From the Form editor, select Embed.

• Select Copy.

Create a custom Post Login Action to render your form by following these steps:

1. Navigate to Auth0 Dashboard > Actions > Flows > Login.

2. Select Custom.

3. Select the + icon to Build from scratch:

   • Name: Enter Render Update Policy Form.

   • Trigger: Select Login / Post Login.

   • Runtime: Select the recommended version.

4. Select Create.

To configure the custom Action:

1. Delete the existing code from the Code editor.

2. Paste the form embed code into the Code editor.

3. Edit the code to define the conditional logic that will render the form.

   /**
   * @param {Event} event - Details about the user and the context in which they are logging in.
   * @param {PostLoginAPI} api - Interface whose methods can be used to change the behavior of the login.
   */
   exports.onExecutePostLogin = async (event, api) => {
     const FORM_ID = 'REPLACE_WITH_YOUR_FORM_ID';
   
     if (event.user.app_metadata.privacy_policies !== true) {
       api.prompt.render(FORM_ID);
     }
   }
   
   exports.onContinuePostLogin = async (event, api) => { }

   Was this helpful?

   Yes /No
   The example code above will render the form when a user is missing the app metadata privacy_policies property. 

4. Select Deploy.

5. Drag and Drop the Render Update Policy Form Action to the Login flow.

   

6. Select Apply.

Test the implementation by following these steps:

1. Log in with an existing user whose user_metadata attribute privacy_policies does not have a value.

2. The custom Post Login Action in the Login flow will render the form and prompt for acceptance.

3. Select Auth0 Dashboard > User Management > Users, locate the user and verify that the app_metadata attribute privacy_policies contains a true value and a timestamp.