public class ValidateOTP extends AbstractDirectGrantAuthenticator implements CredentialValidator<OTPCredentialProvider>
Modifier and Type | Field and Description |
---|---|
static String |
PROVIDER_ID |
REQUIREMENT_CHOICES
Constructor and Description |
---|
ValidateOTP() |
Modifier and Type | Method and Description |
---|---|
void |
authenticate(AuthenticationFlowContext context)
Initial call for the authenticator.
|
boolean |
configuredFor(KeycloakSession session,
RealmModel realm,
UserModel user)
Is this authenticator configured for this user.
|
List<ProviderConfigProperty> |
getConfigProperties() |
OTPCredentialProvider |
getCredentialProvider(KeycloakSession session) |
String |
getDisplayType()
Friendly name for the authenticator
|
String |
getHelpText() |
String |
getId() |
String |
getReferenceCategory()
General authenticator type, i.e.
|
AuthenticationExecutionModel.Requirement[] |
getRequirementChoices()
What requirement settings are allowed.
|
boolean |
isConfigurable()
Is this authenticator configurable?
|
boolean |
isUserSetupAllowed()
Does this authenticator have required actions that can set if the user does not have
this authenticator set up?
|
boolean |
requiresUser()
Does this authenticator require that the user has already been identified? That AuthenticatorContext.getUser() is not null?
|
void |
setRequiredActions(KeycloakSession session,
RealmModel realm,
UserModel user)
Set actions to configure authenticator
|
action, close, create, errorResponse, init, postInit
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getCredentials, getType
areRequiredActionsEnabled, getRequiredActions
order
public static final String PROVIDER_ID
public void authenticate(AuthenticationFlowContext context)
Authenticator
authenticate
in interface Authenticator
public boolean requiresUser()
Authenticator
requiresUser
in interface Authenticator
public boolean configuredFor(KeycloakSession session, RealmModel realm, UserModel user)
Authenticator
configuredFor
in interface Authenticator
public void setRequiredActions(KeycloakSession session, RealmModel realm, UserModel user)
Authenticator
setRequiredActions
in interface Authenticator
public boolean isUserSetupAllowed()
ConfigurableAuthenticatorFactory
isUserSetupAllowed
in interface ConfigurableAuthenticatorFactory
public String getDisplayType()
ConfigurableAuthenticatorFactory
getDisplayType
in interface ConfigurableAuthenticatorFactory
public String getReferenceCategory()
ConfigurableAuthenticatorFactory
getReferenceCategory
in interface ConfigurableAuthenticatorFactory
public boolean isConfigurable()
ConfigurableAuthenticatorFactory
isConfigurable
in interface ConfigurableAuthenticatorFactory
public AuthenticationExecutionModel.Requirement[] getRequirementChoices()
ConfigurableAuthenticatorFactory
getRequirementChoices
in interface ConfigurableAuthenticatorFactory
public String getHelpText()
getHelpText
in interface ConfiguredProvider
public List<ProviderConfigProperty> getConfigProperties()
getConfigProperties
in interface ConfiguredProvider
public String getId()
getId
in interface ProviderFactory<Authenticator>
public OTPCredentialProvider getCredentialProvider(KeycloakSession session)
getCredentialProvider
in interface CredentialValidator<OTPCredentialProvider>
Copyright © 2020 JBoss by Red Hat. All rights reserved.