Class IdpOrganizationAuthenticatorFactory
java.lang.Object
org.keycloak.organization.authentication.authenticators.broker.IdpOrganizationAuthenticatorFactory
- All Implemented Interfaces:
AuthenticatorFactory
,ConfigurableAuthenticatorFactory
,ConfiguredProvider
,EnvironmentDependentProviderFactory
,ProviderFactory<Authenticator>
public class IdpOrganizationAuthenticatorFactory
extends Object
implements AuthenticatorFactory, EnvironmentDependentProviderFactory
-
Field Summary
Fields inherited from interface org.keycloak.authentication.ConfigurableAuthenticatorFactory
REQUIREMENT_CHOICES
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
close()
This is called when the server shuts down.create
(KeycloakSession session) Friendly name for the authenticatorgetId()
General authenticator type, i.e.What requirement settings are allowed.void
init
(Config.Scope config) Only called once when the factory is first created.boolean
Is this authenticator configurable?boolean
isSupported
(Config.Scope config) Check if the provider is supported and should be available based on the provider configuration.boolean
Does this authenticator have required actions that can set if the user does not have this authenticator set up?void
postInit
(KeycloakSessionFactory factory) Called after all provider factories have been initializedMethods 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
getConfigMetadata, order
-
Field Details
-
ID
- See Also:
-
-
Constructor Details
-
IdpOrganizationAuthenticatorFactory
public IdpOrganizationAuthenticatorFactory()
-
-
Method Details
-
create
- Specified by:
create
in interfaceProviderFactory<Authenticator>
-
init
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 interfaceProviderFactory<Authenticator>
-
postInit
Description copied from interface:ProviderFactory
Called after all provider factories have been initialized- Specified by:
postInit
in interfaceProviderFactory<Authenticator>
-
close
public void close()Description copied from interface:ProviderFactory
This is called when the server shuts down.- Specified by:
close
in interfaceProviderFactory<Authenticator>
-
getId
- Specified by:
getId
in interfaceProviderFactory<Authenticator>
-
getReferenceCategory
Description copied from interface:ConfigurableAuthenticatorFactory
General authenticator type, i.e. totp, password, cert.- Specified by:
getReferenceCategory
in interfaceConfigurableAuthenticatorFactory
- Returns:
- null if not a referenceable category
-
isConfigurable
public boolean isConfigurable()Description copied from interface:ConfigurableAuthenticatorFactory
Is this authenticator configurable?- Specified by:
isConfigurable
in interfaceConfigurableAuthenticatorFactory
- Returns:
-
getRequirementChoices
Description copied from interface:ConfigurableAuthenticatorFactory
What requirement settings are allowed.- Specified by:
getRequirementChoices
in interfaceConfigurableAuthenticatorFactory
- Returns:
-
getDisplayType
Description copied from interface:ConfigurableAuthenticatorFactory
Friendly name for the authenticator- Specified by:
getDisplayType
in interfaceConfigurableAuthenticatorFactory
- Returns:
-
getHelpText
- Specified by:
getHelpText
in interfaceConfiguredProvider
-
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 interfaceConfigurableAuthenticatorFactory
- Returns:
-
getConfigProperties
- Specified by:
getConfigProperties
in interfaceConfiguredProvider
-
isSupported
Description copied from interface:EnvironmentDependentProviderFactory
Check if the provider is supported and should be available based on the provider configuration.- Specified by:
isSupported
in interfaceEnvironmentDependentProviderFactory
- Parameters:
config
- the provider configuration- Returns:
true
if the provider is supported. Otherwise,false
.
-