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, postInitclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitgetCredentials, getTypeareRequiredActionsEnabled, getRequiredActionsorderpublic static final String PROVIDER_ID
public void authenticate(AuthenticationFlowContext context)
Authenticatorauthenticate in interface Authenticatorpublic boolean requiresUser()
AuthenticatorrequiresUser in interface Authenticatorpublic boolean configuredFor(KeycloakSession session, RealmModel realm, UserModel user)
AuthenticatorconfiguredFor in interface Authenticatorpublic void setRequiredActions(KeycloakSession session, RealmModel realm, UserModel user)
AuthenticatorsetRequiredActions in interface Authenticatorpublic boolean isUserSetupAllowed()
ConfigurableAuthenticatorFactoryisUserSetupAllowed in interface ConfigurableAuthenticatorFactorypublic String getDisplayType()
ConfigurableAuthenticatorFactorygetDisplayType in interface ConfigurableAuthenticatorFactorypublic String getReferenceCategory()
ConfigurableAuthenticatorFactorygetReferenceCategory in interface ConfigurableAuthenticatorFactorypublic boolean isConfigurable()
ConfigurableAuthenticatorFactoryisConfigurable in interface ConfigurableAuthenticatorFactorypublic AuthenticationExecutionModel.Requirement[] getRequirementChoices()
ConfigurableAuthenticatorFactorygetRequirementChoices in interface ConfigurableAuthenticatorFactorypublic String getHelpText()
getHelpText in interface ConfiguredProviderpublic List<ProviderConfigProperty> getConfigProperties()
getConfigProperties in interface ConfiguredProviderpublic String getId()
getId in interface ProviderFactory<Authenticator>public OTPCredentialProvider getCredentialProvider(KeycloakSession session)
getCredentialProvider in interface CredentialValidator<OTPCredentialProvider>Copyright © 2021 JBoss by Red Hat. All rights reserved.