Skip to content

Commit 53747ae

Browse files
finalized Flows documentation
1 parent 6ba4b5c commit 53747ae

File tree

11 files changed

+50
-29
lines changed

11 files changed

+50
-29
lines changed
1020 KB
Loading
196 KB
Loading
253 KB
Loading
6.59 MB
Loading
-1.1 MB
Loading
7.24 MB
Loading
1.11 MB
Loading
Lines changed: 43 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,77 +1,95 @@
11
# Get started with flows
22

3-
A **flow** defines the sequence of steps a user goes through during a specific interaction with your application. {{product_name}} supports building fully customizable flows for,
3+
A **flow** defines the sequence of steps a user goes through during a specific interaction with your application. {{product_name}} supports building fully customizable builds for the following flows.
44

55
- Self-registration
66
- Password recovery
7+
- Invited user registration
78

89
This guide introduces the **Flow Builder**, a visual environment with all the necessary elements to build flows that meet both security requirements and user experience goals.
910

10-
## Enter the flow builder
11+
## Access the flow builder
1112

12-
## Enable a flow
13-
14-
{{product_name}} provides default sequences for every flow in the flow builder. You can design and refine your customized flow at your own pace, keeping it disabled until you’re ready to share it. While your customized flow is disabled, users continue to experience the default flow. Once enabled, your users will seamlessly change to the customized experience you’ve created.
15-
16-
To enable a flow,
13+
You can access the flow builder by following the steps below:
1714

1815
1. On the {{product_name}} Console, go to **Flows**.
1916

20-
2. Select the flow you want to enable.
17+
2. Click on the card corresponding to the flow you want to build.
2118

22-
3. On the top-right corner of the screen, turn the toggle ON to enable the flow.
23-
24-
!!! Note
25-
26-
If you disable a customized flow, your users will automatically continue with the default experience until you’re ready to publish it again.
19+
3. [Build the flow](#build-a-flow) and [enable](#enable-a-flow) it.
2720

2821
## Build a flow
2922

30-
The **Flow builder** provides all the building blocks you need to create seamless user journeys. To get started, go to **Flows** in the {{product_name}} Console and select the flow you want to customize.
23+
The **Flow builder** provides all the building blocks you need to create seamless user journeys. For a selected flow, you can start building it using one of the methods below and use [flow elements](#reference-flow-elements) to customize it to your requirements.
3124

32-
You can begin building in one of the following ways:
25+
{% if product_name == "Asgardeo" %}
3326

3427
### Generate with AI
3528

3629
The **Generate with AI** feature converts plain-language instructions into a complete flow, allowing you to start quickly and customize components as needed.
3730

3831
![Flow builder AI]({{base_path}}/assets/img/guides/flows/flow-builder-generate-with-ai.png){: width="auto" style="display: block; margin: 0;"}
3932

40-
### Use Starter Templates
33+
{% endif %}
34+
35+
### Use a starter template
4136

4237
Starter templates give you a quick start with predefined flows that are easily customizable. Click the `+` button next to a template to add it to the flow.
4338

4439
![Starter Templates]({{base_path}}/assets/img/guides/flows/flow-builder-starter-templates.png){: width="auto" style="display: block; margin: 0;"}
4540

46-
### Build from Scratch
41+
### Build from scratch
4742

4843
Begin with a blank canvas and use the drag-and-drop interface to add steps, widgets, and components. This option gives you full control over the sequence, UI elements, and logic in the flow.
4944

5045
![Custom Flow]({{base_path}}/assets/img/guides/flows/flow-builder-custom-flow.png){: width="auto" style="display: block; margin: 0;"}
5146

52-
## Flow Elements
47+
## Enable a flow
48+
49+
{{product_name}} provides default sequences for every flow in the flow builder. You can design and refine your customized flow at your own pace, keeping it disabled until you’re ready to share it. While your customized flow is disabled, users continue to experience the default flow. Once enabled, your users will seamlessly change to the customized experience you’ve created.
50+
51+
To enable a flow,
52+
53+
1. On the {{product_name}} Console, go to **Flows**.
54+
55+
2. Select the flow you want to enable.
5356

54-
Flows are made up of different types of elements that work together to create the user journey. These elements let you control the structure, functionality, and appearance of each step in the flow.
57+
3. On the top-right corner of the screen, turn the toggle ON to enable the flow.
58+
59+
!!! Note
60+
61+
If you disable a customized flow, your users will automatically continue with the default experience until you’re ready to publish it again.
62+
63+
## Reference: Flow elements
64+
65+
Flow elements work together to create the user journey. They define the structure, functionality, and appearance of each step in the flow.
5566

5667
### Widgets
5768

58-
Widgets are reusable components that enhance the flow. Drag and drop widgets into your desired `view` to build a flow.
69+
Widgets are reusable components that enhance the flow. Drag and drop widgets into your desired view to build a flow.
5970

6071
![Widgets]({{base_path}}/assets/img/guides/flows/flow-builder-widgets.gif){: width="auto" style="display: block; margin: 0;"}
6172

6273
### Steps
6374

64-
Steps are the core building blocks of a flow. Drag and drop steps to create a multi‑step user journeys.
75+
Steps are the core building blocks of a flow. Drag and drop steps to create a multi‑step user journey.
6576

6677
![Steps]({{base_path}}/assets/img/guides/flows/flow-builder-steps.gif){: width="auto" style="display: block; margin: 0;"}
6778

6879
### Components
6980

70-
Components are atomic UI elements added to steps. Drag and drop components inside a step.
81+
Components are atomic UI elements that you can add to a step. Drag and drop components inside a step.
7182

7283
!!! Note
73-
Field components such as **Text Inputs**, **Email Inputs**, etc. have the following constraints:
74-
- They must be added inside a **Form** component.
75-
- They must be mapped to a user attribute. Do this by clicking the pencil icon on the element action panel and selecting the relevant attribute from the `Attribute` dropdown. Only attributes set to display on the respective user profile in the [Attribute Configurations]({{base_path}}/guides/users/attributes/manage-attributes) will be available for mapping.
84+
85+
Field components such as **Text Input** and **Email Input** etc. have the following contraints:
86+
87+
- Only a **Form** component can contain them.
88+
89+
- Must map to a user attribute. To do so,
90+
91+
- Click the pencil icon on the element action panel.
92+
93+
- From the **Attribute** dropdown, select the relevant attribute. Only attributes **displayed in user profiles** are available for mapping. Learn how to [display attributes in user profiles]({{base_path}}/guides/users/attributes/manage-attributes/#configure-attributes).
7694

7795
![Components]({{base_path}}/assets/img/guides/flows/flow-builder-components.gif){: width="auto" style="display: block; margin: 0;"}

en/includes/guides/flows/index.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,10 @@ A flow defines the sequence a user follows during a specific interaction with yo
88

99
- **Password recovery** - Build secure recovery flows to help users regain access, using steps such as email verification or one time passwords (OTP).
1010

11+
- **Invited user registration** - Build flow that allows new users to securely set their password when an administrator creates their account, including steps to verify the user's identity.
12+
1113
You can build flows using starter templates, widgets, steps, and components, giving you complete control over how users interact with your application. To get started with building flows, refer to [Build a flow]({{base_path}}/guides/flows/build-a-flow/).
1214

13-
For specific examples of building flows, refer to [Self-registration]({{base_path}}/guides/flows/self-registration) and [Password recovery]({{base_path}}/guides/flows/password-recovery).
15+
For specific examples of building flows, refer to [Self-registration]({{base_path}}/guides/flows/self-registration/), [Password recovery]({{base_path}}/guides/flows/password-recovery/) and [Invited user registration]({{base_path}}/guides/flows/invited-user-registration/).
1416

1517
![Flows]({{base_path}}/assets/img/guides/flows/flow-builder-steps.gif){: width="auto" style="display: block; margin: 0;"}

en/includes/guides/flows/password-recovery.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -75,12 +75,12 @@ If users change their minds or click the button by accident, they should be able
7575

7676
The default password reset screen only asks to enter the new password once. You can make it more secure by asking the user to confirm the entered password before submission. To do so,
7777

78-
1. Navigate to the `Reset Password` view and click the pencil icon on the **Password field**.
78+
1. Navigate to the Reset Password view and click the pencil icon on the Password field.
7979

8080
2. Tick the **Require Confirmation** checkbox.
8181

8282
3. Click **Save Draft** to save your changes. When ready, toggle the switch on the top right corner to **Enable** and publish the updated flow.
8383

84-
![Step 3]({{base_path}}/assets/img/guides/flows/flow-password-recovery-step-03.gif){: width="auto" style="display: block; margin: 0;"}
84+
![Step 3]({{base_path}}/assets/img/guides/flows/flow-password-recovery-step-03.gif){: width="auto" style="display: block; margin: 0;"}
8585

8686
Now that these changes are in place, you have built a secure and user-friendly password recovery flow.

0 commit comments

Comments
 (0)