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>

@Deprecated(since="26.3",
            forRemoval=true)
public class PasskeysConditionalUIAuthenticatorFactory
extends WebAuthnPasswordlessAuthenticatorFactory
implements EnvironmentDependentProviderFactory

Deprecated, for removal: This API element is subject to removal in a future version.

Factory is deprecated as passkeys are now integrated with the default username authenticators. It will be removed in future versions when the passkeys feature become supported.

Author:

Takashi Norimatsu

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROVIDER_ID	Deprecated, for removal: This API element is subject to removal in a future version.

Fields inherited from interface org.keycloak.authentication.ConfigurableAuthenticatorFactory

REQUIREMENT_CHOICES

Constructor Summary

Constructors

Constructor	Description
PasskeysConditionalUIAuthenticatorFactory()	Deprecated, for removal: This API element is subject to removal in a future version.

Method Summary

Modifier and Type	Method	Description
Authenticator	create(KeycloakSession session)	Deprecated, for removal: This API element is subject to removal in a future version.
String	getDisplayType()	Deprecated, for removal: This API element is subject to removal in a future version. Friendly name for the authenticator
String	getHelpText()	Deprecated, for removal: This API element is subject to removal in a future version.
String	getId()	Deprecated, for removal: This API element is subject to removal in a future version.
void	init(Config.Scope config)	Deprecated, for removal: This API element is subject to removal in a future version. Only called once when the factory is first created.
boolean	isSupported(Config.Scope config)	Deprecated, for removal: This API element is subject to removal in a future version. 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.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

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

Constructor Details

PasskeysConditionalUIAuthenticatorFactory

public PasskeysConditionalUIAuthenticatorFactory()

Deprecated, for removal: This API element is subject to removal in a future version.

Method Details

getDisplayType

public String getDisplayType()

Deprecated, for removal: This API element is subject to removal in a future version.

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()

Deprecated, for removal: This API element is subject to removal in a future version.

Specified by:

getHelpText in interface ConfiguredProvider

Overrides:

getHelpText in class WebAuthnPasswordlessAuthenticatorFactory

create

public Authenticator create(KeycloakSession session)

Deprecated, for removal: This API element is subject to removal in a future version.

Specified by:

create in interface ProviderFactory<Authenticator>

Overrides:

create in class WebAuthnPasswordlessAuthenticatorFactory

init

public void init(Config.Scope config)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: ProviderFactory

Only called once when the factory is first created.

Specified by:

init in interface ProviderFactory<Authenticator>

Overrides:

init in class WebAuthnAuthenticatorFactory

isSupported

public boolean isSupported(Config.Scope config)

Deprecated, for removal: This API element is subject to removal in a future version.

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()

Deprecated, for removal: This API element is subject to removal in a future version.

Specified by:

getId in interface ProviderFactory<Authenticator>

Overrides:

getId in class WebAuthnPasswordlessAuthenticatorFactory