Package org.keycloak.authentication

Interface ConfigurableAuthenticatorFactory

All Superinterfaces:

ConfiguredProvider

All Known Subinterfaces:

AuthenticationFlowCallbackFactory, AuthenticatorFactory, ClientAuthenticatorFactory, ConditionalAuthenticatorFactory, FormActionFactory, FormAuthenticatorFactory

All Known Implementing Classes:

AbstractClientAuthenticator, AbstractDirectGrantAuthenticator, AbstractRegistrationRecaptcha, AbstractSetRequiredActionAuthenticator, AbstractX509ClientCertificateAuthenticatorFactory, AllowAccessAuthenticatorFactory, ClientIdAndSecretAuthenticator, ConditionalLoaAuthenticatorFactory, ConditionalOtpFormAuthenticatorFactory, ConditionalRoleAuthenticatorFactory, ConditionalUserAttributeValueFactory, ConditionalUserConfiguredAuthenticatorFactory, CookieAuthenticatorFactory, DenyAccessAuthenticatorFactory, DeployedScriptAuthenticatorFactory, DockerAuthenticatorFactory, HttpBasicAuthenticatorFactory, IdentityProviderAuthenticatorFactory, IdpAutoLinkAuthenticatorFactory, IdpConfirmLinkAuthenticatorFactory, IdpConfirmOverrideLinkAuthenticatorFactory, IdpCreateUserIfUniqueAuthenticatorFactory, IdpDetectExistingBrokerUserAuthenticatorFactory, IdpEmailVerificationAuthenticatorFactory, IdpOrganizationAuthenticatorFactory, IdpReviewProfileAuthenticatorFactory, IdpUsernamePasswordFormFactory, JWTClientAuthenticator, JWTClientSecretAuthenticator, OrganizationAuthenticatorFactory, OTPFormAuthenticatorFactory, PasskeysConditionalUIAuthenticatorFactory, PasswordFormFactory, RecoveryAuthnCodesFormAuthenticatorFactory, RegistrationPage, RegistrationPassword, RegistrationRecaptcha, RegistrationRecaptchaEnterprise, RegistrationTermsAndConditions, RegistrationUserCreation, ResetCredentialChooseUser, ResetCredentialEmail, ResetOTP, ResetPassword, ScriptBasedAuthenticatorFactory, SpnegoAuthenticatorFactory, UsernameFormFactory, UsernamePasswordFormFactory, UserSessionLimitsAuthenticatorFactory, ValidateOTP, ValidatePassword, ValidateUsername, ValidateX509CertificateUsernameFactory, WebAuthnAuthenticatorFactory, WebAuthnPasswordlessAuthenticatorFactory, X509ClientAuthenticator, X509ClientCertificateAuthenticatorFactory

public interface ConfigurableAuthenticatorFactory
extends ConfiguredProvider

Version:

$Revision: 1 $

Author:

Bill Burke

Field Summary

Fields

Modifier and Type	Field	Description
static final AuthenticationExecutionModel.Requirement[]	REQUIREMENT_CHOICES

Method Summary

Modifier and Type	Method	Description
String	getDisplayType()	Friendly name for the authenticator
String	getReferenceCategory()	General authenticator type, i.e.
AuthenticationExecutionModel.Requirement[]	getRequirementChoices()	What requirement settings are allowed.
boolean	isConfigurable()	Is this authenticator configurable?
boolean	isUserSetupAllowed()	Does this authenticator have required actions that can set if the user does not have this authenticator set up?

Methods inherited from interface org.keycloak.provider.ConfiguredProvider

getConfig, getConfigProperties, getHelpText

Field Details

REQUIREMENT_CHOICES

static final AuthenticationExecutionModel.Requirement[] REQUIREMENT_CHOICES

Method Details

getDisplayType

String getDisplayType()

Friendly name for the authenticator

Returns:

getReferenceCategory

String getReferenceCategory()

General authenticator type, i.e. totp, password, cert.

Returns:

null if not a referenceable category

isConfigurable

boolean isConfigurable()

Is this authenticator configurable?

Returns:

getRequirementChoices

AuthenticationExecutionModel.Requirement[] getRequirementChoices()

What requirement settings are allowed.

Returns:

isUserSetupAllowed

boolean isUserSetupAllowed()

Does this authenticator have required actions that can set if the user does not have this authenticator set up?

Returns: