Package org.keycloak.authentication.authenticators.broker

Class IdpEmailVerificationAuthenticator

java.lang.Object

org.keycloak.authentication.authenticators.broker.AbstractIdpAuthenticator

org.keycloak.authentication.authenticators.broker.IdpEmailVerificationAuthenticator

All Implemented Interfaces:

Authenticator, Provider

public class IdpEmailVerificationAuthenticator
extends AbstractIdpAuthenticator

Author:

Marek Posolda

Field Summary

Fields

Modifier and Type	Field	Description
static final String	IDP_LINK_CONFIRMATION_EMAIL_KEY
static final String	VERIFY_ACCOUNT_IDP_CROSS_BROWSER	Set on the original authentication session when a cross-browser confirmation created a SUO proof.
static final String	VERIFY_ACCOUNT_IDP_USERNAME

Fields inherited from class org.keycloak.authentication.authenticators.broker.AbstractIdpAuthenticator

BROKERED_CONTEXT_NOTE, ENFORCE_UPDATE_PROFILE, EXISTING_USER_INFO, FIRST_BROKER_LOGIN_SUCCESS, NESTED_FIRST_BROKER_CONTEXT

Constructor Summary

Constructors

Constructor	Description
IdpEmailVerificationAuthenticator()

Method Summary

Modifier and Type	Method	Description
protected void	actionImpl(AuthenticationFlowContext context, SerializedBrokeredIdentityContext serializedCtx, BrokeredIdentityContext brokerContext)
protected void	authenticateImpl(AuthenticationFlowContext context, SerializedBrokeredIdentityContext serializedCtx, BrokeredIdentityContext brokerContext)
boolean	configuredFor(KeycloakSession session, RealmModel realm, UserModel user)	Is this authenticator configured for this user.
boolean	requiresUser()	Does this authenticator require that the user has already been identified?
protected void	showEmailSentPage(AuthenticationFlowContext context, BrokeredIdentityContext brokerContext)

Methods inherited from class org.keycloak.authentication.authenticators.broker.AbstractIdpAuthenticator

action, authenticate, close, getExistingUser, sendFailureChallenge, setRequiredActions

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.keycloak.authentication.Authenticator

areRequiredActionsEnabled, getRequiredActions

Field Details

VERIFY_ACCOUNT_IDP_USERNAME

public static final String VERIFY_ACCOUNT_IDP_USERNAME

See Also:

• Constant Field Values

VERIFY_ACCOUNT_IDP_CROSS_BROWSER

public static final String VERIFY_ACCOUNT_IDP_CROSS_BROWSER

Set on the original authentication session when a cross-browser confirmation created a SUO proof. Same-browser confirmation never sets this note (no SUO); cross-browser continuation must win the atomic SUO consume before proceeding.

See Also:

• Constant Field Values

IDP_LINK_CONFIRMATION_EMAIL_KEY

public static final String IDP_LINK_CONFIRMATION_EMAIL_KEY

See Also:

• Constant Field Values

Constructor Details

IdpEmailVerificationAuthenticator

public IdpEmailVerificationAuthenticator()

Method Details

authenticateImpl

protected void authenticateImpl(AuthenticationFlowContext context,
 SerializedBrokeredIdentityContext serializedCtx,
 BrokeredIdentityContext brokerContext)

Specified by:

authenticateImpl in class AbstractIdpAuthenticator

actionImpl

protected void actionImpl(AuthenticationFlowContext context,
 SerializedBrokeredIdentityContext serializedCtx,
 BrokeredIdentityContext brokerContext)

Specified by:

actionImpl in class AbstractIdpAuthenticator

requiresUser

public boolean requiresUser()

Description copied from interface: Authenticator

Does this authenticator require that the user has already been identified? That AuthenticatorContext.getUser() is not null?

Returns:

configuredFor

public boolean configuredFor(KeycloakSession session,
 RealmModel realm,
 UserModel user)

Description copied from interface: Authenticator

Is this authenticator configured for this user.

Returns:

showEmailSentPage

protected void showEmailSentPage(AuthenticationFlowContext context,
 BrokeredIdentityContext brokerContext)