Class ResetPassword
- java.lang.Object
-
- org.keycloak.authentication.authenticators.resetcred.AbstractSetRequiredActionAuthenticator
-
- org.keycloak.authentication.authenticators.resetcred.ResetPassword
-
- All Implemented Interfaces:
Authenticator
,AuthenticatorFactory
,ConfigurableAuthenticatorFactory
,ConfiguredProvider
,Provider
,ProviderFactory<Authenticator>
public class ResetPassword extends AbstractSetRequiredActionAuthenticator
- Version:
- $Revision: 1 $
- Author:
- Bill Burke
-
-
Field Summary
Fields Modifier and Type Field Description static String
PROVIDER_ID
-
Fields inherited from interface org.keycloak.authentication.ConfigurableAuthenticatorFactory
REQUIREMENT_CHOICES
-
-
Constructor Summary
Constructors Constructor Description ResetPassword()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
authenticate(AuthenticationFlowContext context)
Initial call for the authenticator.protected boolean
configuredFor(AuthenticationFlowContext context)
String
getDisplayType()
Friendly name for the authenticatorString
getHelpText()
String
getId()
-
Methods inherited from class org.keycloak.authentication.authenticators.resetcred.AbstractSetRequiredActionAuthenticator
action, close, configuredFor, create, getConfigProperties, getReferenceCategory, getRequirementChoices, init, isConfigurable, 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.provider.ProviderFactory
getConfigMetadata, order
-
-
-
-
Field Detail
-
PROVIDER_ID
public static final String PROVIDER_ID
- See Also:
- Constant Field Values
-
-
Method Detail
-
authenticate
public void authenticate(AuthenticationFlowContext context)
Description copied from interface:Authenticator
Initial call for the authenticator. This method should check the current HTTP request to determine if the request satifies 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.
-
configuredFor
protected boolean configuredFor(AuthenticationFlowContext context)
-
getDisplayType
public String getDisplayType()
Description copied from interface:ConfigurableAuthenticatorFactory
Friendly name for the authenticator- Returns:
-
getHelpText
public String getHelpText()
-
getId
public String getId()
-
-