Package org.keycloak.authentication.authenticators.browser

Class PasskeysConditionalUIAuthenticatorFactory

java.lang.Object

org.keycloak.authentication.authenticators.browser.WebAuthnAuthenticatorFactory

org.keycloak.authentication.authenticators.browser.WebAuthnPasswordlessAuthenticatorFactory

org.keycloak.authentication.authenticators.browser.PasskeysConditionalUIAuthenticatorFactory

All Implemented Interfaces:

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

public class PasskeysConditionalUIAuthenticatorFactory
extends WebAuthnPasswordlessAuthenticatorFactory
implements EnvironmentDependentProviderFactory

Author:

Takashi Norimatsu

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROVIDER_ID

Fields inherited from interface org.keycloak.authentication.ConfigurableAuthenticatorFactory

REQUIREMENT_CHOICES

Constructor Summary

Constructors

Constructor	Description
PasskeysConditionalUIAuthenticatorFactory()

Method Summary

Modifier and Type	Method	Description
Authenticator	create(KeycloakSession session)
String	getDisplayType()	Friendly name for the authenticator
String	getHelpText()
String	getId()
void	init(Config.Scope config)	Only called once when the factory is first created.
boolean	isSupported(Config.Scope config)	Check if the provider is supported and should be available based on the provider configuration.

Methods inherited from class org.keycloak.authentication.authenticators.browser.WebAuthnPasswordlessAuthenticatorFactory

getReferenceCategory, isUserSetupAllowed

Methods inherited from class org.keycloak.authentication.authenticators.browser.WebAuthnAuthenticatorFactory

close, getConfigProperties, getRequirementChoices, isConfigurable, postInit

Methods inherited from class java.lang.Object

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

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

Constructor Details

PasskeysConditionalUIAuthenticatorFactory

public PasskeysConditionalUIAuthenticatorFactory()

Method Details

getDisplayType

public String getDisplayType()

Description copied from interface: ConfigurableAuthenticatorFactory

Friendly name for the authenticator

Specified by:

getDisplayType in interface ConfigurableAuthenticatorFactory

Overrides:

getDisplayType in class WebAuthnPasswordlessAuthenticatorFactory

Returns:

getHelpText

public String getHelpText()

Specified by:

getHelpText in interface ConfiguredProvider

Overrides:

getHelpText in class WebAuthnPasswordlessAuthenticatorFactory

create

public Authenticator create(KeycloakSession session)

Specified by:

create in interface ProviderFactory<Authenticator>

Overrides:

create in class WebAuthnPasswordlessAuthenticatorFactory

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>

Overrides:

init in class WebAuthnAuthenticatorFactory

isSupported

public boolean isSupported(Config.Scope config)

Description copied from interface: EnvironmentDependentProviderFactory

Check if the provider is supported and should be available based on the provider configuration.

Specified by:

isSupported in interface EnvironmentDependentProviderFactory

Overrides:

isSupported in class WebAuthnAuthenticatorFactory

Parameters:

config - the provider configuration

Returns:

true if the provider is supported. Otherwise, false.

getId

public String getId()

Specified by:

getId in interface ProviderFactory<Authenticator>

Overrides:

getId in class WebAuthnPasswordlessAuthenticatorFactory