RequiredActionFactory (Keycloak Docs Distribution 21.1.2 API)

All Superinterfaces:

ProviderFactory<RequiredActionProvider>

All Known Implementing Classes:

DeleteAccount, RecoveryAuthnCodesAction, TermsAndConditions, UpdateEmail, UpdatePassword, UpdateProfile, UpdateTotp, UpdateUserLocaleAction, VerifyEmail, VerifyUserProfile, WebAuthnPasswordlessRegisterFactory, WebAuthnRegisterFactory
```
public interface RequiredActionFactory
extends ProviderFactory<RequiredActionProvider>
```
You must specify a file META-INF/services/org.keycloak.authentication.RequiredActionFactory in the jar that this class is contained in This file must have the fully qualified class name of all your RequiredActionFactory classes

Version:

$Revision: 1 $

Author:

Bill Burke

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`String`	`getDisplayText()`	Display text used in admin console to reference this required action
`default boolean`	`isOneTimeAction()`	Flag indicating whether the execution of the required action by the same circumstances (e.g.

Methods inherited from interface org.keycloak.provider.ProviderFactory
close, create, getConfigMetadata, getId, init, order, postInit

- Method Detail
  - 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: