|
| 1 | +<h1>Self-register Flow Builder <div class="md-chip md-chip--preview"><span class="md-chip__label">Preview</span></div></h1> |
| 2 | + |
| 3 | +{: width="auto" style="display: block; margin: 0;"} |
| 4 | + |
| 5 | +!!! Note |
| 6 | + |
| 7 | + The self-registration Flow Builder is currently in **Preview**. Some features may be subject to changes in future releases. |
| 8 | + |
| 9 | +The self-registration Flow Builder provides administrators with a powerful tool to create fully customizable user registration experiences. Whether you're building a simple registration form or a complex, multi-step flow, the builder gives you complete control over the design and process. |
| 10 | + |
| 11 | +It includes a variety of starter templates, widgets, steps, and components, allowing you to define exactly how users will interact with your registration process. |
| 12 | + |
| 13 | +--- |
| 14 | + |
| 15 | +## Pre-requisites |
| 16 | + |
| 17 | +You need to **enable self-registration** inorder to try this out. |
| 18 | + |
| 19 | +!!! Note |
| 20 | + Learn how administrators can [enable self-registration]({{base_path}}/guides/user-self-service/configure-self-service-portal/#enabledisable-the-my-account-portal) in an organization. |
| 21 | + |
| 22 | +## Get Started |
| 23 | + |
| 24 | +### Enabling the flow builder |
| 25 | + |
| 26 | +!!! Warning |
| 27 | + Enabling the self-registration Flow Builder will override the exitsing self-registration experience in your organization. You can always revert back to the previous experience by [disabling the Flow Builder](#disabling the Flow Builder). |
| 28 | + |
| 29 | +To enable the self-registration Flow Builder, you have two options: |
| 30 | + |
| 31 | +#### Option 01: Enable from the Home page |
| 32 | + |
| 33 | +1. Navigate to the **Home** page. |
| 34 | +2. Click on the **Enable and try out** button inside the banner. |
| 35 | +3. In the feature preview dialog, toggle the feature status switch to **Enabled** mode and close the dialog. |
| 36 | +4. Click on the **Try out** button in the banner to access the Flow Builder. |
| 37 | + |
| 38 | +{: width="auto" style="display: block; margin: 0;"} |
| 39 | + |
| 40 | +#### Option 02: Enable from the Feature Preview |
| 41 | + |
| 42 | +1. Click on the user dropdown in the top right corner. |
| 43 | +2. Select **Feature Preview**. |
| 44 | +3. In the feature preview dialog, toggle the feature status switch to **Enabled** mode and close the dialog. |
| 45 | +4. Go to **Login & Registration**. |
| 46 | +5. Click on the **Registration Flow** card. |
| 47 | + |
| 48 | +{: width="auto" style="display: block; margin: 0;"} |
| 49 | + |
| 50 | +## Building your first flow |
| 51 | + |
| 52 | +The self-registration Flow Builder is designed to make creating user registration flows intuitive and efficient. With AI ✨ support, you can describe your ideal flow in natural language and let the builder generate it for you. |
| 53 | + |
| 54 | +Alternatively, you can start with pre-defined templates or build from scratch using the drag-and-drop interface. This flexibility allows you to create new flows or extend existing ones effortlessly. |
| 55 | + |
| 56 | +### Starter Templates |
| 57 | + |
| 58 | +Starter templates give you a quick start with pre-defined flows that are easily customizable. You can click on the `+` button next to the template to add it to the flow. |
| 59 | + |
| 60 | +{: width="auto" style="display: block; margin: 0;"} |
| 61 | + |
| 62 | +- **Generate with AI ✨** |
| 63 | + Describe your ideal registration flow in natural language, and Asgardeo will automatically generate a customized flow for you. |
| 64 | + |
| 65 | + {: width="auto" style="display: block; margin: 0;"} |
| 66 | + |
| 67 | +- **Blank** |
| 68 | + Start from scratch for full flexibility. |
| 69 | + |
| 70 | +- **Basic Details** |
| 71 | + Collect only basic user details such as name, email, and password. |
| 72 | + |
| 73 | +- **Basic + Google** |
| 74 | + Combine a basic form with Google sign-up for users preferring existing credentials. |
| 75 | + |
| 76 | +### Widgets |
| 77 | + |
| 78 | +Widgets are reusable components that enhance the registration flow. You can drag and drop widgets into your desired view to build a flow. |
| 79 | + |
| 80 | +{: width="auto" style="display: block; margin: 0;"} |
| 81 | + |
| 82 | +- **Username + Password** |
| 83 | + Traditional signup with username and password. |
| 84 | + |
| 85 | +- **Continue with Email OTP** |
| 86 | + Sign up with email and verify using a One-Time Password. |
| 87 | + |
| 88 | +- **Continue with Google** |
| 89 | + Sign up using Google credentials. |
| 90 | + |
| 91 | +### Steps |
| 92 | + |
| 93 | +Steps are the core building blocks of a registration flow. You can drag and drop steps to create a multi-step registration flow. |
| 94 | + |
| 95 | +{: width="auto" style="display: block; margin: 0;"} |
| 96 | + |
| 97 | +- **View** |
| 98 | + Each step acts as a view or section of the registration process. |
| 99 | + |
| 100 | +### Components |
| 101 | + |
| 102 | +Components are atomic UI elements added to steps. You can drag and drop components inside a step. |
| 103 | + |
| 104 | +!!! Note |
| 105 | + Field components such as **Text Inputs**, **Email Inputs**, etc. has the following constraints: |
| 106 | + |
| 107 | + - They should be added inside a **Form** component. |
| 108 | + - They should be mapped to a user Attribute. This can be done by clicking on the pensil icon on the element action panel and selcting the relevant attribute from the `Attribute` dropdown. Only attributes set as display on Self-Registration profile in the [Attribute Configurations]({{base_path}}/guides/users/attributes/manage-attributes) will be available for mapping. |
| 109 | + |
| 110 | +{: width="auto" style="display: block; margin: 0;"} |
| 111 | + |
| 112 | +- **Form** – Group fields for registration details |
| 113 | +- **Text Input** – Basic input for names/usernames |
| 114 | +- **Password Input** – Hidden input for passwords |
| 115 | +- **Email Input** – Field for email addresses |
| 116 | +- **Phone Input** – Collect phone numbers |
| 117 | +- **Number Input** – For numeric values |
| 118 | +- **Date Input** – Collect dates |
| 119 | +- **OTP Input** – Enter One-Time Passwords |
| 120 | +- **Checkbox** – For agreements like terms and conditions |
| 121 | +- **Button** – Triggers actions (e.g., submit) |
| 122 | +- **Text** – Add static instructions/explanations |
| 123 | +- **Divider** – Visually separate sections |
| 124 | +- **Image** – Add images like logos/icons |
| 125 | + |
| 126 | +### Disabling the flow builder |
| 127 | + |
| 128 | +If you want to revert back to the previous self-registration experience, you can disable the self-registration Flow Builder by following these steps: |
| 129 | + |
| 130 | +1. Click on the user dropdown in the top right corner. |
| 131 | +2. Select **Feature Preview**. |
| 132 | +3. In the feature preview dialog, toggle the feature status switch to **Disabled** mode and close the dialog. |
0 commit comments