Package org.keycloak.authentication

Interface Summary

Interface	Description
AbstractAuthenticationFlowContext
AuthenticationFlow
AuthenticationFlowContext	This interface encapsulates information about an execution in an AuthenticationFlow.
Authenticator	This interface is for users that want to add custom authenticators to an authentication flow.
AuthenticatorFactory	Factory for creating Authenticator instances.
ClientAuthenticationFlowContext	Encapsulates information about the execution in ClientAuthenticationFlow
ClientAuthenticator	This interface is for users that want to add custom client authenticators to an authentication flow.
ClientAuthenticatorFactory	Factory for creating ClientAuthenticator instances.
ConfigurableAuthenticatorFactory
CredentialRegistrator
CredentialValidator<T extends CredentialProvider>
DisplayTypeAuthenticatorFactory	Implement this interface when declaring your authenticator factory if your provider has support for multiple oidc display query parameter parameter types if the display query parameter is set and your factory implements this interface, this method will be called.
DisplayTypeRequiredActionFactory	Implement this interface when declaring your required action factory has support for multiple oidc display query parameter parameter types if the display query parameter is set and your factory implements this interface, this method will be called.
FormAction	Fine grain processing of a form.
FormActionFactory	Factory for instantiating FormAction objects.
FormAuthenticator	This class is responsible for rendering a form.
FormAuthenticatorFactory	Factory for instantiating FormAuthenticators.
FormContext	Interface that encapsulates the current state of the current form being executed
RequiredActionContext	Interface that encapsulates current information about the current requred action
RequiredActionFactory	You must specify a file META-INF/services/org.keycloak.authentication.RequiredActionFactory in the jar that this class is contained in This file must have the fully qualified class name of all your RequiredActionFactory classes
RequiredActionProvider	RequiredAction provider.
ValidationContext	Interface that encapsulates the current validation that is being performed.

Class Summary

Class	Description
AbstractFormAuthenticator	Abstract helper class that Authenticator implementations can leverage
AuthenticationProcessor
AuthenticationSelectionOption
AuthenticatorSpi
ClientAuthenticationFlow
ClientAuthenticatorSpi
ConsoleDisplayMode	This class encapsulates a proprietary HTTP challenge protocol designed by keycloak team which is used by text-based console clients to dynamically render and prompt for information in a textual manner.
DefaultAuthenticationFlow
FormActionSpi
FormAuthenticationFlow
FormAuthenticatorSpi
RequiredActionContextResult
RequiredActionSpi

Enum Summary

Enum	Description
AuthenticationFlowError	Set of error codes that can be thrown by an Authenticator, FormAuthenticator, or FormAction
FlowStatus	Status of an execution/authenticator in a Authentication Flow
InitiatedActionSupport
RequiredActionContext.KcActionStatus
RequiredActionContext.Status

Exception Summary

Exception	Description
AuthenticationFlowException	Throw this exception from an Authenticator, FormAuthenticator, or FormAction if you want to completely abort the flow.
ExplainedVerificationException
ForkFlowException	Thrown internally when authenticator wants to fork the current flow.