Package org.keycloak.authentication.requiredactions

Class UpdateEmail

java.lang.Object

org.keycloak.authentication.requiredactions.UpdateEmail

All Implemented Interfaces:

RequiredActionFactory, RequiredActionProvider, EnvironmentDependentProviderFactory, Provider, ProviderFactory<RequiredActionProvider>

public class UpdateEmail
extends Object
implements RequiredActionProvider, RequiredActionFactory, EnvironmentDependentProviderFactory

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONFIG_VERIFY_EMAIL

Fields inherited from interface org.keycloak.authentication.RequiredActionFactory

MAX_AUTH_AGE_CONFIG_PROPERTIES

Constructor Summary

Constructors

Constructor	Description
UpdateEmail()

Method Summary

Modifier and Type	Method	Description
void	close()
RequiredActionProvider	create(KeycloakSession session)
void	evaluateTriggers(RequiredActionContext context)
static void	forceEmailVerification(KeycloakSession session)
List<ProviderConfigProperty>	getConfigMetadata()
String	getDisplayText()
String	getId()
void	init(Config.Scope config)
InitiatedActionSupport	initiatedActionSupport()
static boolean	isEnabled(RealmModel realm)
boolean	isSupported(Config.Scope config)
static boolean	isVerifyEmailEnabled(RealmModel realm)
void	postInit(KeycloakSessionFactory factory)
void	processAction(RequiredActionContext context)
void	requiredActionChallenge(RequiredActionContext context)
static void	updateEmailNow(EventBuilder event, UserModel user, UserProfile emailUpdateValidationResult)
static UserProfile	validateEmailUpdate(KeycloakSession session, UserModel user, String newEmail)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.keycloak.provider.ProviderFactory

dependsOn, order

Methods inherited from interface org.keycloak.authentication.RequiredActionFactory

isConfigurable, isOneTimeAction, validateConfig

Methods inherited from interface org.keycloak.authentication.RequiredActionProvider

getMaxAuthAge, getMaxAuthAge, initiatedActionCanceled

Field Details

CONFIG_VERIFY_EMAIL

public static final String CONFIG_VERIFY_EMAIL

See Also:

• Constant Field Values

Constructor Details

UpdateEmail

public UpdateEmail()

Method Details

isEnabled

public static boolean isEnabled(RealmModel realm)

isVerifyEmailEnabled

public static boolean isVerifyEmailEnabled(RealmModel realm)

forceEmailVerification

public static void forceEmailVerification(KeycloakSession session)

initiatedActionSupport

public InitiatedActionSupport initiatedActionSupport()

Specified by:

initiatedActionSupport in interface RequiredActionProvider

getDisplayText

public String getDisplayText()

Specified by:

getDisplayText in interface RequiredActionFactory

evaluateTriggers

public void evaluateTriggers(RequiredActionContext context)

Specified by:

evaluateTriggers in interface RequiredActionProvider

requiredActionChallenge

public void requiredActionChallenge(RequiredActionContext context)

Specified by:

requiredActionChallenge in interface RequiredActionProvider

processAction

public void processAction(RequiredActionContext context)

Specified by:

processAction in interface RequiredActionProvider

validateEmailUpdate

public static UserProfile validateEmailUpdate(KeycloakSession session,
 UserModel user,
 String newEmail)

updateEmailNow

public static void updateEmailNow(EventBuilder event,
 UserModel user,
 UserProfile emailUpdateValidationResult)

create

public RequiredActionProvider create(KeycloakSession session)

Specified by:

create in interface ProviderFactory<RequiredActionProvider>

init

public void init(Config.Scope config)

Specified by:

init in interface ProviderFactory<RequiredActionProvider>

postInit

public void postInit(KeycloakSessionFactory factory)

Specified by:

postInit in interface ProviderFactory<RequiredActionProvider>

close

public void close()

Specified by:

close in interface Provider

Specified by:

close in interface ProviderFactory<RequiredActionProvider>

getId

public String getId()

Specified by:

getId in interface ProviderFactory<RequiredActionProvider>

getConfigMetadata

public List<ProviderConfigProperty> getConfigMetadata()

Specified by:

getConfigMetadata in interface ProviderFactory<RequiredActionProvider>

Specified by:

getConfigMetadata in interface RequiredActionFactory

isSupported

public boolean isSupported(Config.Scope config)

Specified by:

isSupported in interface EnvironmentDependentProviderFactory