Package org.keycloak.authentication
Interface ConfigurableAuthenticatorFactory
-
- All Superinterfaces:
ConfiguredProvider
- All Known Subinterfaces:
AuthenticationFlowCallbackFactory
,AuthenticatorFactory
,ClientAuthenticatorFactory
,FormActionFactory
,FormAuthenticatorFactory
public interface ConfigurableAuthenticatorFactory extends ConfiguredProvider
- Version:
- $Revision: 1 $
- Author:
- Bill Burke
-
-
Field Summary
Fields Modifier and Type Field Description static AuthenticationExecutionModel.Requirement[]
REQUIREMENT_CHOICES
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description String
getDisplayType()
Friendly name for the authenticatorString
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 Detail
-
REQUIREMENT_CHOICES
static final AuthenticationExecutionModel.Requirement[] REQUIREMENT_CHOICES
-
-
Method Detail
-
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 referencable 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:
-
-