Skip to content

Commit 46325b4

Browse files
inititated inivited user registration doc
1 parent 057490a commit 46325b4

File tree

11 files changed

+93
-43
lines changed

11 files changed

+93
-43
lines changed

.vale/styles/Microsoft/Acronyms.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ first: '\b([A-Z]{3,5})\b'
88
second: '(?:\b[A-Z][a-z]+ )+\(([A-Z]{3,5})\)'
99
# ... with the exception of these:
1010
exceptions:
11+
- OTP
12+
- SMS
1113
- API
1214
- ASP
1315
- CLI

.vale/styles/Microsoft/Dashes.yml

Lines changed: 0 additions & 13 deletions
This file was deleted.

.vale/styles/Microsoft/HeadingAcronyms.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,4 @@ tokens:
77
- '[A-Z]{2,4}'
88
exceptions:
99
- IP
10+
- SMS OTP

en/base.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -171,6 +171,9 @@ extra:
171171
Password Recovery:
172172
type: Preview
173173
level: 3
174+
Invited User Registration:
175+
type: Preview
176+
level: 3
174177

175178
nav_icons:
176179
Overview:
156 KB
Loading
2.4 MB
Loading
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{% include "../../../../../includes/guides/flows/invited-user-registration.md" %}

en/identity-server/next/mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -681,6 +681,7 @@ nav:
681681
- Get Started: guides/flows/build-a-flow.md
682682
- Self Registration: guides/flows/self-registration.md
683683
- Password Recovery: guides/flows/password-recovery.md
684+
- Invited User Registration: guides/flows/invited-user-registration.md
684685
- User self-service:
685686
- User self-service: guides/user-self-service/index.md
686687
- Self-service portal:
Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# Invited user registration <div class="md-chip md-chip--preview"><span class="md-chip__label">Preview</span></div>
2+
3+
**Invited User Registration** allows users to securely set their credentials after an administrator registers them in {{product_name}}.
4+
5+
Once registered, the user receives an email to complete the sign-in process or use a link provided by the administrator offline. The user then clicks the email or link, verify their identity through a secure method (like an SMS or email OTP), and then set up a password.
6+
7+
In the **Flow Builder**, you can create the invited user registration journey in two ways:
8+
9+
- **Use a starter template** – Load a ready made flow and customize it to your needs.
10+
11+
- **Build from scratch** – Take full control by designing every step yourself.
12+
13+
## Sample use case
14+
15+
Imagine you want to verify the user’s identity via **SMS OTP** before allowing them to reset their password. The flow works as follows:
16+
17+
- The user clicks the link in the invitation email or pastes the URL in their browser.
18+
- A **one-time code** is sent to their registered mobile number.
19+
- The user verifies the code.
20+
- The user sets their password.
21+
22+
This ensures that only users with access to the registered mobile number can complete the registration, enhancing security.
23+
24+
![Invited user registration flow]({{base_path}}/assets/img/guides/flows/flow-builder-invited-user-registration-final-flow.png){: width="auto" style="display: block; margin: 0;"}
25+
26+
## Build it
27+
28+
To build the sample use case, we'll start from the **Invited User Registration** template and adjust it to:
29+
30+
- Use **SMS OTP** for identity verification.
31+
- Require users to confirm their new password during reset.
32+
33+
### Step 1 - Load the Invited User Registration Template
34+
35+
![Step 1]({{base_path}}/assets/img/guides/flows/flow-invited-user-registration-step-01.gif){: width="auto" style="display: block; margin: 0;"}
36+
37+
1. Navigate to **Home** > **Flows**.
38+
39+
2. Click on the **Invited User Registration** card.
40+
41+
3. Click the `+` button next to the **Invited User Registration** template.
42+
43+
### Step 2 - Add an SMS OTP verification step
44+
45+
This step verifies the user's mobile number provided during the registration before allowing them to set their password.
46+
47+
1. Expand **Steps**, drag **Blank View** onto the canvas and place it between **Confirmation Code** and **Set Password**.
48+
49+
![Step 2.1]({{base_path}}/assets/img/guides/flows/flow-invited-user-registration-step-02-1.gif){: width="auto" style="display: block; margin: 0;"}

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

Lines changed: 23 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
1-
# Password Recovery <div class="md-chip md-chip--preview"><span class="md-chip__label">Preview</span></div>
1+
# Password recovery <div class="md-chip md-chip--preview"><span class="md-chip__label">Preview</span></div>
22

33
Password recovery allows users to reset their accounts when they lose access. This involves verifying their identity through a secure method, such as an email or SMS code, before letting them set a new password.
44

55
In the **Flow Builder**, you can create a password recovery journey in two ways:
66

7-
- **Use a starter template**Quickly load a ready made flow and customize it to your needs.
7+
- **Use a starter template**Load a ready made flow and customize it to your needs.
88

9-
- **Build from scratch**Design every step yourself for complete control.
9+
- **Build from scratch**Take full control by designing every step yourself.
1010

11-
## Sample Use Case
11+
## Sample use case
1212

13-
A common recovery journey is to verify the user’s identity via **Email OTP** before allowing them to reset their password. The flow works as follows:
13+
Imagine you want to verify the user’s identity via **Email OTP** before allowing them to reset their password. The flow works as follows:
1414

1515
- The user enters their **username**.
1616
- A **one-time code** is sent to their registered email.
@@ -21,7 +21,7 @@ To improve the default template, we’ll add a **“Back to application”** lin
2121

2222
![Final Flow]({{base_path}}/assets/img/guides/flows/flow-builder-password-recovery-final-flow.png){: width="auto" style="display: block; margin: 0;"}
2323

24-
## Building the Sample Use Case
24+
## Build it
2525

2626
This password recovery journey is based on the **Email OTP template**. Starting from the template, we’ll adjust it to:
2727

@@ -34,29 +34,35 @@ Follow the steps below to configure this flow.
3434

3535
![Step 1]({{base_path}}/assets/img/guides/flows/flow-password-recovery-step-01.gif){: width="auto" style="display: block; margin: 0;"}
3636

37-
1. Navigate to **HomeFlows**.
38-
2. Click on the the **password recovery** card.
37+
1. Navigate to **Home** > **Flows**.
38+
2. Click on the **password recovery** card.
3939
3. Click the `+` button next to the **Password Recovery with Email OTP** template.
4040

41-
### Step 2 – Add a “Back to application” Link
41+
### Step 2 – Add a “Back to application” link
4242

4343
If a user changes their mind or clicks the wrong option, they should have an easy way back to the application. Let’s make that possible by adding a link at the bottom of the `Forgot Password?` screen.
4444

45-
1. Navigate to the **Components** section and drag and drop a **Rich Text** component to the **Forgot Password?** view.
46-
![Step 2.1]({{base_path}}/assets/img/guides/flows/flow-password-recovery-step-02-1.gif){: width="auto" style="display: block; margin: 0;"} <br>
45+
1. From the **Components** section, drag and drop a **Rich Text** component to the **Forgot Password?** view.
46+
47+
![Step 2.1]({{base_path}}/assets/img/guides/flows/flow-password-recovery-step-02-1.gif){: width="auto" style="display: block; margin: 0;"} <br>
48+
49+
2. Configure the Rich Text. To do so,
50+
51+
- In the Rich Text Editor, type: `Back to application`.
52+
53+
- Change the style to **Heading 5** and **center align**.
54+
55+
- Highlight the text, click the **Link** button, then click **Edit** in the popup window.
4756

48-
2. Configure the Rich Text <br>
49-
2.1. In the Rich Text Editor, type: `Back to application`.
50-
2.2. Change the style to **Heading 5** and **center align**.
51-
2.3. Highlight the text, click the **Link** button, then click **Edit** in the popup window.
5257
![Step 2.2]({{base_path}}/assets/img/guides/flows/flow-password-recovery-step-02-2.gif){: width="auto" style="display: block; margin: 0;"} <br>
5358

5459
3. From the dropdown, select **Callback or Application Access URL** and save.
55-
![Step 2.3]({{base_path}}/assets/img/guides/flows/flow-password-recovery-step-02-3.gif){: width="auto" style="display: block; margin: 0;"} <br>
60+
61+
![Step 2.3]({{base_path}}/assets/img/guides/flows/flow-password-recovery-step-02-3.gif){: width="auto" style="display: block; margin: 0;"} <br>
5662

5763
4. Click **Save Draft** to keep your progress.
5864

59-
### Step 3 – Require Password Confirmation
65+
### Step 3 – Require password confirmation
6066

6167
The default reset screen asks for a new password once. Let’s make it more secure by requiring the user to confirm their password before submission.
6268

0 commit comments

Comments
 (0)