## Uses of Interface
org.keycloak.authentication.AuthenticationFlowContext

- Packages that use AuthenticationFlowContext
  Package | Description
  --- | ---
  org.keycloak.authentication |
  org.keycloak.authentication.authenticators |
  org.keycloak.authentication.authenticators.broker |
  org.keycloak.authentication.authenticators.browser |
  org.keycloak.authentication.authenticators.challenge |
  org.keycloak.authentication.authenticators.cli |
  org.keycloak.authentication.authenticators.conditional |
  org.keycloak.authentication.authenticators.console |
  org.keycloak.authentication.authenticators.directgrant |
  org.keycloak.authentication.authenticators.resetcred |
  org.keycloak.authentication.authenticators.x509 |
  org.keycloak.forms.login |
  org.keycloak.forms.login.freemarker |
  org.keycloak.forms.login.freemarker.model |
  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 and Description
    --- | ---
    `class` | `AuthenticationProcessor.Result`

    Fields in org.keycloak.authentication declared as AuthenticationFlowContext
    Modifier and Type | Field and Description
    --- | ---
    `protected AuthenticationFlowContext` | ConsoleDisplayMode.`flowContext`

    Methods in org.keycloak.authentication with parameters of type AuthenticationFlowContext
    Modifier and Type | Method and Description
    --- | ---
    `void` | Authenticator.`action(AuthenticationFlowContext context)` Called from a form action invocation.
    `void` | Authenticator.`authenticate(AuthenticationFlowContext context)` Initial call for the authenticator.
    `static ConsoleDisplayMode` | ConsoleDisplayMode.`challenge(AuthenticationFlowContext context)` Build challenge response for authentication flows
    `static ConsoleDisplayMode.HeaderBuilder` | ConsoleDisplayMode.`header(AuthenticationFlowContext context)` Build challenge response header only for authentication flows

  - ### Uses of AuthenticationFlowContext in org.keycloak.authentication.authenticators

    Methods in org.keycloak.authentication.authenticators with parameters of type AuthenticationFlowContext
    Modifier and Type | Method and Description
    --- | ---
    `void` | AttemptedAuthenticator.`action(AuthenticationFlowContext context)`
    `void` | AttemptedAuthenticator.`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 and Description
    --- | ---
    `void` | AbstractIdpAuthenticator.`action(AuthenticationFlowContext context)`
    `protected void` | IdpReviewProfileAuthenticator.`actionImpl(AuthenticationFlowContext context, SerializedBrokeredIdentityContext userCtx, BrokeredIdentityContext brokerContext)`
    `protected void` | IdpEmailVerificationAuthenticator.`actionImpl(AuthenticationFlowContext context, SerializedBrokeredIdentityContext serializedCtx, BrokeredIdentityContext brokerContext)`
    `protected void` | IdpCreateUserIfUniqueAuthenticator.`actionImpl(AuthenticationFlowContext context, SerializedBrokeredIdentityContext serializedCtx, BrokeredIdentityContext brokerContext)`
    `protected void` | IdpConfirmLinkAuthenticator.`actionImpl(AuthenticationFlowContext context, SerializedBrokeredIdentityContext serializedCtx, BrokeredIdentityContext brokerContext)`
    `protected void` | IdpAutoLinkAuthenticator.`actionImpl(AuthenticationFlowContext context, SerializedBrokeredIdentityContext serializedCtx, BrokeredIdentityContext brokerContext)`
    `protected abstract void` | AbstractIdpAuthenticator.`actionImpl(AuthenticationFlowContext context, SerializedBrokeredIdentityContext serializedCtx, BrokeredIdentityContext brokerContext)`
    `void` | AbstractIdpAuthenticator.`authenticate(AuthenticationFlowContext context)`
    `protected void` | IdpReviewProfileAuthenticator.`authenticateImpl(AuthenticationFlowContext context, SerializedBrokeredIdentityContext userCtx, BrokeredIdentityContext brokerContext)`
    `protected void` | IdpEmailVerificationAuthenticator.`authenticateImpl(AuthenticationFlowContext context, SerializedBrokeredIdentityContext serializedCtx, BrokeredIdentityContext brokerContext)`
    `protected void` | IdpCreateUserIfUniqueAuthenticator.`authenticateImpl(AuthenticationFlowContext context, SerializedBrokeredIdentityContext serializedCtx, BrokeredIdentityContext brokerContext)`
    `protected void` | IdpConfirmLinkAuthenticator.`authenticateImpl(AuthenticationFlowContext context, SerializedBrokeredIdentityContext serializedCtx, BrokeredIdentityContext brokerContext)`
    `protected void` | IdpAutoLinkAuthenticator.`authenticateImpl(AuthenticationFlowContext context, SerializedBrokeredIdentityContext serializedCtx, BrokeredIdentityContext brokerContext)`
    `protected abstract void` | AbstractIdpAuthenticator.`authenticateImpl(AuthenticationFlowContext context, SerializedBrokeredIdentityContext serializedCtx, BrokeredIdentityContext brokerContext)`
    `protected javax.ws.rs.core.Response` | IdpUsernamePasswordForm.`challenge(AuthenticationFlowContext context, javax.ws.rs.core.MultivaluedMap<String,String> formData)`
    `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, javax.ws.rs.core.Response.Status status, String eventError, String errorMessage, AuthenticationFlowError flowError)`
    `protected LoginFormsProvider` | IdpUsernamePasswordForm.`setupForm(AuthenticationFlowContext context, javax.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, javax.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 and Description
    --- | ---
    `void` | WebAuthnAuthenticator.`action(AuthenticationFlowContext context)`
    `void` | UsernamePasswordForm.`action(AuthenticationFlowContext context)`
    `void` | SpnegoAuthenticator.`action(AuthenticationFlowContext context)`
    `void` | ScriptBasedAuthenticator.`action(AuthenticationFlowContext context)`
    `void` | OTPFormAuthenticator.`action(AuthenticationFlowContext context)`
    `void` | IdentityProviderAuthenticator.`action(AuthenticationFlowContext context)`
    `void` | CookieAuthenticator.`action(AuthenticationFlowContext context)`
    `void` | AbstractUsernameFormAuthenticator.`action(AuthenticationFlowContext context)`
    `void` | WebAuthnAuthenticator.`authenticate(AuthenticationFlowContext context)`
    `void` | UsernamePasswordForm.`authenticate(AuthenticationFlowContext context)`
    `void` | SpnegoAuthenticator.`authenticate(AuthenticationFlowContext context)`
    `void` | ScriptBasedAuthenticator.`authenticate(AuthenticationFlowContext context)`
    `void` | PasswordForm.`authenticate(AuthenticationFlowContext context)`
    `void` | OTPFormAuthenticator.`authenticate(AuthenticationFlowContext context)`
    `void` | IdentityProviderAuthenticator.`authenticate(AuthenticationFlowContext context)`
    `void` | CookieAuthenticator.`authenticate(AuthenticationFlowContext context)`
    `void` | ConditionalOtpFormAuthenticator.`authenticate(AuthenticationFlowContext context)`
    `protected javax.ws.rs.core.Response` | UsernamePasswordForm.`challenge(AuthenticationFlowContext context, javax.ws.rs.core.MultivaluedMap<String,String> formData)`
    `protected javax.ws.rs.core.Response` | UsernameForm.`challenge(AuthenticationFlowContext context, javax.ws.rs.core.MultivaluedMap<String,String> formData)`
    `protected javax.ws.rs.core.Response` | AbstractUsernameFormAuthenticator.`challenge(AuthenticationFlowContext context, String error)`
    `protected javax.ws.rs.core.Response` | AbstractUsernameFormAuthenticator.`challenge(AuthenticationFlowContext context, String error, String field)`
    `protected void` | AbstractUsernameFormAuthenticator.`dummyHash(AuthenticationFlowContext context)`
    `boolean` | AbstractUsernameFormAuthenticator.`enabledUser(AuthenticationFlowContext context, UserModel user)`
    `protected AuthenticatorConfigModel` | ScriptBasedAuthenticator.`getAuthenticatorConfig(AuthenticationFlowContext context)`
    `protected String` | UsernameForm.`getDefaultChallengeMessage(AuthenticationFlowContext context)`
    `protected String` | PasswordForm.`getDefaultChallengeMessage(AuthenticationFlowContext context)`
    `protected String` | AbstractUsernameFormAuthenticator.`getDefaultChallengeMessage(AuthenticationFlowContext context)`
    `protected String` | WebAuthnAuthenticator.`getRpID(AuthenticationFlowContext context)`
    `protected WebAuthnPolicy` | WebAuthnPasswordlessAuthenticator.`getWebAuthnPolicy(AuthenticationFlowContext context)`
    `protected WebAuthnPolicy` | WebAuthnAuthenticator.`getWebAuthnPolicy(AuthenticationFlowContext context)`
    `protected boolean` | AbstractUsernameFormAuthenticator.`isTemporarilyDisabledByBruteForce(AuthenticationFlowContext context, UserModel user)`
    `protected javax.ws.rs.core.Response` | SpnegoAuthenticator.`optionalChallengeRedirect(AuthenticationFlowContext context, String negotiateHeader)` 401 challenge sent back that bypasses
    `protected void` | AbstractUsernameFormAuthenticator.`runDefaultDummyHash(AuthenticationFlowContext context)`
    `protected javax.ws.rs.core.Response` | AbstractUsernameFormAuthenticator.`setDuplicateUserChallenge(AuthenticationFlowContext context, String eventError, String loginFormError, AuthenticationFlowError authenticatorError)`
    `void` | AbstractUsernameFormAuthenticator.`testInvalidUser(AuthenticationFlowContext context, UserModel user)`
    `protected boolean` | UsernamePasswordForm.`validateForm(AuthenticationFlowContext context, javax.ws.rs.core.MultivaluedMap<String,String> formData)`
    `protected boolean` | UsernameForm.`validateForm(AuthenticationFlowContext context, javax.ws.rs.core.MultivaluedMap<String,String> formData)`
    `protected boolean` | PasswordForm.`validateForm(AuthenticationFlowContext context, javax.ws.rs.core.MultivaluedMap<String,String> formData)`
    `void` | OTPFormAuthenticator.`validateOTP(AuthenticationFlowContext context)`
    `boolean` | AbstractUsernameFormAuthenticator.`validatePassword(AuthenticationFlowContext context, UserModel user, javax.ws.rs.core.MultivaluedMap<String,String> inputData)`
    `boolean` | AbstractUsernameFormAuthenticator.`validatePassword(AuthenticationFlowContext context, UserModel user, javax.ws.rs.core.MultivaluedMap<String,String> inputData, boolean clearUser)`
    `boolean` | AbstractUsernameFormAuthenticator.`validateUser(AuthenticationFlowContext context, javax.ws.rs.core.MultivaluedMap<String,String> inputData)`
    `boolean` | AbstractUsernameFormAuthenticator.`validateUserAndPassword(AuthenticationFlowContext context, javax.ws.rs.core.MultivaluedMap<String,String> inputData)`

  - ### Uses of AuthenticationFlowContext in org.keycloak.authentication.authenticators.challenge

    Methods in org.keycloak.authentication.authenticators.challenge with parameters of type AuthenticationFlowContext
    Modifier and Type | Method and Description
    --- | ---
    `void` | NoCookieFlowRedirectAuthenticator.`action(AuthenticationFlowContext context)`
    `void` | BasicAuthAuthenticator.`action(AuthenticationFlowContext context)`
    `void` | NoCookieFlowRedirectAuthenticator.`authenticate(AuthenticationFlowContext context)`
    `void` | BasicAuthAuthenticator.`authenticate(AuthenticationFlowContext context)`
    `protected javax.ws.rs.core.Response` | BasicAuthAuthenticator.`challenge(AuthenticationFlowContext context, String error)`
    `protected javax.ws.rs.core.Response` | BasicAuthAuthenticator.`challenge(AuthenticationFlowContext context, String error, String field)`
    `protected boolean` | BasicAuthAuthenticator.`checkUsernameAndPassword(AuthenticationFlowContext context, String username, String password)`
    `protected String` | BasicAuthAuthenticator.`getAuthorizationHeader(AuthenticationFlowContext context)`
    `protected boolean` | BasicAuthOTPAuthenticator.`onAuthenticate(AuthenticationFlowContext context, String[] challenge)`
    `protected boolean` | BasicAuthAuthenticator.`onAuthenticate(AuthenticationFlowContext context, String[] challenge)`
    `protected javax.ws.rs.core.Response` | BasicAuthAuthenticator.`setDuplicateUserChallenge(AuthenticationFlowContext context, String eventError, String loginFormError, AuthenticationFlowError authenticatorError)`

  - ### Uses of AuthenticationFlowContext in org.keycloak.authentication.authenticators.cli

    Methods in org.keycloak.authentication.authenticators.cli with parameters of type AuthenticationFlowContext
    Modifier and Type | Method and Description
    --- | ---
    `void` | CliUsernamePasswordAuthenticator.`action(AuthenticationFlowContext context)`
    `void` | CliUsernamePasswordAuthenticator.`authenticate(AuthenticationFlowContext context)`
    `protected javax.ws.rs.core.Response` | CliUsernamePasswordAuthenticator.`challenge(AuthenticationFlowContext context, String error)`
    `protected javax.ws.rs.core.Response` | CliUsernamePasswordAuthenticator.`setDuplicateUserChallenge(AuthenticationFlowContext context, String eventError, String loginFormError, AuthenticationFlowError authenticatorError)`

  - ### 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 and Description
    --- | ---
    `void` | ConditionalUserConfiguredAuthenticator.`action(AuthenticationFlowContext context)`
    `void` | ConditionalRoleAuthenticator.`action(AuthenticationFlowContext context)`
    `default void` | ConditionalAuthenticator.`authenticate(AuthenticationFlowContext context)`
    `boolean` | ConditionalUserConfiguredAuthenticator.`matchCondition(AuthenticationFlowContext context)`
    `boolean` | ConditionalRoleAuthenticator.`matchCondition(AuthenticationFlowContext context)`
    `boolean` | ConditionalAuthenticator.`matchCondition(AuthenticationFlowContext context)`

  - ### Uses of AuthenticationFlowContext in org.keycloak.authentication.authenticators.console

    Methods in org.keycloak.authentication.authenticators.console with parameters of type AuthenticationFlowContext
    Modifier and Type | Method and Description
    --- | ---
    `void` | ConsoleUsernamePasswordAuthenticator.`action(AuthenticationFlowContext context)`
    `void` | ConsoleUsernameAuthenticator.`action(AuthenticationFlowContext context)`
    `void` | ConsolePasswordAuthenticator.`action(AuthenticationFlowContext context)`
    `void` | ConsoleOTPFormAuthenticator.`action(AuthenticationFlowContext context)`
    `void` | ConsoleUsernamePasswordAuthenticator.`authenticate(AuthenticationFlowContext context)`
    `void` | ConsoleOTPFormAuthenticator.`authenticate(AuthenticationFlowContext context)`
    `protected ConsoleDisplayMode` | ConsoleUsernamePasswordAuthenticator.`challenge(AuthenticationFlowContext context)`
    `protected ConsoleDisplayMode` | ConsoleUsernameAuthenticator.`challenge(AuthenticationFlowContext context)`
    `protected ConsoleDisplayMode` | ConsolePasswordAuthenticator.`challenge(AuthenticationFlowContext context)`
    `protected ConsoleDisplayMode` | ConsoleOTPFormAuthenticator.`challenge(AuthenticationFlowContext context)`
    `protected javax.ws.rs.core.Response` | ConsoleUsernamePasswordAuthenticator.`challenge(AuthenticationFlowContext context, String error)`
    `protected javax.ws.rs.core.Response` | ConsoleOTPFormAuthenticator.`challenge(AuthenticationFlowContext context, String msg)`
    `static URI` | ConsoleOTPFormAuthenticator.`getCallbackUrl(AuthenticationFlowContext context)`
    `protected javax.ws.rs.core.Response` | ConsoleUsernamePasswordAuthenticator.`setDuplicateUserChallenge(AuthenticationFlowContext context, String eventError, String loginFormError, AuthenticationFlowError authenticatorError)`

  - ### 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 and Description
    --- | ---
    `void` | AbstractDirectGrantAuthenticator.`action(AuthenticationFlowContext context)`
    `void` | ValidateUsername.`authenticate(AuthenticationFlowContext context)`
    `void` | ValidatePassword.`authenticate(AuthenticationFlowContext context)`
    `void` | ValidateOTP.`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 and Description
    --- | ---
    `void` | ResetCredentialEmail.`action(AuthenticationFlowContext context)`
    `void` | ResetCredentialChooseUser.`action(AuthenticationFlowContext context)`
    `void` | AbstractSetRequiredActionAuthenticator.`action(AuthenticationFlowContext context)`
    `void` | ResetPassword.`authenticate(AuthenticationFlowContext context)`
    `void` | ResetOTP.`authenticate(AuthenticationFlowContext context)`
    `void` | ResetCredentialEmail.`authenticate(AuthenticationFlowContext context)`
    `void` | ResetCredentialChooseUser.`authenticate(AuthenticationFlowContext context)`
    `protected boolean` | ResetPassword.`configuredFor(AuthenticationFlowContext context)`

  - ### 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 and Description
    --- | ---
    `void` | X509ClientCertificateAuthenticator.`action(AuthenticationFlowContext context)`
    `void` | ValidateX509CertificateUsername.`action(AuthenticationFlowContext context)`
    `void` | AbstractX509ClientCertificateDirectGrantAuthenticator.`action(AuthenticationFlowContext context)`
    `void` | X509ClientCertificateAuthenticator.`authenticate(AuthenticationFlowContext context)`
    `void` | ValidateX509CertificateUsername.`authenticate(AuthenticationFlowContext context)`
    `protected javax.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 and 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 and Description
    --- | ---
    `protected AuthenticationFlowContext` | FreeMarkerLoginFormsProvider.`context`

    Methods in org.keycloak.forms.login.freemarker with parameters of type AuthenticationFlowContext
    Modifier and Type | Method and Description
    --- | ---
    `static List<IdentityProviderModel>` | LoginFormsUtil.`filterIdentityProviders(Stream<IdentityProviderModel> providers, KeycloakSession session, AuthenticationFlowContext context)`
    `LoginFormsProvider` | FreeMarkerLoginFormsProvider.`setAuthContext(AuthenticationFlowContext context)`

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

    Constructors in org.keycloak.forms.login.freemarker.model with parameters of type AuthenticationFlowContext
    Constructor and Description
    `AuthenticationContextBean(AuthenticationFlowContext context, LoginFormsPages page)`

  - ### Uses of AuthenticationFlowContext in org.keycloak.protocol.docker

    Methods in org.keycloak.protocol.docker with parameters of type AuthenticationFlowContext
    Modifier and Type | Method and 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 and 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)`

Copyright © 2021 JBoss by Red Hat. All rights reserved.