keycloak-scim/examples/providers/authenticator
2022-03-22 09:22:48 +01:00
..
src/main [KEYCLOAK-16232] Streamify the UserCredentialStore and UserCredentialManager interfaces 2020-12-07 19:48:35 +01:00
pom.xml Set version to 999-SNAPSHOT (#10784) 2022-03-22 09:22:48 +01:00
README.md [KEYCLOAK-19754] - Update documentation files to remove problematic language in the main repository 2021-11-04 10:08:56 +01:00
secret-question-config.ftl [KEYCLOAK-10157] Recover authenticator example for the Keycloak repository (#6025) 2019-05-15 08:39:33 +02:00
secret-question.ftl KEYCLOAK-12910 Impossible to compile keycloak examples 2020-02-06 20:04:44 +01:00

Example Custom Authenticator

  1. First, Keycloak must be running. See Getting Started, or you can build distribution from source.

  2. Execute the follow. This will build the example and deploy it

    $ mvn clean install wildfly:deploy

  3. Copy the secret-question.ftl and secret-question-config.ftl files to the themes/base/login server directory.

  4. Login to admin console. Hit browser refresh if you are already logged in so that the new providers show up.

  5. Go to the Authentication menu item and go to the Flows tab, you will be able to view the currently defined flows. You cannot modify an built in flows, so, to add the Authenticator you have to copy an existing flow or create your own. Copy the "Browser" flow.

  6. In your copy, click the Actions menu item in Forms subflow and Add Execution. Pick Secret Question and change the Requirement choice.

  7. Go to the Bindings tab in Authentication menu and change the default Browser Flow to your copy of the browser flow and click Save.

  8. Next you have to register the required action that you created. Click on the Required Actions tab in the Authentication menu. Click on the Register button and choose your new Required Action. You can also choose the Default Action for the Required Action and each new user has to set the secret answer. Your new required action should now be displayed and enabled in the required actions list.