Uses of Interface
org.keycloak.authentication.Authenticator

Packages that use Authenticator

Package	Description
org.keycloak.authentication
org.keycloak.authentication.authenticators
org.keycloak.authentication.authenticators.access
org.keycloak.authentication.authenticators.broker
org.keycloak.authentication.authenticators.browser
org.keycloak.authentication.authenticators.conditional
org.keycloak.authentication.authenticators.directgrant
org.keycloak.authentication.authenticators.resetcred
org.keycloak.authentication.authenticators.sessionlimits
org.keycloak.authentication.authenticators.x509
org.keycloak.organization.authentication.authenticators.broker
org.keycloak.organization.authentication.authenticators.browser
org.keycloak.protocol.docker
org.keycloak.protocol.saml.profile.ecp.authenticator

Uses of Authenticator in org.keycloak.authentication

Subinterfaces of Authenticator in org.keycloak.authentication

Modifier and Type	Interface	Description
interface	AuthenticationFlowCallback	Callback to be triggered during various lifecycle events of authentication flow.

Classes in org.keycloak.authentication that implement Authenticator

Modifier and Type	Class	Description
class	AbstractFormAuthenticator	Abstract helper class that Authenticator implementations can leverage

Methods in org.keycloak.authentication that return Authenticator

Modifier and Type	Method	Description
protected Authenticator	DefaultAuthenticationFlow.createAuthenticator(AuthenticatorFactory factory)
Authenticator	AuthenticationProcessor.Result.getAuthenticator()

Methods in org.keycloak.authentication with parameters of type Authenticator

Modifier and Type	Method	Description
AuthenticationProcessor.Result	AuthenticationProcessor.createAuthenticatorContext(AuthenticationExecutionModel model, Authenticator authenticator, List<AuthenticationExecutionModel> executions)

Uses of Authenticator in org.keycloak.authentication.authenticators

Classes in org.keycloak.authentication.authenticators that implement Authenticator

Modifier and Type	Class	Description
class	AttemptedAuthenticator	Pass-thru atheneticator that just sets the context to attempted.

Uses of Authenticator in org.keycloak.authentication.authenticators.access

Classes in org.keycloak.authentication.authenticators.access that implement Authenticator

Modifier and Type	Class	Description
class	AllowAccessAuthenticator	Authenticator will always successfully authenticate.
class	DenyAccessAuthenticator	Explicitly deny access to the resources.

Methods in org.keycloak.authentication.authenticators.access that return Authenticator

Modifier and Type	Method	Description
Authenticator	AllowAccessAuthenticatorFactory.create(KeycloakSession session)
Authenticator	DenyAccessAuthenticatorFactory.create(KeycloakSession session)

Uses of Authenticator in org.keycloak.authentication.authenticators.broker

Classes in org.keycloak.authentication.authenticators.broker that implement Authenticator

Modifier and Type	Class	Description
class	AbstractIdpAuthenticator
class	IdpAutoLinkAuthenticator
class	IdpConfirmLinkAuthenticator
class	IdpConfirmOverrideLinkAuthenticator
class	IdpCreateUserIfUniqueAuthenticator
class	IdpDetectExistingBrokerUserAuthenticator
class	IdpEmailVerificationAuthenticator
class	IdpReviewProfileAuthenticator
class	IdpUsernamePasswordForm	Same like classic username+password form, but for use in IdP linking.

Methods in org.keycloak.authentication.authenticators.broker that return Authenticator

Modifier and Type	Method	Description
Authenticator	IdpAutoLinkAuthenticatorFactory.create(KeycloakSession session)
Authenticator	IdpConfirmLinkAuthenticatorFactory.create(KeycloakSession session)
Authenticator	IdpConfirmOverrideLinkAuthenticatorFactory.create(KeycloakSession session)
Authenticator	IdpCreateUserIfUniqueAuthenticatorFactory.create(KeycloakSession session)
Authenticator	IdpDetectExistingBrokerUserAuthenticatorFactory.create(KeycloakSession session)
Authenticator	IdpEmailVerificationAuthenticatorFactory.create(KeycloakSession session)
Authenticator	IdpReviewProfileAuthenticatorFactory.create(KeycloakSession session)
Authenticator	IdpUsernamePasswordFormFactory.create(KeycloakSession session)

Uses of Authenticator in org.keycloak.authentication.authenticators.browser

Classes in org.keycloak.authentication.authenticators.browser that implement Authenticator

Modifier and Type	Class	Description
class	AbstractUsernameFormAuthenticator
class	ConditionalOtpFormAuthenticator	An OTPFormAuthenticator that can conditionally require OTP authentication.
class	CookieAuthenticator
class	IdentityProviderAuthenticator
class	OTPFormAuthenticator
class	PasskeysConditionalUIAuthenticator	Deprecated, for removal: This API element is subject to removal in a future version.
class	PasswordForm
class	RecoveryAuthnCodesFormAuthenticator
class	ScriptBasedAuthenticator	An Authenticator that can execute a configured script during authentication flow.
class	SpnegoAuthenticator
final class	UsernameForm
class	UsernamePasswordForm
class	WebAuthnAuthenticator	Authenticator for WebAuthn authentication, which will be typically used when WebAuthn is used as second factor.
class	WebAuthnConditionalUIAuthenticator
class	WebAuthnPasswordlessAuthenticator	Authenticator for WebAuthn authentication with passwordless credential.

Methods in org.keycloak.authentication.authenticators.browser that return Authenticator

Modifier and Type	Method	Description
Authenticator	ConditionalOtpFormAuthenticatorFactory.create(KeycloakSession session)
Authenticator	CookieAuthenticatorFactory.create(KeycloakSession session)
Authenticator	DeployedScriptAuthenticatorFactory.create(KeycloakSession session)
Authenticator	IdentityProviderAuthenticatorFactory.create(KeycloakSession session)
Authenticator	OTPFormAuthenticatorFactory.create(KeycloakSession session)
Authenticator	PasskeysConditionalUIAuthenticatorFactory.create(KeycloakSession session)	Deprecated, for removal: This API element is subject to removal in a future version.
Authenticator	PasswordFormFactory.create(KeycloakSession session)
Authenticator	RecoveryAuthnCodesFormAuthenticatorFactory.create(KeycloakSession keycloakSession)
Authenticator	ScriptBasedAuthenticatorFactory.create(KeycloakSession session)
Authenticator	SpnegoAuthenticatorFactory.create(KeycloakSession session)
Authenticator	UsernameFormFactory.create(KeycloakSession session)
Authenticator	UsernamePasswordFormFactory.create(KeycloakSession session)
Authenticator	WebAuthnAuthenticatorFactory.create(KeycloakSession session)
Authenticator	WebAuthnPasswordlessAuthenticatorFactory.create(KeycloakSession session)

Uses of Authenticator in org.keycloak.authentication.authenticators.conditional

Subinterfaces of Authenticator in org.keycloak.authentication.authenticators.conditional

Modifier and Type	Interface	Description
interface	ConditionalAuthenticator

Classes in org.keycloak.authentication.authenticators.conditional that implement Authenticator

Modifier and Type	Class	Description
class	ConditionalClientScopeAuthenticator	Conditional authenticator to check if specified client-scope is present in the authentication request
class	ConditionalCredentialAuthenticator
class	ConditionalLoaAuthenticator
class	ConditionalRoleAuthenticator
class	ConditionalSubFlowExecutedAuthenticator	Conditional authenticator to know if a sub-flow was executed successfully in the authentication flow.
class	ConditionalUserAttributeValue
class	ConditionalUserConfiguredAuthenticator

Methods in org.keycloak.authentication.authenticators.conditional that return Authenticator

Modifier and Type	Method	Description
default Authenticator	ConditionalAuthenticatorFactory.create(KeycloakSession session)
Authenticator	ConditionalLoaAuthenticatorFactory.create(KeycloakSession session)

Uses of Authenticator in org.keycloak.authentication.authenticators.directgrant

Classes in org.keycloak.authentication.authenticators.directgrant that implement Authenticator

Modifier and Type	Class	Description
class	AbstractDirectGrantAuthenticator
class	ValidateOTP
class	ValidatePassword
class	ValidateUsername

Methods in org.keycloak.authentication.authenticators.directgrant that return Authenticator

Modifier and Type	Method	Description
Authenticator	AbstractDirectGrantAuthenticator.create(KeycloakSession session)

Uses of Authenticator in org.keycloak.authentication.authenticators.resetcred

Classes in org.keycloak.authentication.authenticators.resetcred that implement Authenticator

Modifier and Type	Class	Description
class	AbstractSetRequiredActionAuthenticator
class	ResetCredentialChooseUser
class	ResetCredentialEmail
class	ResetOTP
class	ResetPassword

Methods in org.keycloak.authentication.authenticators.resetcred that return Authenticator

Modifier and Type	Method	Description
Authenticator	AbstractSetRequiredActionAuthenticator.create(KeycloakSession session)
Authenticator	ResetCredentialChooseUser.create(KeycloakSession session)
Authenticator	ResetCredentialEmail.create(KeycloakSession session)

Uses of Authenticator in org.keycloak.authentication.authenticators.sessionlimits

Classes in org.keycloak.authentication.authenticators.sessionlimits that implement Authenticator

Modifier and Type	Class	Description
class	UserSessionLimitsAuthenticator

Methods in org.keycloak.authentication.authenticators.sessionlimits that return Authenticator

Modifier and Type	Method	Description
Authenticator	UserSessionLimitsAuthenticatorFactory.create(KeycloakSession keycloakSession)

Uses of Authenticator in org.keycloak.authentication.authenticators.x509

Classes in org.keycloak.authentication.authenticators.x509 that implement Authenticator

Modifier and Type	Class	Description
class	AbstractX509ClientCertificateAuthenticator
class	AbstractX509ClientCertificateDirectGrantAuthenticator
class	ValidateX509CertificateUsername
class	X509ClientCertificateAuthenticator

Methods in org.keycloak.authentication.authenticators.x509 that return Authenticator

Modifier and Type	Method	Description
Authenticator	ValidateX509CertificateUsernameFactory.create(KeycloakSession session)
Authenticator	X509ClientCertificateAuthenticatorFactory.create(KeycloakSession session)

Uses of Authenticator in org.keycloak.organization.authentication.authenticators.broker

Classes in org.keycloak.organization.authentication.authenticators.broker that implement Authenticator

Modifier and Type	Class	Description
class	IdpAddOrganizationMemberAuthenticator

Methods in org.keycloak.organization.authentication.authenticators.broker that return Authenticator

Modifier and Type	Method	Description
Authenticator	IdpOrganizationAuthenticatorFactory.create(KeycloakSession session)

Uses of Authenticator in org.keycloak.organization.authentication.authenticators.browser

Classes in org.keycloak.organization.authentication.authenticators.browser that implement Authenticator

Modifier and Type	Class	Description
class	OrganizationAuthenticator

Methods in org.keycloak.organization.authentication.authenticators.browser that return Authenticator

Modifier and Type	Method	Description
Authenticator	OrganizationAuthenticatorFactory.create(KeycloakSession session)

Uses of Authenticator in org.keycloak.protocol.docker

Classes in org.keycloak.protocol.docker that implement Authenticator

Modifier and Type	Class	Description
class	DockerAuthenticator

Methods in org.keycloak.protocol.docker that return Authenticator

Modifier and Type	Method	Description
Authenticator	DockerAuthenticatorFactory.create(KeycloakSession session)

Uses of Authenticator in org.keycloak.protocol.saml.profile.ecp.authenticator

Classes in org.keycloak.protocol.saml.profile.ecp.authenticator that implement Authenticator

Modifier and Type	Class	Description
class	HttpBasicAuthenticator

Methods in org.keycloak.protocol.saml.profile.ecp.authenticator that return Authenticator

Modifier and Type	Method	Description
Authenticator	HttpBasicAuthenticatorFactory.create(KeycloakSession session)