Merge pull request #5508 from sadilchamishka/update-docs-invite-user-password

Update documentation for invite user to set password

Author: sadilchamishka

en/asgardeo/docs/assets/img/guides/account-configurations/invite-user-to-set-password.png

@@ -0,0 +1 @@
+{% include "../../../../../includes/guides/account-configurations/user-onboarding/invite-user-to-set-password.md" %}

en/asgardeo/docs/guides/account-configurations/user-onboarding/invite-user-to-set-password.md

@@ -158,6 +158,7 @@ plugins:
         'guides/user-accounts/account-security/login-attempts-security.md': 'guides/account-configurations/login-security/login-attempts.md'
         'guides/user-accounts/account-security/password-validation.md': 'guides/account-configurations/login-security/password-validation.md'
         'guides/user-accounts/configure-self-registration.md': 'guides/account-configurations/user-onboarding/self-registration.md'
+        'guides/identity-lifecycles/invitation-workflow.md': 'guides/account-configurations/user-onboarding/invite-user-to-set-password.md'
         'guides/organization-management/invite-parent-organization-users.md': 'guides/organization-management/onboard-users.md'
         'guides/organization-management/email-domain-based-organization-discovery.md': 'guides/organization-management/organization-discovery/email-domain-based-organization-discovery.md'
         'apis/organization-apis/org-application-management.md': 'apis/organization-apis/shared-application-management.md'
@@ -407,6 +408,7 @@ nav:
         - User onboarding:
           - Self-registration: guides/account-configurations/user-onboarding/self-registration.md
           - Self-registration flow: guides/account-configurations/user-onboarding/self-registration-flow.md
+          - Invite user to set password: guides/account-configurations/user-onboarding/invite-user-to-set-password.md
         - Manage login identifiers:
           - Configure username validation: guides/account-configurations/account-login/username-validation.md
           - Configure alternative login identifiers: guides/user-accounts/account-login/configure-login-identifiers.md

en/asgardeo/mkdocs.yml

@@ -6,17 +6,80 @@ Allow administrator to invite users to set their own passwords during the onboar
 
 For inviting users to set their password, follow these instructions:
 
+{% if (is_version is defined and is_version > "7.1.0") or product_name == "Asgardeo" %}
+1. On the {{product_name}} Console, go to **Login & Registration** > **User Onboarding** > **Invite User to Set Password**.
+2. Enable the **Invite User to Set Password** feature to invite user to set the password after user creation.
+3. From **Choose invitation method**, select Email Link to send an invitation link. Alternatively, select OTP (delivered via Email or SMS) to start the invitation flow.
+4. Set the **Invitation link/OTP expiry time** in minutes.
+This defines how long the password setup invitation email or OTP remains valid.
+    - For infinite validity, set -1
+    - Setting 0 causes immediate expiry
+5. If you want to send an account activation confirmation notification, enable the **Send account activation notification**.
+6. Select the **Lock account until password is set** to lock the user account during user creation.
+7. Configure the OTP code options from **OTP Code Configuration**: enable uppercase, lowercase, and numeric characters, then set the desired OTP code length.
+
+    !!! note
+        When using OTP invitation method, users can use the received OTP as a temporary password to log in. The system redirects users to the password setup page after login to create their permanent password.
+
+8. Click **Update** to save the changes.
+{% else %}
 1. On the {{product_name}} Console, go to **Login & Registration** > **User Onboarding** > **Invite User to Set Password**.
 2. Check the **Enable email invitations for user password setup** to send an email to the user to set the password after user creation.
 3. Select the **Enable account lock on creation** to lock the user account during user creation.
 4. If you want to send an account activation confirmation email, enable the **Send account activation email**.
 5. Set the **Password setup invitation code expiration time** in minutes to define how long the password setup invitation e-mail would be valid. For infinite validity period, set -1. Setting 0 will cause immediate expiry of the invitation.
 6. Click **Update** to save the changes.
+{% endif %}
 
 ![Invite User to Set Password Configuration]({{base_path}}/assets/img/guides/account-configurations/invite-user-to-set-password.png){: width="700" style="display: block; margin: 0;"}
 
 ## Parameters
 
+{% if (is_version is defined and is_version > "7.1.0") or product_name == "Asgardeo" %}
+<table>
+  <tr>
+    <th>Parameter</th>
+    <th>Description</th>
+  </tr>
+  <tr>
+    <td><code>Choose invitation method</code></td>
+    <td>Select the method for sending password setup invitations:<br>
+        • Email with password setup link<br>
+        • Email with OTP code<br>
+        • SMS with OTP code</td>
+  </tr>
+  <tr>
+    <td><code>Invitation link/OTP expiry time</code></td>
+    <td>Defines the validity period in minutes for the password setup invitation link or OTP.<br>
+        • Set -1 for infinite validity<br>
+        • Set 0 for immediate expiry</td>
+  </tr>
+  <tr>
+    <td><code>Send account activation notification</code></td>
+    <td>When enabled, users receive a confirmation notification after activating their account.</td>
+  </tr>
+  <tr>
+    <td><code>Lock account until password is set</code></td>
+    <td>When enabled, the system locks the user account upon creation until the user creates their password.</td>
+  </tr>
+  <tr>
+    <td><code>Include uppercase letters in OTP</code></td>
+    <td>When enabled, the generated OTP codes will include uppercase letters (A-Z).</td>
+  </tr>
+  <tr>
+    <td><code>Include lowercase letters in OTP</code></td>
+    <td>When enabled, the generated OTP codes will include lowercase letters (a-z).</td>
+  </tr>
+  <tr>
+    <td><code>Include numbers in OTP</code></td>
+    <td>When enabled, the generated OTP codes will include numeric digits (0-9).</td>
+  </tr>
+  <tr>
+    <td><code>OTP code length</code></td>
+    <td>Set the number of characters in the generated OTP codes.</td>
+  </tr>
+</table>
+{% else %}
 <table>
   <tr>
     <th>Parameter</th>
@@ -39,3 +102,4 @@ For inviting users to set their password, follow these instructions:
     <td>Defines the validity period in minutes for the password setup code sent to users. For infinite validity period, set -1.</td>
   </tr>
 </table>
+{% endif %}