libre.sh/keycloak-scim
3
0
Fork 0
Code Issues 15 Pull requests Releases 1 Packages Activity Actions

Add documentation for recovery codes preview feature.

Browse source
This commit is contained in:
Steve Lewis 2022-03-08 09:02:42 -06:00 committed by Marek Posolda
parent b6dbd8074f
commit 79bc40da92
5 changed files with 36 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
release_notes/index.adoc
View file

@ -13,6 +13,10 @@ include::topics/templates/document-attributes-community.adoc[]
:release_header_latest_link: {releasenotes_link_latest}
include::topics/templates/release-header.adoc[]
== {project_name_full} 18.0.0
include::topics/18_0_0.adoc[leveloffset=2]
== {project_name_full} 17.0.0
include::topics/17_0_0.adoc[leveloffset=2]

5
release_notes/topics/18_0_0.adoc Normal file
View file

@ -0,0 +1,5 @@
= Highlights
== Recovery Codes
Recovery Codes as another way to do two-factor authentication is now available as a preview feature.

1
server_admin/topics.adoc
View file

@ -30,6 +30,7 @@ include::topics/authentication/flows.adoc[]
include::topics/authentication/kerberos.adoc[]
include::topics/authentication/x509.adoc[]
include::topics/authentication/webauthn.adoc[]
include::topics/authentication/recovery-codes.adoc[]
include::topics/authentication/conditions.adoc[]
include::topics/identity-broker.adoc[]
include::topics/identity-broker/overview.adoc[]

21
server_admin/topics/authentication/recovery-codes.adoc Normal file
View file

@ -0,0 +1,21 @@
[[_recovery-codes]]
=== Recovery Codes (RecoveryCodes)
You can configure Recovery codes as two-factor authenticator. You need to add authenticator 'Recovery Authentication Code Form' as two-factor authenticator to your authentication flow. See the WebAuthn section above in xref:configuring-authentication[Configuring authentication] to see an example of how to configure authenticator as two-factor authenticator.
ifeval::[{project_product}==true]
:tech_feature_name: RecoveryCodes
:tech_feature_setting: -Dkeycloak.profile.feature.recovery_codes=enabled
:tech_feature_id: recovery-codes
include::../templates/techpreview.adoc[]
endif::[]
ifeval::[{project_community}==true]
[IMPORTANT]
====
Please note that Recovery Codes support is in development. Use this feature experimentally.
====
endif::[]

5
server_installation/topics/profiles.adoc
View file

@ -64,6 +64,11 @@ The features that can be enabled and disabled are:
|No
|Preview
|recovery_codes
|Recovery codes for authentication
|No
|Preview
|scripts
|Write custom authenticators using JavaScript
|No