Class VerifyUserProfile
- java.lang.Object
-
- org.keycloak.authentication.requiredactions.UpdateProfile
-
- org.keycloak.authentication.requiredactions.VerifyUserProfile
-
- All Implemented Interfaces:
RequiredActionFactory
,RequiredActionProvider
,Provider
,ProviderFactory<RequiredActionProvider>
public class VerifyUserProfile extends UpdateProfile
- Author:
- Pedro Igor
-
-
Constructor Summary
Constructors Constructor Description VerifyUserProfile()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description RequiredActionProvider
create(KeycloakSession session)
void
evaluateTriggers(RequiredActionContext context)
Called every time a user authenticates.String
getDisplayText()
Display text used in admin console to reference this required actionString
getId()
protected UserModel.RequiredAction
getResponseAction()
InitiatedActionSupport
initiatedActionSupport()
Determines what type of support is provided for application-initiated actions.void
requiredActionChallenge(RequiredActionContext context)
If the user has a required action set, this method will be the initial call to obtain what to display to the user's browser.-
Methods inherited from class org.keycloak.authentication.requiredactions.UpdateProfile
close, createResponse, init, postInit, processAction
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.keycloak.provider.ProviderFactory
getConfigMetadata, order
-
Methods inherited from interface org.keycloak.authentication.RequiredActionFactory
isOneTimeAction
-
Methods inherited from interface org.keycloak.authentication.RequiredActionProvider
getMaxAuthAge, initiatedActionCanceled
-
-
-
-
Method Detail
-
initiatedActionSupport
public InitiatedActionSupport initiatedActionSupport()
Description copied from interface:RequiredActionProvider
Determines what type of support is provided for application-initiated actions.- Specified by:
initiatedActionSupport
in interfaceRequiredActionProvider
- Overrides:
initiatedActionSupport
in classUpdateProfile
- Returns:
- InititatedActionsSupport
-
getResponseAction
protected UserModel.RequiredAction getResponseAction()
- Overrides:
getResponseAction
in classUpdateProfile
-
evaluateTriggers
public void evaluateTriggers(RequiredActionContext context)
Description copied from interface:RequiredActionProvider
Called every time a user authenticates. This checks to see if this required action should be triggered. The implementation of this method is responsible for setting the required action on the UserModel. For example, the UpdatePassword required actions checks the password policies to see if the password has expired.- Specified by:
evaluateTriggers
in interfaceRequiredActionProvider
- Overrides:
evaluateTriggers
in classUpdateProfile
-
requiredActionChallenge
public void requiredActionChallenge(RequiredActionContext context)
Description copied from interface:RequiredActionProvider
If the user has a required action set, this method will be the initial call to obtain what to display to the user's browser. Return null if no action should be done.- Specified by:
requiredActionChallenge
in interfaceRequiredActionProvider
- Overrides:
requiredActionChallenge
in classUpdateProfile
-
create
public RequiredActionProvider create(KeycloakSession session)
- Specified by:
create
in interfaceProviderFactory<RequiredActionProvider>
- Overrides:
create
in classUpdateProfile
-
getDisplayText
public String getDisplayText()
Description copied from interface:RequiredActionFactory
Display text used in admin console to reference this required action- Specified by:
getDisplayText
in interfaceRequiredActionFactory
- Overrides:
getDisplayText
in classUpdateProfile
- Returns:
-
getId
public String getId()
- Specified by:
getId
in interfaceProviderFactory<RequiredActionProvider>
- Overrides:
getId
in classUpdateProfile
-
-