Package org.keycloak.authentication.authenticators.conditional

Interface ConditionalAuthenticatorFactory

All Superinterfaces:

AuthenticatorFactory, ConfigurableAuthenticatorFactory, ConfiguredProvider, ProviderFactory<Authenticator>

All Known Implementing Classes:

ConditionalClientScopeAuthenticatorFactory, ConditionalLoaAuthenticatorFactory, ConditionalRoleAuthenticatorFactory, ConditionalSubFlowExecutedAuthenticatorFactory, ConditionalUserAttributeValueFactory, ConditionalUserConfiguredAuthenticatorFactory

public interface ConditionalAuthenticatorFactory
extends AuthenticatorFactory

Field Summary

Fields

Modifier and Type	Field	Description
static final String	REFERENCE_CATEGORY

Fields inherited from interface org.keycloak.authentication.ConfigurableAuthenticatorFactory

REQUIREMENT_CHOICES

Method Summary

Modifier and Type	Method	Description
default Authenticator	create(KeycloakSession session)
default String	getReferenceCategory()	General authenticator type, i.e.
ConditionalAuthenticator	getSingleton()

Methods inherited from interface org.keycloak.authentication.ConfigurableAuthenticatorFactory

getDisplayType, getRequirementChoices, isConfigurable, isUserSetupAllowed

Methods inherited from interface org.keycloak.provider.ConfiguredProvider

getConfig, getConfigProperties, getHelpText

Methods inherited from interface org.keycloak.provider.ProviderFactory

close, dependsOn, getConfigMetadata, getId, init, order, postInit

Field Details

REFERENCE_CATEGORY

static final String REFERENCE_CATEGORY

See Also:

• Constant Field Values

Method Details

create

default Authenticator create(KeycloakSession session)

Specified by:

create in interface ProviderFactory<Authenticator>

getReferenceCategory

default String getReferenceCategory()

Description copied from interface: ConfigurableAuthenticatorFactory

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

Specified by:

getReferenceCategory in interface ConfigurableAuthenticatorFactory

Returns:

null if not a referenceable category

getSingleton

ConditionalAuthenticator getSingleton()