From 79bc40da92e876c19ce6cf3ca31b344e126d6f9e Mon Sep 17 00:00:00 2001 From: Steve Lewis Date: Tue, 8 Mar 2022 09:02:42 -0600 Subject: [PATCH] Add documentation for recovery codes preview feature. --- release_notes/index.adoc | 4 ++++ release_notes/topics/18_0_0.adoc | 5 +++++ server_admin/topics.adoc | 1 + .../topics/authentication/recovery-codes.adoc | 21 +++++++++++++++++++ server_installation/topics/profiles.adoc | 5 +++++ 5 files changed, 36 insertions(+) create mode 100644 release_notes/topics/18_0_0.adoc create mode 100644 server_admin/topics/authentication/recovery-codes.adoc diff --git a/release_notes/index.adoc b/release_notes/index.adoc index c0c67431936..2bef8509555 100644 --- a/release_notes/index.adoc +++ b/release_notes/index.adoc @@ -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] diff --git a/release_notes/topics/18_0_0.adoc b/release_notes/topics/18_0_0.adoc new file mode 100644 index 00000000000..546e07ba37b --- /dev/null +++ b/release_notes/topics/18_0_0.adoc @@ -0,0 +1,5 @@ += Highlights + +== Recovery Codes + +Recovery Codes as another way to do two-factor authentication is now available as a preview feature. diff --git a/server_admin/topics.adoc b/server_admin/topics.adoc index 216e4e57bc4..e74e0021d61 100644 --- a/server_admin/topics.adoc +++ b/server_admin/topics.adoc @@ -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[] diff --git a/server_admin/topics/authentication/recovery-codes.adoc b/server_admin/topics/authentication/recovery-codes.adoc new file mode 100644 index 00000000000..27af40bfd85 --- /dev/null +++ b/server_admin/topics/authentication/recovery-codes.adoc @@ -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::[] \ No newline at end of file diff --git a/server_installation/topics/profiles.adoc b/server_installation/topics/profiles.adoc index 428e1d13143..93c04e59a74 100644 --- a/server_installation/topics/profiles.adoc +++ b/server_installation/topics/profiles.adoc @@ -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