Package org.keycloak.authentication

Interface RequiredActionFactory

All Superinterfaces:

ProviderFactory<RequiredActionProvider>

All Known Implementing Classes:

DeleteAccount, DeleteCredentialAction, IdpLinkAction, RecoveryAuthnCodesAction, TermsAndConditions, UpdateEmail, UpdatePassword, UpdateProfile, UpdateTotp, UpdateUserLocaleAction, VerifyEmail, VerifyUserProfile, WebAuthnPasswordlessRegisterFactory, WebAuthnRegisterFactory

public interface RequiredActionFactory
extends ProviderFactory<RequiredActionProvider>

Factory interface for RequiredActionProvider's.

Version:

$Revision: 1 $

Author:

Bill Burke

Field Summary

Fields

Modifier and Type	Field	Description
static final List<ProviderConfigProperty>	MAX_AUTH_AGE_CONFIG_PROPERTIES

Method Summary

Modifier and Type	Method	Description
default 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
static List<ProviderConfigProperty>	getMaxAuthAgePropertyConfig()
default boolean	isConfigurable()	Indicates whether this required action can be configured via the admin ui.
default boolean	isOneTimeAction()	Flag indicating whether the execution of the required action by the same circumstances (e.g.
static int	parseMaxAuthAge(RequiredActionConfigModel model)
default void	validateConfig(KeycloakSession session, RealmModel realm, RequiredActionConfigModel model)	Allows users to validate the provided configuration for this required action.

Methods inherited from interface org.keycloak.provider.ProviderFactory

close, create, dependsOn, getId, init, order, postInit

Field Details

MAX_AUTH_AGE_CONFIG_PROPERTIES

static final List<ProviderConfigProperty> MAX_AUTH_AGE_CONFIG_PROPERTIES

Method Details

getMaxAuthAgePropertyConfig

static List<ProviderConfigProperty> getMaxAuthAgePropertyConfig()

getDisplayText

String getDisplayText()

Display text used in admin console to reference this required action

Returns:

isOneTimeAction

default boolean isOneTimeAction()

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.

Returns:

isConfigurable

default boolean isConfigurable()

Indicates whether this required action can be configured via the admin ui.

Returns:

getConfigMetadata

default 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

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

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

Parameters:

session -

realm -

model -

parseMaxAuthAge

static int parseMaxAuthAge(RequiredActionConfigModel model)
                    throws NumberFormatException

Throws:

NumberFormatException