Package org.keycloak.organization.authentication.authenticators.browser

Class OrganizationAuthenticatorFactory

java.lang.Object

org.keycloak.authentication.authenticators.browser.IdentityProviderAuthenticatorFactory

org.keycloak.organization.authentication.authenticators.browser.OrganizationAuthenticatorFactory

All Implemented Interfaces:

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

public class OrganizationAuthenticatorFactory
extends IdentityProviderAuthenticatorFactory
implements EnvironmentDependentProviderFactory

Author:

Stian Thorgersen

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ID
static final String	REQUIRES_USER_MEMBERSHIP

Fields inherited from class org.keycloak.authentication.authenticators.browser.IdentityProviderAuthenticatorFactory

DEFAULT_PROVIDER, PROVIDER_ID, REQUIREMENT_CHOICES

Constructor Summary

Constructors

Constructor	Description
OrganizationAuthenticatorFactory()

Method Summary

Modifier and Type	Method	Description
Authenticator	create(KeycloakSession session)
List<ProviderConfigProperty>	getConfigProperties()
String	getDisplayType()	Friendly name for the authenticator
String	getHelpText()
String	getId()
Set<String>	getOptionalReferenceCategories(KeycloakSession session)	Optional categories that this authenticator can have (for example passkeys in username/form).
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.IdentityProviderAuthenticatorFactory

close, getReferenceCategory, getRequirementChoices, init, isConfigurable, isUserSetupAllowed, 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

ID

public static final String ID

See Also:

• Constant Field Values

REQUIRES_USER_MEMBERSHIP

public static final String REQUIRES_USER_MEMBERSHIP

See Also:

• Constant Field Values

Constructor Details

OrganizationAuthenticatorFactory

public OrganizationAuthenticatorFactory()

Method Details

getId

public String getId()

Specified by:

getId in interface ProviderFactory<Authenticator>

Overrides:

getId in class IdentityProviderAuthenticatorFactory

getDisplayType

public String getDisplayType()

Description copied from interface: ConfigurableAuthenticatorFactory

Friendly name for the authenticator

Specified by:

getDisplayType in interface ConfigurableAuthenticatorFactory

Overrides:

getDisplayType in class IdentityProviderAuthenticatorFactory

Returns:

getHelpText

public String getHelpText()

Specified by:

getHelpText in interface ConfiguredProvider

Overrides:

getHelpText in class IdentityProviderAuthenticatorFactory

create

public Authenticator create(KeycloakSession session)

Specified by:

create in interface ProviderFactory<Authenticator>

Overrides:

create in class IdentityProviderAuthenticatorFactory

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

Parameters:

config - the provider configuration

Returns:

true if the provider is supported. Otherwise, false.

getConfigProperties

public List<ProviderConfigProperty> getConfigProperties()

Specified by:

getConfigProperties in interface ConfiguredProvider

Overrides:

getConfigProperties in class IdentityProviderAuthenticatorFactory

getOptionalReferenceCategories

public Set<String> getOptionalReferenceCategories(KeycloakSession session)

Description copied from interface: ConfigurableAuthenticatorFactory

Optional categories that this authenticator can have (for example passkeys in username/form). Optional categories are not taken into account by LoA.

Specified by:

getOptionalReferenceCategories in interface ConfigurableAuthenticatorFactory

Parameters:

session - The current session in the request

Returns:

Set of extra optional categories, empty by default