Merge pull request #296 from aspnetzero/features-passwordless-login

Add `feature passwordless login` documents
aspnetzero · Apr 3, 2024 · ab76087 · ab76087
2 parents d5ec457 + 9ccd066
commit ab76087
Show file tree

Hide file tree

Showing 9 changed files with 55 additions and 1 deletion.
diff --git a/docs/en/Features-Passwordless-Login.md b/docs/en/Features-Passwordless-Login.md
@@ -0,0 +1,46 @@
+# Passwordless Login
+
+ASP.NET Zero provides passwordless login feature out of the box, but it is disabled by default. It can be enabled in the `User Management` tab, on the host settings page. 
+
+When a user requests to login using passwordless login feature, a 6-digit unique code will be sent to users email address or phone number depending on users selection on passwordless login page. 
+
+- A Passwordless login code can be used only once.
+- When a passwordless login code is verified, it can't be used anymore.
+
+![Passwordless login settings](images/passwordless-login-settings.png)
+
+In a multi-tenant application, passwordless login is available to tenants if it's enabled in the host settings. Additionally, depending on which type of passwordless login verification is active, tenants also have the option to enable or disable the active type on the settings page.
+
+If any of the passwordless login options are turned on, a section for passwordless login will be displayed on the login screen as shown in the screenshot below.
+
+![Passwordless login click here](images/passwordless-login-click-here.png)
+
+If a user wants to log in using passwordless login, the user will be directed to the verification screen for authentication after clicking on the `click here` link.
+
+## Verification Type
+
+The current options for passwordless login verification include **Email** and **SMS** authentication methods.
+
+If multiple verification types are active, the selection screen for verification types appears as shown below.
+
+![Passwordless login verification type](images/passwordless-login-verification-type.png)
+
+### Email Verification
+
+If only the email verification type is active, the screen for entering the email address is displayed as shown below.
+
+![Passwordless login email verification](images/passwordless-login-email-verification.png)
+
+### SMS Verification
+
+If only SMS verification is active, the screen for entering the phone number will appear as shown below.
+
+![Passwordless login sms verification](images/passwordless-login-sms-verification.png)
+
+## Verify Passwordless Code
+
+After filling in the necessary fields according to the chosen verification type, a verification code will be sent to the selected method (Email or SMS) for authentication.
+
+![Passwordless login verify passwordless code](images/passwordless-login-verify-passwordless-code.png)
+
+After entering the verification code correctly, user will be authenticated and redirected to the home page of the application.
diff --git a/docs/en/images/passwordless-login-click-here.png b/docs/en/images/passwordless-login-click-here.png
diff --git a/docs/en/images/passwordless-login-email-verification.png b/docs/en/images/passwordless-login-email-verification.png
diff --git a/docs/en/images/passwordless-login-settings.png b/docs/en/images/passwordless-login-settings.png
diff --git a/docs/en/images/passwordless-login-sms-verification.png b/docs/en/images/passwordless-login-sms-verification.png
diff --git a/docs/en/images/passwordless-login-verification-type.png b/docs/en/images/passwordless-login-verification-type.png
diff --git a/docs/en/images/passwordless-login-verify-passwordless-code.png b/docs/en/images/passwordless-login-verify-passwordless-code.png
diff --git a/docs/en/nav-aspnet-core-angular.json b/docs/en/nav-aspnet-core-angular.json
@@ -40,6 +40,10 @@
                 {
                   "text": "Token Based Authentication",
                   "path": "Features-Angular-Token-Based-Authentication.md"
+                },
+                {
+                  "text": "Passwordless Login",
+                  "path": "Features-Passwordless-Login.md"
                 }
               ]
             },

diff --git a/docs/en/nav-aspnet-core-mvc.json b/docs/en/nav-aspnet-core-mvc.json
@@ -30,7 +30,11 @@
                 {
                   "text": "Forgot Password",
                   "path": "Features-Mvc-Core-Forgot-Password.md"
-                }
+                },
+                {
+                  "text": "Passwordless Login",
+                  "path": "Features-Passwordless-Login.md"
+                }                
               ]
             },
             {