public interface Authenticator extends Provider
Modifier and Type | Method and Description |
---|---|
void |
action(AuthenticationFlowContext context)
Called from a form action invocation.
|
default boolean |
areRequiredActionsEnabled(KeycloakSession session,
RealmModel realm)
Checks if all required actions are configured in the realm and are enabled
|
void |
authenticate(AuthenticationFlowContext context)
Initial call for the authenticator.
|
boolean |
configuredFor(KeycloakSession session,
RealmModel realm,
UserModel user)
Is this authenticator configured for this user.
|
default List<RequiredActionFactory> |
getRequiredActions(KeycloakSession session)
Overwrite this if the authenticator is associated with
|
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
|
void authenticate(AuthenticationFlowContext context)
context
- void action(AuthenticationFlowContext context)
context
- boolean requiresUser()
boolean configuredFor(KeycloakSession session, RealmModel realm, UserModel user)
session
- realm
- user
- void setRequiredActions(KeycloakSession session, RealmModel realm, UserModel user)
default List<RequiredActionFactory> getRequiredActions(KeycloakSession session)
default boolean areRequiredActionsEnabled(KeycloakSession session, RealmModel realm)
Copyright © 2020 JBoss by Red Hat. All rights reserved.