Merge pull request #5355 from AfraHussaindeen/resend-account-confirmation-doc

Add documentation for supporting resending account verification email

Author: AfraHussaindeen

en/asgardeo/docs/assets/img/guides/organization/self-service/customer/resend-account-verification-email-immediate-account-activation-disabled.png

@@ -1 +1,4 @@
+{% set host_name = "api.asgardeo.io/t/{organization_name}" %}
+{% set host_name_example = "api.asgardeo.io/t/bifrost" %}
+
 {% include "../../../../../includes/guides/account-configurations/user-onboarding/self-registration.md" %}

en/asgardeo/docs/assets/img/guides/organization/self-service/customer/resend-account-verification-email-immediate-account-activation-enabled.png

@@ -1 +1,4 @@
+{% set host_name = "localhost:9443" %}
+{% set host_name_example = "localhost:9443" %}
+
 {% include "../../../../../../includes/guides/account-configurations/user-onboarding/self-registration.md" %}

en/asgardeo/docs/guides/account-configurations/user-onboarding/self-registration.md

@@ -171,5 +171,112 @@ Note the following details in the response payload:
 
     - The `accountConfirmedTime` parameter will only be available under the same schema when email verification is successful for self-registered users.
 
-Once you have identified the `emailVerified` status of the user and the method by which the user is onboarded (self-registration or onboarded by an administrator), you can enforce any access restrictions for that user through your application logic.
+Once you have identified the `emailVerified` status of the user and the method used to onboard the user (either through self-registration or by an administrator), you can enforce any access restrictions through your application logic.
 
+{% if product_name == "Asgardeo" or (product_name == "WSO2 Identity Server" and is_version > "7.1.0" ) %}
+## Resend account verification email
+
+!!! tip
+
+    To implement this scenario, you must enforce account verification for self-registered users and activate accounts immediately without waiting for verification.</br></br> Learn more in [enable/disable self-registration](#enabledisable-self-registration).
+
+{% if product_name == "Asgardeo" %}
+- To resend the account verification email for the authenticated user, use the curl command shown below.
+{% else %}
+- To resend the account verification email for the authenticated user, use the [Self Resend Code API]({{base_path}}/apis/use-the-self-sign-up-rest-apis/#tag/Self-Register/paths/~1me~1resend-code/post) as shown below.
+{% endif %}
+
+!!! abstract ""
+
+    === "Request format"
+
+        ```curl
+        curl -X 'POST' \
+        'https://{{ host_name }}/api/identity/user/v1.0/me/resend-code' \
+        -H 'Authorization: Bearer <access_token>' \
+        -H 'Content-Type: application/json' \
+        -d '{
+            "properties": [
+                {
+                    "key": "RecoveryScenario",
+                    "value": "SELF_SIGN_UP"
+                }
+            ]
+        }'
+        ```
+    === "Sample request"
+
+        ```curl
+        curl -X 'POST' \
+        'https://{{ host_name_example }}/api/identity/user/v1.0/me/resend-code' \
+        -H 'Authorization: Bearer <access_token>' \
+        -H 'Content-Type: application/json' \
+        -d '{
+            "properties": [
+                {
+                    "key": "RecoveryScenario",
+                    "value": "SELF_SIGN_UP"
+                }
+            ]
+        }'
+        ```
+
+    ---
+    **Response**
+    ```
+    HTTP/1.1 201 Created
+    ```
+
+{% if product_name == "Asgardeo" %}
+- To resend the account verification email for other users, use the curl command shown below.
+{% else %}
+- To resend the account verification email for other users, use the [Resend Code API]({{base_path}}/apis/use-the-self-sign-up-rest-apis/#tag/Self-Register/paths/~1resend-code/post) as shown below.
+{% endif %}
+
+!!! abstract ""
+
+    === "Request format"
+
+        ```curl
+        curl -X 'POST' \
+        'https://{{ host_name }}/api/identity/user/v1.0/resend-code' \
+        -H 'Authorization: Bearer <access_token>' \
+        -H 'Content-Type: application/json' \
+        -d '{
+            "user": {
+                "username": "<USERNAME>",
+                "realm": "<REALM>"
+            },
+            "properties": [{
+                "key": "RecoveryScenario",
+                "value": "SELF_SIGN_UP"
+                }]
+            }'
+        ```
+    === "Sample request"
+
+        ```
+        curl -X 'POST' \
+        'https://{{ host_name_example }}/api/identity/user/v1.0/resend-code' \
+        -H 'Authorization: Bearer <access_token>' \
+        -H 'Content-Type: application/json' \
+        -d '{
+            "user": {
+                "username": "bob",
+                "realm": "PRIMARY"
+            },
+            "properties": [{
+                "key": "RecoveryScenario",
+                "value": "SELF_SIGN_UP"
+                }]
+            }'
+        ```
+
+    Ensure that the username provided is without the user store domain prefix, and the realm parameter specifies the relevant user store domain name.
+    
+    ---
+    **Response**
+    ```
+    "HTTP/1.1 201 Created"
+    ```
+{% endif %}

en/identity-server/next/docs/assets/img/guides/organization/self-service/customer/resend-account-verification-email-immediate-account-activation-disabled.png

@@ -55,6 +55,17 @@ The user can follow the steps below to sign up using an email.
 
 3. Click **Sign Up** to create the account.
 
-4. If **Account Verification** is enabled, the user can confirm the account from the email.
+4. If **Account Verification** enabled, the user can confirm the account from the email.
 
-    ![Account verification email notification]({{base_path}}/assets/img/guides/organization/self-service/customer/account-verification-email.png){: width="500" style="display: block; margin: 0; border: 0.3px solid lightgrey;"}
+    ![Account verification email notification]({{base_path}}/assets/img/guides/organization/self-service/customer/account-verification-email.png){: width="500" style="display: block; margin: 0; border: 0.3px solid lightgrey;"}
+
+{% if product_name == "Asgardeo" or (product_name == "WSO2 Identity Server" and is_version > "7.1.0" ) %}
+5. If **Account Verification** enabled, users can resend the account verification email if needed.
+    - If **Activate Account Immediately** enabled, after successfully logging into My Account, a warning message with a resend link will appear. Click this link to resend the account verification email.
+
+        ![Immediate Activation Enabled Warning]({{base_path}}/assets/img/guides/organization/self-service/customer/resend-account-verification-email-immediate-account-activation-enabled.png){: width="600" style="display: block; margin: 0; border: 0.3px solid lightgrey;"}
+
+    - If **Activate Account Immediately** disabled, attempting to log in to **My Account**, will display a warning message indicating the account lacks activation, along with a resend link. Click this link to resend the account verification email.
+
+        ![Immediate Activation Disabled Warning]({{base_path}}/assets/img/guides/organization/self-service/customer/resend-account-verification-email-immediate-account-activation-disabled.png){: width="400" style="display: block; margin: 0; border: 0.3px solid lightgrey;"}
+{% endif %}