Package org.keycloak.authentication

Interface ConfigurableAuthenticatorFactory

All Superinterfaces:
org.keycloak.provider.ConfiguredProvider
All Known Subinterfaces:
AuthenticationFlowCallbackFactory, AuthenticatorFactory, ClientAuthenticatorFactory, FormActionFactory, FormAuthenticatorFactory
public interface ConfigurableAuthenticatorFactory extends org.keycloak.provider.ConfiguredProvider
Version:
$Revision: 1 $
Author:
Bill Burke

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final org.keycloak.models.AuthenticationExecutionModel.Requirement[]
    REQUIREMENT_CHOICES
     

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getDisplayType()
    Friendly name for the authenticator
    default Set<String>
    getOptionalReferenceCategories(org.keycloak.models.KeycloakSession session)
    Optional categories that this authenticator can have (for example passkeys in username/form).
    String
    getReferenceCategory()
    General authenticator type, i.e. totp, password, cert.
    org.keycloak.models.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 org.keycloak.models.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

    • getOptionalReferenceCategories

      default Set<String> getOptionalReferenceCategories(org.keycloak.models.KeycloakSession session)
      Optional categories that this authenticator can have (for example passkeys in username/form). Optional categories are not taken into account by LoA.
      Parameters:
      session - The current session in the request
      Returns:
      Set of extra optional categories, empty by default

    • isConfigurable

      boolean isConfigurable()
      Is this authenticator configurable?
      Returns:

    • getRequirementChoices

      org.keycloak.models.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: