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, ConditionalClientScopeAuthenticatorFactory, ConditionalLoaAuthenticatorFactory, ConditionalOtpFormAuthenticatorFactory, ConditionalRoleAuthenticatorFactory, ConditionalSubFlowExecutedAuthenticatorFactory, 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 Details

  • 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

    • getOptionalReferenceCategories

      default Set<String> getOptionalReferenceCategories()
      Optional categories that this authenticator can have (for example passkeys in username/form). Optional categories are not taken into account by LoA.
      Returns:
      Set of extra optional categories, empty by default

    • 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: