mirrors/keycloak
1
0
Fork 0
mirror of https://github.com/keycloak/keycloak.git synced 2026-01-25 16:42:34 +00:00
Code Issues Packages Projects Releases Wiki Activity

Documentation for recovery codes (deprecation of password policy and required action config)

Browse Source 
closes #39245

Signed-off-by: mposolda <mposolda@gmail.com>
This commit is contained in:
mposolda
2025-04-28 12:42:04 +02:00
committed by Marek Posolda
parent bea2c75f5f
commit e9283ee71d
3 changed files with 15 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

BIN
docs/documentation/server_admin/images/recovery-codes-account-console-warn.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 36 KiB

9
docs/documentation/server_admin/topics/authentication/recovery-codes.adoc
View File

@@ -20,6 +20,15 @@ Check the Recovery Codes action is enabled in {project_name}:
Toggle the *Default Action* switch to *On* if you want all the new users to register their Recovery Codes credentials in the first login.
==== Configure the Recovery Codes required action
From the *Required Actions* tab of the admin console, you have the option to configure the *Recovery Authentication Codes* required action. So far, there is a configuration option
*Warning Threshold* available. When user has smaller amount of remaining recovery codes on his account than the value configured here, account console will show warning to the user, which will
recommend him to setup new set of recovery codes. The warning displayed to the user may look similar to this:
.Recovery Codes Account console warning
image:images/recovery-codes-account-console-warn.png[Recovery Codes Account console warning]
==== Adding Recovery Codes to the browser flow
The following procedure adds the `Recovery Authentication Code Form` as an alternative way of login in the default *Browser* flow.