Package org.keycloak.authentication.authenticators.directgrant

Class ValidateOTP

java.lang.Object

org.keycloak.authentication.authenticators.directgrant.AbstractDirectGrantAuthenticator

org.keycloak.authentication.authenticators.directgrant.ValidateOTP

All Implemented Interfaces:

Authenticator, AuthenticatorFactory, ConfigurableAuthenticatorFactory, CredentialValidator<OTPCredentialProvider>, ConfiguredProvider, Provider, ProviderFactory<Authenticator>

public class ValidateOTP
extends AbstractDirectGrantAuthenticator
implements 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
ValidateOTP()

Method Summary

Modifier and Type	Method	Description
void	authenticate(AuthenticationFlowContext context)
boolean	configuredFor(KeycloakSession session, RealmModel realm, UserModel user)
List<ProviderConfigProperty>	getConfigProperties()
OTPCredentialProvider	getCredentialProvider(KeycloakSession session)
String	getDisplayType()
String	getHelpText()
String	getId()
String	getReferenceCategory()
AuthenticationExecutionModel.Requirement[]	getRequirementChoices()
boolean	isConfigurable()
boolean	isUserSetupAllowed()
boolean	requiresUser()
void	setRequiredActions(KeycloakSession session, RealmModel realm, UserModel user)

Methods inherited from class org.keycloak.authentication.authenticators.directgrant.AbstractDirectGrantAuthenticator

action, close, create, errorResponse, init, postInit

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.provider.ConfiguredProvider

getConfig

Methods inherited from interface org.keycloak.authentication.CredentialValidator

getCredentials, getType

Methods inherited from interface org.keycloak.provider.ProviderFactory

getConfigMetadata, order

Field Details

PROVIDER_ID

public static final String PROVIDER_ID

See Also:

• Constant Field Values

Constructor Details

ValidateOTP

public ValidateOTP()

Method Details

authenticate

public void authenticate(AuthenticationFlowContext context)

Specified by:

authenticate in interface Authenticator

requiresUser

public boolean requiresUser()

Specified by:

requiresUser in interface Authenticator

configuredFor

public boolean configuredFor(KeycloakSession session,
 RealmModel realm,
 UserModel user)

Specified by:

configuredFor in interface Authenticator

setRequiredActions

public void setRequiredActions(KeycloakSession session,
 RealmModel realm,
 UserModel user)

Specified by:

setRequiredActions in interface Authenticator

isUserSetupAllowed

public boolean isUserSetupAllowed()

Specified by:

isUserSetupAllowed in interface ConfigurableAuthenticatorFactory

getDisplayType

public String getDisplayType()

Specified by:

getDisplayType in interface ConfigurableAuthenticatorFactory

getReferenceCategory

public String getReferenceCategory()

Specified by:

getReferenceCategory in interface ConfigurableAuthenticatorFactory

isConfigurable

public boolean isConfigurable()

Specified by:

isConfigurable in interface ConfigurableAuthenticatorFactory

getRequirementChoices

public AuthenticationExecutionModel.Requirement[] getRequirementChoices()

Specified by:

getRequirementChoices in interface ConfigurableAuthenticatorFactory

getHelpText

public String getHelpText()

Specified by:

getHelpText in interface ConfiguredProvider

getConfigProperties

public List<ProviderConfigProperty> getConfigProperties()

Specified by:

getConfigProperties in interface ConfiguredProvider

getId

public String getId()

Specified by:

getId in interface ProviderFactory<Authenticator>

getCredentialProvider

public OTPCredentialProvider getCredentialProvider(KeycloakSession session)

Specified by:

getCredentialProvider in interface CredentialValidator<OTPCredentialProvider>