Class ResetOTP
java.lang.Object
org.keycloak.authentication.authenticators.resetcred.AbstractSetRequiredActionAuthenticator
org.keycloak.authentication.authenticators.resetcred.ResetOTP
- All Implemented Interfaces:
Authenticator
,AuthenticatorFactory
,ConfigurableAuthenticatorFactory
,CredentialValidator<OTPCredentialProvider>
,ConfiguredProvider
,Provider
,ProviderFactory<Authenticator>
public class ResetOTP
extends AbstractSetRequiredActionAuthenticator
implements CredentialValidator<OTPCredentialProvider>
- Version:
- $Revision: 1 $
- Author:
- Bill Burke
-
Field Summary
Fields inherited from interface org.keycloak.authentication.ConfigurableAuthenticatorFactory
REQUIREMENT_CHOICES
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
action
(AuthenticationFlowContext context) Called from a form action invocation.void
authenticate
(AuthenticationFlowContext context) Initial call for the authenticator.boolean
configuredFor
(KeycloakSession session, RealmModel realm, UserModel user) Is this authenticator configured for this user.getCredentialProvider
(KeycloakSession session) Friendly name for the authenticatorgetId()
boolean
Is this authenticator configurable?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.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
- See Also:
-
-
Constructor Details
-
ResetOTP
public ResetOTP()
-
-
Method Details
-
authenticate
Description copied from interface:Authenticator
Initial call for the authenticator. This method should check the current HTTP request to determine if the request satisfies the Authenticator's requirements. If it doesn't, it should send back a challenge response by calling the AuthenticationFlowContext.challenge(Response). If this challenge is a authentication, the action URL of the form must point to /realms/{realm}/login-actions/authenticate?code={session-code}&execution={executionId} or /realms/{realm}/login-actions/registration?code={session-code}&execution={executionId} {session-code} pertains to the code generated from AuthenticationFlowContext.generateAccessCode(). The {executionId} pertains to the AuthenticationExecutionModel.getId() value obtained from AuthenticationFlowContext.getExecution(). The action URL will invoke the action() method described below.- Specified by:
authenticate
in interfaceAuthenticator
-
action
Description copied from interface:Authenticator
Called from a form action invocation.- Specified by:
action
in interfaceAuthenticator
- Overrides:
action
in classAbstractSetRequiredActionAuthenticator
-
isConfigurable
public boolean isConfigurable()Description copied from interface:ConfigurableAuthenticatorFactory
Is this authenticator configurable?- Specified by:
isConfigurable
in interfaceConfigurableAuthenticatorFactory
- Overrides:
isConfigurable
in classAbstractSetRequiredActionAuthenticator
- Returns:
-
getConfigProperties
- Specified by:
getConfigProperties
in interfaceConfiguredProvider
- Overrides:
getConfigProperties
in classAbstractSetRequiredActionAuthenticator
-
getCredentialProvider
- Specified by:
getCredentialProvider
in interfaceCredentialValidator<OTPCredentialProvider>
-
configuredFor
Description copied from interface:Authenticator
Is this authenticator configured for this user.- Specified by:
configuredFor
in interfaceAuthenticator
- Overrides:
configuredFor
in classAbstractSetRequiredActionAuthenticator
- Returns:
-
getDisplayType
Description copied from interface:ConfigurableAuthenticatorFactory
Friendly name for the authenticator- Specified by:
getDisplayType
in interfaceConfigurableAuthenticatorFactory
- Returns:
-
getHelpText
- Specified by:
getHelpText
in interfaceConfiguredProvider
-
getId
- Specified by:
getId
in interfaceProviderFactory<Authenticator>
-