Package org.keycloak.authentication.requiredactions

Class UpdatePassword

java.lang.Object

org.keycloak.authentication.requiredactions.UpdatePassword

All Implemented Interfaces:

RequiredActionFactory, RequiredActionProvider, Provider, ProviderFactory<RequiredActionProvider>

public class UpdatePassword
extends Object
implements RequiredActionProvider, RequiredActionFactory

Version:

$Revision: 1 $

Author:

Bill Burke

Field Summary

Fields

Modifier and Type	Field	Description
static final String	MAX_AUTH_AGE_KEY

Constructor Summary

Constructors

Constructor	Description
UpdatePassword()	Deprecated. use UpdatePassword(KeycloakSession) instead
UpdatePassword(KeycloakSession session)

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()	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	isOneTimeAction()	Flag indicating whether the execution of the required action by the same circumstances (e.g.
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.
void	validateConfig(KeycloakSession session, RealmModel realm, RequiredActionConfigModel model)	Allows users to validate the provided configuration for this required action.

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

Methods inherited from interface org.keycloak.authentication.RequiredActionProvider

initiatedActionCanceled

Field Details

MAX_AUTH_AGE_KEY

public static final String MAX_AUTH_AGE_KEY

See Also:

• Constant Field Values

Constructor Details

UpdatePassword

@Deprecated
public UpdatePassword()

Deprecated.

use UpdatePassword(KeycloakSession) instead

UpdatePassword

public UpdatePassword(KeycloakSession session)

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

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

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>

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>

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:

getId

public String getId()

Specified by:

getId in interface ProviderFactory<RequiredActionProvider>

isOneTimeAction

public boolean isOneTimeAction()

Description copied from interface: RequiredActionFactory

Flag indicating whether the execution of the required action by the same circumstances (e.g. by one and the same action token) should only be permitted once.

Specified by:

isOneTimeAction in interface RequiredActionFactory

Returns:

getMaxAuthAge

public int getMaxAuthAge()

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.

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>

Returns:

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

validateConfig

public void validateConfig(KeycloakSession session,
 RealmModel realm,
 RequiredActionConfigModel model)

Description copied from interface: RequiredActionFactory

Allows users to validate the provided configuration for this required action. Users can throw a ModelValidationException to indicate that the configuration is invalid.

Specified by:

validateConfig in interface RequiredActionFactory