You are on page 1of 1

Keycloak also supports a simple registration form.

Different aspects of this form can be


enabled and disabled i.e. Recaptcha support can be turned off and on. The same authentication
SPI can be used to add another page to the registration flow or reimplement it entirely. There’s
also an additional fine-grained SPI you can use to add specific validations and user extensions
to the built in registration form.

A required action in Keycloak is an action that a user has to perform after he authenticates.
After the action is performed successfully, the user doesn’t have to perform the action again.
Keycloak comes with some built in required actions like "reset password". This action forces
the user to change their password after they have logged in. You can write and plug in your
own required actions.

If your authenticator or required action implementation is using some user attributes as the meta
attributes for linking/establishing the user identity, then please make sure that users are not able
the attributes and the corresponding attributes are read-only. See the details in the Threat model
mitigation chapter.

Terms
To first learn about the Authentication SPI, let’s go over some of the terms used to describe it.

Authentication Flow

A flow is a container for all authentications that must happen during login or
registration. If you go to the admin console authentication page, you can view all the
defined flows in the system and what authenticators they are made up of. Flows can
contain other flows. You can also bind a new different flow for browser login, direct
grant access, and registration.

Authenticator

An authenticator is a pluggable component that hold the logic for performing the
authentication or action within a flow. It is usually a singleton.

Execution

An execution is an object that binds the authenticator to the flow and the authenticator
to the configuration of the authenticator. Flows contain execution entries.

You might also like