Package org.keycloak.authentication.authenticators.resetcred

Class ResetOTP

java.lang.Object

org.keycloak.authentication.authenticators.resetcred.AbstractSetRequiredActionAuthenticator

org.keycloak.authentication.authenticators.resetcred.ResetOTP

All Implemented Interfaces:

org.keycloak.authentication.Authenticator, org.keycloak.authentication.AuthenticatorFactory, org.keycloak.authentication.ConfigurableAuthenticatorFactory, org.keycloak.authentication.CredentialValidator<OTPCredentialProvider>, org.keycloak.provider.ConfiguredProvider, org.keycloak.provider.Provider, org.keycloak.provider.ProviderFactory<org.keycloak.authentication.Authenticator>

public class ResetOTP
extends AbstractSetRequiredActionAuthenticator
implements org.keycloak.authentication.CredentialValidator<OTPCredentialProvider>

Version:

$Revision: 1 $

Author:

Bill Burke

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROVIDER_ID

Fields inherited from interface org.keycloak.authentication.ConfigurableAuthenticatorFactory

REQUIREMENT_CHOICES

Constructor Summary

Constructors

Constructor	Description
ResetOTP()

Method Summary

Modifier and Type	Method	Description
void	action(org.keycloak.authentication.AuthenticationFlowContext context)
void	authenticate(org.keycloak.authentication.AuthenticationFlowContext context)
boolean	configuredFor(org.keycloak.models.KeycloakSession session, org.keycloak.models.RealmModel realm, org.keycloak.models.UserModel user)
List<org.keycloak.provider.ProviderConfigProperty>	getConfigProperties()
OTPCredentialProvider	getCredentialProvider(org.keycloak.models.KeycloakSession session)
String	getDisplayType()
String	getHelpText()
String	getId()
boolean	isConfigurable()

Methods inherited from class org.keycloak.authentication.authenticators.resetcred.AbstractSetRequiredActionAuthenticator

close, create, getReferenceCategory, getRequirementChoices, init, isUserSetupAllowed, postInit, requiresUser, setRequiredActions

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.keycloak.authentication.Authenticator

areRequiredActionsEnabled, getRequiredActions

Methods inherited from interface org.keycloak.authentication.ConfigurableAuthenticatorFactory

getOptionalReferenceCategories

Methods inherited from interface org.keycloak.provider.ConfiguredProvider

getConfig

Methods inherited from interface org.keycloak.authentication.CredentialValidator

getCredentials, getType

Methods inherited from interface org.keycloak.provider.ProviderFactory

dependsOn, getConfigMetadata, order

Field Details

PROVIDER_ID

public static final String PROVIDER_ID

See Also:

• Constant Field Values

Constructor Details

ResetOTP

public ResetOTP()

Method Details

authenticate

public void authenticate(org.keycloak.authentication.AuthenticationFlowContext context)

Specified by:

authenticate in interface org.keycloak.authentication.Authenticator

action

public void action(org.keycloak.authentication.AuthenticationFlowContext context)

Specified by:

action in interface org.keycloak.authentication.Authenticator

Overrides:

action in class AbstractSetRequiredActionAuthenticator

isConfigurable

public boolean isConfigurable()

Specified by:

isConfigurable in interface org.keycloak.authentication.ConfigurableAuthenticatorFactory

Overrides:

isConfigurable in class AbstractSetRequiredActionAuthenticator

getConfigProperties

public List<org.keycloak.provider.ProviderConfigProperty> getConfigProperties()

Specified by:

getConfigProperties in interface org.keycloak.provider.ConfiguredProvider

Overrides:

getConfigProperties in class AbstractSetRequiredActionAuthenticator

getCredentialProvider

public OTPCredentialProvider getCredentialProvider(org.keycloak.models.KeycloakSession session)

Specified by:

getCredentialProvider in interface org.keycloak.authentication.CredentialValidator<OTPCredentialProvider>

configuredFor

public boolean configuredFor(org.keycloak.models.KeycloakSession session,
 org.keycloak.models.RealmModel realm,
 org.keycloak.models.UserModel user)

Specified by:

configuredFor in interface org.keycloak.authentication.Authenticator

Overrides:

configuredFor in class AbstractSetRequiredActionAuthenticator

getDisplayType

public String getDisplayType()

Specified by:

getDisplayType in interface org.keycloak.authentication.ConfigurableAuthenticatorFactory

getHelpText

public String getHelpText()

Specified by:

getHelpText in interface org.keycloak.provider.ConfiguredProvider

getId

public String getId()

Specified by:

getId in interface org.keycloak.provider.ProviderFactory<org.keycloak.authentication.Authenticator>