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 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()	This is called when the server shuts down.
RequiredActionProvider	create(KeycloakSession session)
void	evaluateTriggers(RequiredActionContext context)	Called every time a user authenticates.
List<ProviderConfigProperty>	getConfigMetadata()	Returns the metadata for each configuration property supported by this factory.
String	getDisplayText()	Display text used in admin console to reference this required action
String	getId()
int	getMaxAuthAge(KeycloakSession session)	Defines the max time after a user login, after which re-authentication is requested for an AIA.
void	init(Config.Scope config)	Only called once when the factory is first created.
InitiatedActionSupport	initiatedActionSupport()	Determines what type of support is provided for application-initiated actions.
boolean	isSupported(Config.Scope config)	Check if the provider is supported and should be available based on the provider configuration.
void	postInit(KeycloakSessionFactory factory)	Called after all provider factories have been initialized
void	processAction(RequiredActionContext context)	Called when a required action has form input you want to process.
void	requiredActionChallenge(RequiredActionContext context)	If the user has a required action set, this method will be the initial call to obtain what to display to the user's browser.
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, initiatedActionCanceled

Constructor Details

UpdateEmail

public UpdateEmail()

Method Details

initiatedActionSupport

public InitiatedActionSupport initiatedActionSupport()

Description copied from interface: RequiredActionProvider

Determines what type of support is provided for application-initiated actions.

Specified by:

initiatedActionSupport in interface RequiredActionProvider

Returns:

InititatedActionsSupport

getDisplayText

public String getDisplayText()

Description copied from interface: RequiredActionFactory

Display text used in admin console to reference this required action

Specified by:

getDisplayText in interface RequiredActionFactory

Returns:

evaluateTriggers

public void evaluateTriggers(RequiredActionContext context)

Description copied from interface: RequiredActionProvider

Called every time a user authenticates. This checks to see if this required action should be triggered. The implementation of this method is responsible for setting the required action on the UserModel. For example, the UpdatePassword required actions checks the password policies to see if the password has expired.

Specified by:

evaluateTriggers in interface RequiredActionProvider

requiredActionChallenge

public void requiredActionChallenge(RequiredActionContext context)

Description copied from interface: RequiredActionProvider

If the user has a required action set, this method will be the initial call to obtain what to display to the user's browser. Return null if no action should be done.

Specified by:

requiredActionChallenge in interface RequiredActionProvider

processAction

public void processAction(RequiredActionContext context)

Description copied from interface: RequiredActionProvider

Called when a required action has form input you want to process.

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)

Description copied from interface: ProviderFactory

Only called once when the factory is first created. This config is pulled from keycloak_server.json

Specified by:

init in interface ProviderFactory<RequiredActionProvider>

postInit

public void postInit(KeycloakSessionFactory factory)

Description copied from interface: ProviderFactory

Called after all provider factories have been initialized

Specified by:

postInit in interface ProviderFactory<RequiredActionProvider>

close

public void close()

Description copied from interface: ProviderFactory

This is called when the server shuts down.

Specified by:

close in interface Provider

Specified by:

close in interface ProviderFactory<RequiredActionProvider>

getId

public String getId()

Specified by:

getId in interface ProviderFactory<RequiredActionProvider>

getMaxAuthAge

public int getMaxAuthAge(KeycloakSession session)

Description copied from interface: RequiredActionProvider

Defines the max time after a user login, after which re-authentication is requested for an AIA. 0 means that re-authentication is always requested. On default uses configured max_auth_age value from the required action config. If not configured, it uses the default max_auth_age value from the KeycloakConstants class.

Specified by:

getMaxAuthAge in interface RequiredActionProvider

getConfigMetadata

public List<ProviderConfigProperty> getConfigMetadata()

Description copied from interface: ProviderFactory

Returns the metadata for each configuration property supported by this factory.

Specified by:

getConfigMetadata in interface ProviderFactory<RequiredActionProvider>

Specified by:

getConfigMetadata in interface RequiredActionFactory

Returns:

a list with the metadata for each configuration property supported by this factory

isSupported

public boolean isSupported(Config.Scope config)

Description copied from interface: EnvironmentDependentProviderFactory

Check if the provider is supported and should be available based on the provider configuration.

Specified by:

isSupported in interface EnvironmentDependentProviderFactory

Parameters:

config - the provider configuration

Returns:

true if the provider is supported. Otherwise, false.