Package org.keycloak.authentication.authenticators.conditional

Class ConditionalCredentialAuthenticatorFactory

java.lang.Object

org.keycloak.authentication.authenticators.conditional.ConditionalCredentialAuthenticatorFactory

All Implemented Interfaces:

AuthenticatorFactory, ConditionalAuthenticatorFactory, ConfigurableAuthenticatorFactory, ConfiguredProvider, ProviderFactory<Authenticator>

public class ConditionalCredentialAuthenticatorFactory
extends Object
implements ConditionalAuthenticatorFactory

Conditional authenticator that checks if a list of configured credentials has been used (or not used) by the user in the authentication process. This way the sub-flow can be executed only when the user has used a specific credential type (password for example) or not used a specific credential type (otp for example).

Author:

rmartinc

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONF_CREDENTIALS
static final String	CONF_INCLUDED
static final String	NONE_CREDENTIAL
static final String	PROVIDER_ID

Fields inherited from interface org.keycloak.authentication.authenticators.conditional.ConditionalAuthenticatorFactory

REFERENCE_CATEGORY

Fields inherited from interface org.keycloak.authentication.ConfigurableAuthenticatorFactory

REQUIREMENT_CHOICES

Constructor Summary

Constructors

Constructor	Description
ConditionalCredentialAuthenticatorFactory()

Method Summary

Modifier and Type	Method	Description
void	close()	This is called when the server shuts down.
List<ProviderConfigProperty>	getConfigProperties()
String	getDisplayType()	Friendly name for the authenticator
String	getHelpText()
String	getId()
AuthenticationExecutionModel.Requirement[]	getRequirementChoices()	What requirement settings are allowed.
ConditionalAuthenticator	getSingleton()
void	init(Config.Scope config)	Only called once when the factory is first created.
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?
void	postInit(KeycloakSessionFactory sessionFactory)	Called after all provider factories have been initialized

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.keycloak.authentication.authenticators.conditional.ConditionalAuthenticatorFactory

create, getReferenceCategory

Methods inherited from interface org.keycloak.authentication.ConfigurableAuthenticatorFactory

getOptionalReferenceCategories

Methods inherited from interface org.keycloak.provider.ConfiguredProvider

getConfig

Methods inherited from interface org.keycloak.provider.ProviderFactory

dependsOn, getConfigMetadata, order

Field Details

PROVIDER_ID

public static final String PROVIDER_ID

See Also:

• Constant Field Values

CONF_CREDENTIALS

public static final String CONF_CREDENTIALS

See Also:

• Constant Field Values

CONF_INCLUDED

public static final String CONF_INCLUDED

See Also:

• Constant Field Values

NONE_CREDENTIAL

public static final String NONE_CREDENTIAL

See Also:

• Constant Field Values

Constructor Details

ConditionalCredentialAuthenticatorFactory

public ConditionalCredentialAuthenticatorFactory()

Method Details

init

public void init(Config.Scope config)

Description copied from interface: ProviderFactory

Only called once when the factory is first created. This config is pulled from keycloak_server.json

Specified by:

init in interface ProviderFactory<Authenticator>

postInit

public void postInit(KeycloakSessionFactory sessionFactory)

Description copied from interface: ProviderFactory

Called after all provider factories have been initialized

Specified by:

postInit in interface ProviderFactory<Authenticator>

close

public void close()

Description copied from interface: ProviderFactory

This is called when the server shuts down.

Specified by:

close in interface ProviderFactory<Authenticator>

getId

public String getId()

Specified by:

getId in interface ProviderFactory<Authenticator>

getDisplayType

public String getDisplayType()

Description copied from interface: ConfigurableAuthenticatorFactory

Friendly name for the authenticator

Specified by:

getDisplayType in interface ConfigurableAuthenticatorFactory

Returns:

isConfigurable

public boolean isConfigurable()

Description copied from interface: ConfigurableAuthenticatorFactory

Is this authenticator configurable?

Specified by:

isConfigurable in interface ConfigurableAuthenticatorFactory

Returns:

getRequirementChoices

public AuthenticationExecutionModel.Requirement[] getRequirementChoices()

Description copied from interface: ConfigurableAuthenticatorFactory

What requirement settings are allowed.

Specified by:

getRequirementChoices in interface ConfigurableAuthenticatorFactory

Returns:

isUserSetupAllowed

public boolean isUserSetupAllowed()

Description copied from interface: ConfigurableAuthenticatorFactory

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

Specified by:

isUserSetupAllowed in interface ConfigurableAuthenticatorFactory

Returns:

getHelpText

public String getHelpText()

Specified by:

getHelpText in interface ConfiguredProvider

getConfigProperties

public List<ProviderConfigProperty> getConfigProperties()

Specified by:

getConfigProperties in interface ConfiguredProvider

getSingleton

public ConditionalAuthenticator getSingleton()

Specified by:

getSingleton in interface ConditionalAuthenticatorFactory