libre.sh/keycloak-scim
2
0
Fork 0
Code Issues 14 Pull requests Releases Packages Activity Actions 6

Reapply login settings topics

Browse source
This commit is contained in:
Andy Munro 2021-02-11 15:45:00 -05:00 committed by Marek Posolda
parent 62e78c0f2e
commit 9b0263f580
3 changed files with 33 additions and 30 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
server_admin/topics/login-settings.adoc
View file

@ -1,4 +1,4 @@
== Login Page Settings
There are several nice built-in login page features you can enable if you need the functionality.
{project_name} includes several built-in login page features.

43
server_admin/topics/login-settings/forgot-password.adoc
View file

@ -1,34 +1,41 @@
=== Forgot Password
If you enable it, users are able to reset their credentials if they forget their password or lose their OTP generator.
Go to the `Realm Settings` left menu item, and click on the `Login` tab. Switch on the `Forgot Password` switch.
If you enable `Forgot Password`, users can reset their login credentials if they forget their password or lose their OTP generator.
.Procedure
. Click *Realm Settings* in the menu.
. Click the *Login* tab.
+
.Login Tab
image:{project_images}/login-tab.png[]
image:{project_images}/login-tab.png[Login Tab]
+
. Toggle the *Forgot Password* switch to *ON*.
A `forgot password` link will now show up on your login pages.
A `forgot password` link displays in your login pages.
.Forgot Password Link
image:{project_images}/forgot-password-link.png[]
image:{project_images}/forgot-password-link.png[Forgot Password Link]
Clicking on this link will bring the user
to a page where they can enter in their username or email and receive an email with a link to reset their credentials.
Click this link to bring users where they can enter their username or email address and receive an email with a link to reset their credentials.
.Forgot Password Page
image:{project_images}/forgot-password-page.png[]
image:{project_images}/forgot-password-page.png[Forgot Password Page]
The text sent in the email is completely configurable. You just need to extend or edit the theme associated with it.
See the link:{developerguide_link}[{developerguide_name}] for more information.
The text sent in the email is configurable. See link:{developerguide_link}[{developerguide_name}] for more information.
When the user clicks on the email link, they will be asked to update their password, and, if they have an OTP generator
set up, they will also be asked to reconfigure this as well. Depending on the security requirements of your organization
you may not want users to be able to reset their OTP generator through email. You can change this behavior by
going to the `Authentication` left menu item, clicking on the `Flows` tab, and selecting the `Reset Credentials` flow:
When users click the email link, {project_name} asks them to update their password, and if they have set up an OTP generator, {project_name} asks them to reconfigure the OTP generator. Depending on security requirements of your organization, you may not want users to reset their OTP generator through email.
To change this behavior:
.Procedure
. Click *Authentication* in the menu.
. Click the *Flows* tab.
. Select the *Reset Credentials* flow.
+
.Reset Credentials Flow
image:{project_images}/reset-credentials-flow.png[]
image:{project_images}/reset-credentials-flow.png[Reset Credentials Flow]
+
If you do not want to reset the OTP, set the `Reset OTP` requirement to *Disabled*.
. Click the *Required Actions* tab. Ensure _Update Password_ is enabled.
If you do not want OTP reset, then just chose the `disabled` radio button to the right of `Reset OTP`.
NOTE: Be sure to leave Update Password enabled on the Required Actions tab. Otherwise, Forgot Password does not work.

18
server_admin/topics/login-settings/remember-me.adoc
View file

@ -1,21 +1,17 @@
=== Remember Me
If a logged in user closes their browser, their session is destroyed and they will have to log in again. You can set things
up so that if a user checks a _remember me_ checkbox, they will remain logged in even if the browser is closed. This basically
turns the login cookie from a session-only cookie to a persistence cookie.
To enable this feature go to `Realm Settings` left menu item and click on the `Login` tab and turn on the `Remember Me` switch:
A logged-in user closing their browser destroys their session, and that user must log in again. You can set {project_name} to keep the user's login session open if that user clicks the _Remember Me_ checkbox upon login. This action turns the login cookie from a session-only cookie to a persistence cookie.
.Procedure
. Click *Realm Settings* in the menu.
. Click the *Login* tab.
. Toggle the *Remember Me* switch to *ON*.
+
.Login Tab
image:{project_images}/login-tab.png[]
Once you save this setting, a `remember me` checkbox will be displayed on the realm's login page.
When you save this setting, a `remember me` checkbox displays on the realm's login page.
.Remember Me
image:{project_images}/remember-me.png[]