Uses of Interface
org.keycloak.authentication.AuthenticationFlowContext

Packages that use AuthenticationFlowContext

Package	Description
org.keycloak.authentication
org.keycloak.authentication.authenticators
org.keycloak.authentication.authenticators.access
org.keycloak.authentication.authenticators.broker
org.keycloak.authentication.authenticators.browser
org.keycloak.authentication.authenticators.conditional
org.keycloak.authentication.authenticators.directgrant
org.keycloak.authentication.authenticators.resetcred
org.keycloak.authentication.authenticators.sessionlimits
org.keycloak.authentication.authenticators.util
org.keycloak.authentication.authenticators.x509
org.keycloak.forms.login
org.keycloak.forms.login.freemarker
org.keycloak.forms.login.freemarker.model
org.keycloak.organization.authentication.authenticators.broker
org.keycloak.organization.authentication.authenticators.browser
org.keycloak.protocol.docker
org.keycloak.protocol.saml.profile.ecp.authenticator

Uses of AuthenticationFlowContext in org.keycloak.authentication

Classes in org.keycloak.authentication that implement AuthenticationFlowContext

Modifier and Type	Class	Description
class	AuthenticationProcessor.Result

Methods in org.keycloak.authentication with parameters of type AuthenticationFlowContext

Modifier and Type	Method	Description
void	Authenticator.action(AuthenticationFlowContext context)	Called from a form action invocation.
void	Authenticator.authenticate(AuthenticationFlowContext context)	Initial call for the authenticator.
void	AuthenticationFlowCallback.onParentFlowSuccess(AuthenticationFlowContext context)	Triggered after the authentication flow is successfully finished.

Uses of AuthenticationFlowContext in org.keycloak.authentication.authenticators

Methods in org.keycloak.authentication.authenticators with parameters of type AuthenticationFlowContext

Modifier and Type	Method	Description
void	AttemptedAuthenticator.action(AuthenticationFlowContext context)
void	AttemptedAuthenticator.authenticate(AuthenticationFlowContext context)

Uses of AuthenticationFlowContext in org.keycloak.authentication.authenticators.access

Methods in org.keycloak.authentication.authenticators.access with parameters of type AuthenticationFlowContext

Modifier and Type	Method	Description
void	AllowAccessAuthenticator.action(AuthenticationFlowContext context)
void	DenyAccessAuthenticator.action(AuthenticationFlowContext context)
void	AllowAccessAuthenticator.authenticate(AuthenticationFlowContext context)
void	DenyAccessAuthenticator.authenticate(AuthenticationFlowContext context)

Uses of AuthenticationFlowContext in org.keycloak.authentication.authenticators.broker

Methods in org.keycloak.authentication.authenticators.broker with parameters of type AuthenticationFlowContext

Modifier and Type	Method	Description
void	AbstractIdpAuthenticator.action(AuthenticationFlowContext context)
protected abstract void	AbstractIdpAuthenticator.actionImpl(AuthenticationFlowContext context, SerializedBrokeredIdentityContext serializedCtx, BrokeredIdentityContext brokerContext)
protected void	IdpAutoLinkAuthenticator.actionImpl(AuthenticationFlowContext context, SerializedBrokeredIdentityContext serializedCtx, BrokeredIdentityContext brokerContext)
protected void	IdpConfirmLinkAuthenticator.actionImpl(AuthenticationFlowContext context, SerializedBrokeredIdentityContext serializedCtx, BrokeredIdentityContext brokerContext)
protected void	IdpConfirmOverrideLinkAuthenticator.actionImpl(AuthenticationFlowContext context, SerializedBrokeredIdentityContext serializedCtx, BrokeredIdentityContext brokerContext)
protected void	IdpCreateUserIfUniqueAuthenticator.actionImpl(AuthenticationFlowContext context, SerializedBrokeredIdentityContext serializedCtx, BrokeredIdentityContext brokerContext)
protected void	IdpEmailVerificationAuthenticator.actionImpl(AuthenticationFlowContext context, SerializedBrokeredIdentityContext serializedCtx, BrokeredIdentityContext brokerContext)
protected void	IdpReviewProfileAuthenticator.actionImpl(AuthenticationFlowContext context, SerializedBrokeredIdentityContext userCtx, BrokeredIdentityContext brokerContext)
void	AbstractIdpAuthenticator.authenticate(AuthenticationFlowContext context)
protected abstract void	AbstractIdpAuthenticator.authenticateImpl(AuthenticationFlowContext context, SerializedBrokeredIdentityContext serializedCtx, BrokeredIdentityContext brokerContext)
protected void	IdpAutoLinkAuthenticator.authenticateImpl(AuthenticationFlowContext context, SerializedBrokeredIdentityContext serializedCtx, BrokeredIdentityContext brokerContext)
protected void	IdpConfirmLinkAuthenticator.authenticateImpl(AuthenticationFlowContext context, SerializedBrokeredIdentityContext serializedCtx, BrokeredIdentityContext brokerContext)
protected void	IdpConfirmOverrideLinkAuthenticator.authenticateImpl(AuthenticationFlowContext context, SerializedBrokeredIdentityContext serializedCtx, BrokeredIdentityContext brokerContext)
protected void	IdpCreateUserIfUniqueAuthenticator.authenticateImpl(AuthenticationFlowContext context, SerializedBrokeredIdentityContext serializedCtx, BrokeredIdentityContext brokerContext)
protected void	IdpDetectExistingBrokerUserAuthenticator.authenticateImpl(AuthenticationFlowContext context, SerializedBrokeredIdentityContext serializedCtx, BrokeredIdentityContext brokerContext)
protected void	IdpEmailVerificationAuthenticator.authenticateImpl(AuthenticationFlowContext context, SerializedBrokeredIdentityContext serializedCtx, BrokeredIdentityContext brokerContext)
protected void	IdpReviewProfileAuthenticator.authenticateImpl(AuthenticationFlowContext context, SerializedBrokeredIdentityContext userCtx, BrokeredIdentityContext brokerContext)
protected jakarta.ws.rs.core.Response	IdpUsernamePasswordForm.challenge(AuthenticationFlowContext context, jakarta.ws.rs.core.MultivaluedMap<String,String> formData)
protected jakarta.ws.rs.core.Response	IdpUsernamePasswordForm.challenge(AuthenticationFlowContext context, String error, String field)
protected ExistingUserInfo	IdpCreateUserIfUniqueAuthenticator.checkExistingUser(AuthenticationFlowContext context, String username, SerializedBrokeredIdentityContext serializedCtx, BrokeredIdentityContext brokerContext)
protected String	IdpCreateUserIfUniqueAuthenticator.getUsername(AuthenticationFlowContext context, SerializedBrokeredIdentityContext serializedCtx, BrokeredIdentityContext brokerContext)
protected boolean	IdpReviewProfileAuthenticator.requiresUpdateProfilePage(AuthenticationFlowContext context, SerializedBrokeredIdentityContext userCtx, BrokeredIdentityContext brokerContext)
protected void	AbstractIdpAuthenticator.sendFailureChallenge(AuthenticationFlowContext context, jakarta.ws.rs.core.Response.Status status, String eventError, String errorMessage, AuthenticationFlowError flowError)
protected LoginFormsProvider	IdpUsernamePasswordForm.setupForm(AuthenticationFlowContext context, jakarta.ws.rs.core.MultivaluedMap<String,String> formData, Optional<UserModel> existingUser)
protected void	IdpEmailVerificationAuthenticator.showEmailSentPage(AuthenticationFlowContext context, BrokeredIdentityContext brokerContext)
protected void	IdpCreateUserIfUniqueAuthenticator.userRegisteredSuccess(AuthenticationFlowContext context, UserModel registeredUser, SerializedBrokeredIdentityContext serializedCtx, BrokeredIdentityContext brokerContext)
protected boolean	IdpUsernamePasswordForm.validateForm(AuthenticationFlowContext context, jakarta.ws.rs.core.MultivaluedMap<String,String> formData)

Uses of AuthenticationFlowContext in org.keycloak.authentication.authenticators.browser

Methods in org.keycloak.authentication.authenticators.browser with parameters of type AuthenticationFlowContext

Modifier and Type	Method	Description
void	AbstractUsernameFormAuthenticator.action(AuthenticationFlowContext context)
void	CookieAuthenticator.action(AuthenticationFlowContext context)
void	IdentityProviderAuthenticator.action(AuthenticationFlowContext context)
void	OTPFormAuthenticator.action(AuthenticationFlowContext context)
void	RecoveryAuthnCodesFormAuthenticator.action(AuthenticationFlowContext context)
void	ScriptBasedAuthenticator.action(AuthenticationFlowContext context)
void	SpnegoAuthenticator.action(AuthenticationFlowContext context)
void	UsernamePasswordForm.action(AuthenticationFlowContext context)
void	WebAuthnAuthenticator.action(AuthenticationFlowContext context)
void	ConditionalOtpFormAuthenticator.authenticate(AuthenticationFlowContext context)
void	CookieAuthenticator.authenticate(AuthenticationFlowContext context)
void	IdentityProviderAuthenticator.authenticate(AuthenticationFlowContext context)
void	OTPFormAuthenticator.authenticate(AuthenticationFlowContext context)
void	PasskeysConditionalUIAuthenticator.authenticate(AuthenticationFlowContext context)
void	PasswordForm.authenticate(AuthenticationFlowContext context)
void	RecoveryAuthnCodesFormAuthenticator.authenticate(AuthenticationFlowContext context)
void	ScriptBasedAuthenticator.authenticate(AuthenticationFlowContext context)
void	SpnegoAuthenticator.authenticate(AuthenticationFlowContext context)
void	UsernameForm.authenticate(AuthenticationFlowContext context)
void	UsernamePasswordForm.authenticate(AuthenticationFlowContext context)
void	WebAuthnAuthenticator.authenticate(AuthenticationFlowContext context)
protected jakarta.ws.rs.core.Response	AbstractUsernameFormAuthenticator.challenge(AuthenticationFlowContext context, String error)
protected jakarta.ws.rs.core.Response	AbstractUsernameFormAuthenticator.challenge(AuthenticationFlowContext context, String error, String field)
protected jakarta.ws.rs.core.Response	UsernameForm.challenge(AuthenticationFlowContext context, jakarta.ws.rs.core.MultivaluedMap<String,String> formData)
protected jakarta.ws.rs.core.Response	UsernamePasswordForm.challenge(AuthenticationFlowContext context, jakarta.ws.rs.core.MultivaluedMap<String,String> formData)
boolean	AbstractUsernameFormAuthenticator.enabledUser(AuthenticationFlowContext context, UserModel user)
protected AuthenticatorConfigModel	ScriptBasedAuthenticator.getAuthenticatorConfig(AuthenticationFlowContext context)
protected String	AbstractUsernameFormAuthenticator.getDefaultChallengeMessage(AuthenticationFlowContext context)
protected String	PasswordForm.getDefaultChallengeMessage(AuthenticationFlowContext context)
protected String	UsernameForm.getDefaultChallengeMessage(AuthenticationFlowContext context)
protected String	RecoveryAuthnCodesFormAuthenticator.getDisabledByBruteForceEventError(AuthenticationFlowContext authnFlowContext, UserModel authenticatedUser)
protected String	WebAuthnAuthenticator.getRpID(AuthenticationFlowContext context)
protected WebAuthnPolicy	WebAuthnAuthenticator.getWebAuthnPolicy(AuthenticationFlowContext context)
protected WebAuthnPolicy	WebAuthnPasswordlessAuthenticator.getWebAuthnPolicy(AuthenticationFlowContext context)
protected boolean	AbstractUsernameFormAuthenticator.isDisabledByBruteForce(AuthenticationFlowContext context, UserModel user)
protected boolean	RecoveryAuthnCodesFormAuthenticator.isDisabledByBruteForce(AuthenticationFlowContext authnFlowContext, UserModel authenticatedUser)
protected boolean	AbstractUsernameFormAuthenticator.isUserAlreadySetBeforeUsernamePasswordAuth(AuthenticationFlowContext context)
protected jakarta.ws.rs.core.Response	SpnegoAuthenticator.optionalChallengeRedirect(AuthenticationFlowContext context, String negotiateHeader)	401 challenge sent back that bypasses
protected void	IdentityProviderAuthenticator.redirect(AuthenticationFlowContext context, String providerId)
protected void	IdentityProviderAuthenticator.redirect(AuthenticationFlowContext context, String providerId, String loginHint)
protected jakarta.ws.rs.core.Response	AbstractUsernameFormAuthenticator.setDuplicateUserChallenge(AuthenticationFlowContext context, String eventError, String loginFormError, AuthenticationFlowError authenticatorError)
protected boolean	WebAuthnAuthenticator.shouldDisplayAuthenticators(AuthenticationFlowContext context)
protected boolean	WebAuthnPasswordlessAuthenticator.shouldDisplayAuthenticators(AuthenticationFlowContext context)
void	AbstractUsernameFormAuthenticator.testInvalidUser(AuthenticationFlowContext context, UserModel user)
protected boolean	PasswordForm.validateForm(AuthenticationFlowContext context, jakarta.ws.rs.core.MultivaluedMap<String,String> formData)
protected boolean	UsernameForm.validateForm(AuthenticationFlowContext context, jakarta.ws.rs.core.MultivaluedMap<String,String> formData)
protected boolean	UsernamePasswordForm.validateForm(AuthenticationFlowContext context, jakarta.ws.rs.core.MultivaluedMap<String,String> formData)
void	OTPFormAuthenticator.validateOTP(AuthenticationFlowContext context)
boolean	AbstractUsernameFormAuthenticator.validatePassword(AuthenticationFlowContext context, UserModel user, jakarta.ws.rs.core.MultivaluedMap<String,String> inputData, boolean clearUser)
boolean	AbstractUsernameFormAuthenticator.validateUser(AuthenticationFlowContext context, jakarta.ws.rs.core.MultivaluedMap<String,String> inputData)
boolean	AbstractUsernameFormAuthenticator.validateUserAndPassword(AuthenticationFlowContext context, jakarta.ws.rs.core.MultivaluedMap<String,String> inputData)

Uses of AuthenticationFlowContext in org.keycloak.authentication.authenticators.conditional

Methods in org.keycloak.authentication.authenticators.conditional with parameters of type AuthenticationFlowContext

Modifier and Type	Method	Description
void	ConditionalLoaAuthenticator.action(AuthenticationFlowContext context)
void	ConditionalRoleAuthenticator.action(AuthenticationFlowContext context)
void	ConditionalUserAttributeValue.action(AuthenticationFlowContext context)
void	ConditionalUserConfiguredAuthenticator.action(AuthenticationFlowContext context)
default void	ConditionalAuthenticator.authenticate(AuthenticationFlowContext context)
boolean	ConditionalAuthenticator.matchCondition(AuthenticationFlowContext context)
boolean	ConditionalLoaAuthenticator.matchCondition(AuthenticationFlowContext context)
boolean	ConditionalRoleAuthenticator.matchCondition(AuthenticationFlowContext context)
boolean	ConditionalUserAttributeValue.matchCondition(AuthenticationFlowContext context)
boolean	ConditionalUserConfiguredAuthenticator.matchCondition(AuthenticationFlowContext context)
void	ConditionalLoaAuthenticator.onParentFlowSuccess(AuthenticationFlowContext context)

Uses of AuthenticationFlowContext in org.keycloak.authentication.authenticators.directgrant

Methods in org.keycloak.authentication.authenticators.directgrant with parameters of type AuthenticationFlowContext

Modifier and Type	Method	Description
void	AbstractDirectGrantAuthenticator.action(AuthenticationFlowContext context)
void	ValidateOTP.authenticate(AuthenticationFlowContext context)
void	ValidatePassword.authenticate(AuthenticationFlowContext context)
void	ValidateUsername.authenticate(AuthenticationFlowContext context)
protected String	ValidatePassword.retrievePassword(AuthenticationFlowContext context)
protected String	ValidateUsername.retrieveUsername(AuthenticationFlowContext context)

Uses of AuthenticationFlowContext in org.keycloak.authentication.authenticators.resetcred

Methods in org.keycloak.authentication.authenticators.resetcred with parameters of type AuthenticationFlowContext

Modifier and Type	Method	Description
void	AbstractSetRequiredActionAuthenticator.action(AuthenticationFlowContext context)
void	ResetCredentialChooseUser.action(AuthenticationFlowContext context)
void	ResetCredentialEmail.action(AuthenticationFlowContext context)
void	ResetOTP.action(AuthenticationFlowContext context)
void	ResetCredentialChooseUser.authenticate(AuthenticationFlowContext context)
void	ResetCredentialEmail.authenticate(AuthenticationFlowContext context)
void	ResetOTP.authenticate(AuthenticationFlowContext context)
void	ResetPassword.authenticate(AuthenticationFlowContext context)
protected boolean	ResetPassword.configuredFor(AuthenticationFlowContext context)

Uses of AuthenticationFlowContext in org.keycloak.authentication.authenticators.sessionlimits

Methods in org.keycloak.authentication.authenticators.sessionlimits with parameters of type AuthenticationFlowContext

Modifier and Type	Method	Description
void	UserSessionLimitsAuthenticator.action(AuthenticationFlowContext context)
void	UserSessionLimitsAuthenticator.authenticate(AuthenticationFlowContext context)

Uses of AuthenticationFlowContext in org.keycloak.authentication.authenticators.util

Methods in org.keycloak.authentication.authenticators.util with parameters of type AuthenticationFlowContext

Modifier and Type	Method	Description
static void	AuthenticatorUtils.dummyHash(AuthenticationFlowContext context)	This method exists to simulate hashing of some "dummy" password.
static String	AuthenticatorUtils.getDisabledByBruteForceEventError(AuthenticationFlowContext authnFlowContext, UserModel authenticatedUser)

Uses of AuthenticationFlowContext in org.keycloak.authentication.authenticators.x509

Methods in org.keycloak.authentication.authenticators.x509 with parameters of type AuthenticationFlowContext

Modifier and Type	Method	Description
void	AbstractX509ClientCertificateDirectGrantAuthenticator.action(AuthenticationFlowContext context)
void	ValidateX509CertificateUsername.action(AuthenticationFlowContext context)
void	X509ClientCertificateAuthenticator.action(AuthenticationFlowContext context)
void	ValidateX509CertificateUsername.authenticate(AuthenticationFlowContext context)
void	X509ClientCertificateAuthenticator.authenticate(AuthenticationFlowContext context)
protected jakarta.ws.rs.core.Response	AbstractX509ClientCertificateAuthenticator.createInfoResponse(AuthenticationFlowContext context, String infoMessage, Object... parameters)
abstract UserModel	UserIdentityToModelMapper.find(AuthenticationFlowContext context, Object userIdentity)
protected X509Certificate[]	AbstractX509ClientCertificateAuthenticator.getCertificateChain(AuthenticationFlowContext context)
protected void	AbstractX509ClientCertificateAuthenticator.recordX509CertificateAuditDataViaContextEvent(AuthenticationFlowContext context)
protected void	AbstractX509ClientCertificateAuthenticator.saveX509CertificateAuditDataToAuthSession(AuthenticationFlowContext context, X509Certificate cert)

Uses of AuthenticationFlowContext in org.keycloak.forms.login

Methods in org.keycloak.forms.login with parameters of type AuthenticationFlowContext

Modifier and Type	Method	Description
LoginFormsProvider	LoginFormsProvider.setAuthContext(AuthenticationFlowContext context)

Uses of AuthenticationFlowContext in org.keycloak.forms.login.freemarker

Fields in org.keycloak.forms.login.freemarker declared as AuthenticationFlowContext

Modifier and Type	Field	Description
protected AuthenticationFlowContext	FreeMarkerLoginFormsProvider.context

Methods in org.keycloak.forms.login.freemarker with parameters of type AuthenticationFlowContext

Modifier and Type	Method	Description
LoginFormsProvider	FreeMarkerLoginFormsProvider.setAuthContext(AuthenticationFlowContext context)

Uses of AuthenticationFlowContext in org.keycloak.forms.login.freemarker.model

Fields in org.keycloak.forms.login.freemarker.model declared as AuthenticationFlowContext

Modifier and Type	Field	Description
protected AuthenticationFlowContext	IdentityProviderBean.context

Methods in org.keycloak.forms.login.freemarker.model that return AuthenticationFlowContext

Modifier and Type	Method	Description
AuthenticationFlowContext	IdentityProviderBean.getFlowContext()

Methods in org.keycloak.forms.login.freemarker.model with parameters of type AuthenticationFlowContext

Modifier and Type	Method	Description
protected String	IdentityProviderBean.getExistingIDP(KeycloakSession session, AuthenticationFlowContext context)	Checks if an IDP is being connected to the user's account.
protected Set<String>	IdentityProviderBean.getLinkedBrokerAliases(KeycloakSession session, RealmModel realm, AuthenticationFlowContext context)	Returns the list of IDPs linked with the user's federated identities, if any.

Constructors in org.keycloak.forms.login.freemarker.model with parameters of type AuthenticationFlowContext

Modifier	Constructor	Description
	AuthenticationContextBean(AuthenticationFlowContext context, LoginFormsPages page)
	IdentityProviderBean(KeycloakSession session, RealmModel realm, URI baseURI, AuthenticationFlowContext context)

Uses of AuthenticationFlowContext in org.keycloak.organization.authentication.authenticators.broker

Methods in org.keycloak.organization.authentication.authenticators.broker with parameters of type AuthenticationFlowContext

Modifier and Type	Method	Description
protected void	IdpAddOrganizationMemberAuthenticator.actionImpl(AuthenticationFlowContext context, SerializedBrokeredIdentityContext serializedCtx, BrokeredIdentityContext brokerContext)
protected void	IdpAddOrganizationMemberAuthenticator.authenticateImpl(AuthenticationFlowContext context, SerializedBrokeredIdentityContext serializedCtx, BrokeredIdentityContext brokerContext)

Uses of AuthenticationFlowContext in org.keycloak.organization.authentication.authenticators.browser

Methods in org.keycloak.organization.authentication.authenticators.browser with parameters of type AuthenticationFlowContext

Modifier and Type	Method	Description
void	OrganizationAuthenticator.action(AuthenticationFlowContext context)
void	OrganizationAuthenticator.authenticate(AuthenticationFlowContext context)

Uses of AuthenticationFlowContext in org.keycloak.protocol.docker

Methods in org.keycloak.protocol.docker with parameters of type AuthenticationFlowContext

Modifier and Type	Method	Description
protected void	DockerAuthenticator.notValidCredentialsAction(AuthenticationFlowContext context, RealmModel realm, UserModel user)
protected void	DockerAuthenticator.nullUserAction(AuthenticationFlowContext context, RealmModel realm, String userId)
protected void	DockerAuthenticator.userDisabledAction(AuthenticationFlowContext context, RealmModel realm, UserModel user, String eventError)

Uses of AuthenticationFlowContext in org.keycloak.protocol.saml.profile.ecp.authenticator

Methods in org.keycloak.protocol.saml.profile.ecp.authenticator with parameters of type AuthenticationFlowContext

Modifier and Type	Method	Description
void	HttpBasicAuthenticator.action(AuthenticationFlowContext context)
void	HttpBasicAuthenticator.authenticate(AuthenticationFlowContext context)
protected void	HttpBasicAuthenticator.notValidCredentialsAction(AuthenticationFlowContext context, RealmModel realm, UserModel user)
protected void	HttpBasicAuthenticator.nullUserAction(AuthenticationFlowContext context, RealmModel realm, String user)
protected void	HttpBasicAuthenticator.userDisabledAction(AuthenticationFlowContext context, RealmModel realm, UserModel user, String eventError)
protected void	HttpBasicAuthenticator.userSuccessAction(AuthenticationFlowContext context, UserModel user)