Package org.keycloak.authentication

Interface RequiredActionFactory

All Superinterfaces:

ProviderFactory<RequiredActionProvider>

All Known Implementing Classes:

DeleteAccount, DeleteCredentialAction, 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

Method Summary

Modifier and Type	Method	Description
String	getDisplayText()	Display text used in admin console to reference this required action
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.
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, getConfigMetadata, getId, init, order, postInit

Method Details

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:

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.

Parameters:

session -

realm -

model -