| Modifier and Type | Interface and Description |
|---|---|
interface |
Authenticator
This interface is for users that want to add custom authenticators to an authentication flow.
|
interface |
ClientAuthenticator
This interface is for users that want to add custom client authenticators to an authentication flow.
|
interface |
FormAction
Fine grain processing of a form.
|
interface |
FormAuthenticator
This class is responsible for rendering a form.
|
interface |
RequiredActionProvider
RequiredAction provider.
|
| Modifier and Type | Class and Description |
|---|---|
class |
AbstractFormAuthenticator
Abstract helper class that Authenticator implementations can leverage
|
| Modifier and Type | Method and Description |
|---|---|
Class<? extends Provider> |
RequiredActionSpi.getProviderClass() |
Class<? extends Provider> |
FormAuthenticatorSpi.getProviderClass() |
Class<? extends Provider> |
FormActionSpi.getProviderClass() |
Class<? extends Provider> |
ClientAuthenticatorSpi.getProviderClass() |
Class<? extends Provider> |
AuthenticatorSpi.getProviderClass() |
| Modifier and Type | Interface and Description |
|---|---|
interface |
ActionTokenHandler<T extends JsonWebToken>
Handler of the action token.
|
| Modifier and Type | Class and Description |
|---|---|
class |
AbstractActionTokenHandler<T extends JsonWebToken> |
| Modifier and Type | Method and Description |
|---|---|
Class<? extends Provider> |
ActionTokenHandlerSpi.getProviderClass() |
| Modifier and Type | Class and Description |
|---|---|
class |
ExecuteActionsActionTokenHandler |
| Modifier and Type | Class and Description |
|---|---|
class |
IdpVerifyAccountLinkActionTokenHandler
Action token handler for verification of e-mail address.
|
| Modifier and Type | Class and Description |
|---|---|
class |
ResetCredentialsActionTokenHandler |
| Modifier and Type | Class and Description |
|---|---|
class |
VerifyEmailActionTokenHandler
Action token handler for verification of e-mail address.
|
| Modifier and Type | Class and Description |
|---|---|
class |
AttemptedAuthenticator
Pass-thru atheneticator that just sets the context to attempted.
|
| Modifier and Type | Class and Description |
|---|---|
class |
AllowAccessAuthenticator
Authenticator will always successfully authenticate.
|
class |
DenyAccessAuthenticator
Explicitly deny access to the resources.
|
| Modifier and Type | Class and Description |
|---|---|
class |
AbstractIdpAuthenticator |
class |
IdpAutoLinkAuthenticator |
class |
IdpConfirmLinkAuthenticator |
class |
IdpCreateUserIfUniqueAuthenticator |
class |
IdpDetectExistingBrokerUserAuthenticator |
class |
IdpEmailVerificationAuthenticator |
class |
IdpReviewProfileAuthenticator |
class |
IdpUsernamePasswordForm
Same like classic username+password form, but for use in IdP linking.
|
| Modifier and Type | Class and Description |
|---|---|
class |
AbstractUsernameFormAuthenticator |
class |
ConditionalOtpFormAuthenticator
An
OTPFormAuthenticator that can conditionally require OTP authentication. |
class |
CookieAuthenticator |
class |
IdentityProviderAuthenticator |
class |
OTPFormAuthenticator |
class |
PasswordForm |
class |
ScriptBasedAuthenticator
An
Authenticator that can execute a configured script during authentication flow. |
class |
SpnegoAuthenticator |
class |
UsernameForm |
class |
UsernamePasswordForm |
class |
WebAuthnAuthenticator
Authenticator for WebAuthn authentication, which will be typically used when WebAuthn is used as second factor.
|
class |
WebAuthnPasswordlessAuthenticator
Authenticator for WebAuthn authentication with passwordless credential.
|
| Modifier and Type | Class and Description |
|---|---|
class |
BasicAuthAuthenticator |
class |
BasicAuthOTPAuthenticator |
class |
NoCookieFlowRedirectAuthenticator |
| Modifier and Type | Class and Description |
|---|---|
class |
CliUsernamePasswordAuthenticator |
| Modifier and Type | Class and Description |
|---|---|
class |
AbstractClientAuthenticator |
class |
ClientIdAndSecretAuthenticator
Validates client based on "client_id" and "client_secret" sent either in request parameters or in "Authorization: Basic" header .
|
class |
JWTClientAuthenticator
Client authentication based on JWT signed by client private key .
|
class |
JWTClientSecretAuthenticator
Client authentication based on JWT signed by client secret instead of private key .
|
class |
X509ClientAuthenticator |
| Modifier and Type | Interface and Description |
|---|---|
interface |
ConditionalAuthenticator |
| Modifier and Type | Class and Description |
|---|---|
class |
ConditionalRoleAuthenticator |
class |
ConditionalUserConfiguredAuthenticator |
| Modifier and Type | Class and Description |
|---|---|
class |
ConsoleOTPFormAuthenticator |
class |
ConsolePasswordAuthenticator |
class |
ConsoleUsernameAuthenticator |
class |
ConsoleUsernamePasswordAuthenticator |
| Modifier and Type | Class and Description |
|---|---|
class |
AbstractDirectGrantAuthenticator |
class |
ValidateOTP |
class |
ValidatePassword |
class |
ValidateUsername |
| Modifier and Type | Class and Description |
|---|---|
class |
AbstractSetRequiredActionAuthenticator |
class |
ResetCredentialChooseUser |
class |
ResetCredentialEmail |
class |
ResetOTP |
class |
ResetPassword |
| Modifier and Type | Class and Description |
|---|---|
class |
AbstractX509ClientCertificateAuthenticator |
class |
AbstractX509ClientCertificateDirectGrantAuthenticator |
class |
ValidateX509CertificateUsername |
class |
X509ClientCertificateAuthenticator |
| Modifier and Type | Class and Description |
|---|---|
class |
RegistrationPage |
class |
RegistrationPassword |
class |
RegistrationProfile |
class |
RegistrationRecaptcha |
class |
RegistrationUserCreation |
| Modifier and Type | Class and Description |
|---|---|
class |
ConsoleTermsAndConditions |
class |
ConsoleUpdatePassword |
class |
ConsoleUpdateProfile |
class |
ConsoleUpdateTotp |
class |
ConsoleVerifyEmail |
class |
DeleteAccount |
class |
TermsAndConditions |
class |
UpdatePassword |
class |
UpdateProfile |
class |
UpdateTotp |
class |
UpdateUserLocaleAction |
class |
VerifyEmail |
class |
VerifyUserProfile |
class |
WebAuthnPasswordlessRegister
Required action for register WebAuthn passwordless credential for the user.
|
class |
WebAuthnRegister
Required action for register WebAuthn 2-factor credential for the user
|
| Modifier and Type | Class and Description |
|---|---|
class |
AuthorizationProvider
The main contract here is the creation of
PermissionEvaluator instances. |
| Modifier and Type | Method and Description |
|---|---|
Class<? extends Provider> |
AuthorizationSpi.getProviderClass() |
| Modifier and Type | Class and Description |
|---|---|
class |
UmaWellKnownProvider |
| Modifier and Type | Class and Description |
|---|---|
class |
JPAStoreFactory |
| Modifier and Type | Interface and Description |
|---|---|
interface |
PolicyProvider |
| Modifier and Type | Method and Description |
|---|---|
Class<? extends Provider> |
PolicySpi.getProviderClass() |
| Modifier and Type | Class and Description |
|---|---|
class |
AggregatePolicyProvider |
| Modifier and Type | Class and Description |
|---|---|
class |
ClientPolicyProvider |
| Modifier and Type | Class and Description |
|---|---|
class |
ClientScopePolicyProvider |
| Modifier and Type | Class and Description |
|---|---|
class |
GroupPolicyProvider |
| Modifier and Type | Class and Description |
|---|---|
class |
AbstractPermissionProvider |
class |
ResourcePolicyProvider |
class |
ScopePolicyProvider |
class |
UMAPolicyProvider |
| Modifier and Type | Class and Description |
|---|---|
class |
RolePolicyProvider |
| Modifier and Type | Class and Description |
|---|---|
class |
TimePolicyProvider |
| Modifier and Type | Class and Description |
|---|---|
class |
UserPolicyProvider |
| Modifier and Type | Class and Description |
|---|---|
class |
RPTIntrospectionProvider
Introspects token accordingly with UMA Bearer Token Profile.
|
| Modifier and Type | Interface and Description |
|---|---|
interface |
StoreFactory
A factory for the different types of storages that manage the persistence of the domain model types.
|
| Modifier and Type | Method and Description |
|---|---|
Class<? extends Provider> |
StoreFactorySpi.getProviderClass() |
| Modifier and Type | Class and Description |
|---|---|
class |
AbstractOAuth2IdentityProvider<C extends OAuth2IdentityProviderConfig> |
class |
KeycloakOIDCIdentityProvider |
class |
OIDCIdentityProvider |
| Modifier and Type | Class and Description |
|---|---|
class |
AbstractClaimMapper |
class |
AbstractClaimToRoleMapper
Abstract class that handles the logic for importing and updating brokered users for all mappers that map an OIDC
claim into a
Keycloak role. |
class |
AbstractJsonUserAttributeMapper
Abstract class for Social Provider mappers which allow mapping of JSON user profile field into Keycloak user
attribute.
|
class |
AdvancedClaimToRoleMapper |
class |
ClaimToRoleMapper |
class |
ExternalKeycloakRoleToRoleMapper |
class |
UserAttributeMapper |
class |
UsernameTemplateMapper |
| Modifier and Type | Interface and Description |
|---|---|
interface |
IdentityProvider<C extends IdentityProviderModel> |
interface |
IdentityProviderMapper |
| Modifier and Type | Class and Description |
|---|---|
class |
AbstractIdentityProvider<C extends IdentityProviderModel> |
class |
AbstractIdentityProviderMapper |
class |
HardcodedAttributeMapper |
class |
HardcodedRoleMapper |
class |
HardcodedUserSessionAttributeMapper |
| Modifier and Type | Method and Description |
|---|---|
Class<? extends Provider> |
IdentityProviderSpi.getProviderClass() |
Class<? extends Provider> |
IdentityProviderMapperSpi.getProviderClass() |
| Modifier and Type | Class and Description |
|---|---|
class |
SAMLIdentityProvider |
| Modifier and Type | Class and Description |
|---|---|
class |
AbstractAttributeToRoleMapper
Abstract class that handles the logic for importing and updating brokered users for all mappers that map a SAML
attribute into a
Keycloak role. |
class |
AdvancedAttributeToRoleMapper
|
class |
AttributeToRoleMapper |
| Modifier and Type | Interface and Description |
|---|---|
interface |
SocialIdentityProvider<C extends IdentityProviderModel> |
| Modifier and Type | Method and Description |
|---|---|
Class<? extends Provider> |
SocialProviderSpi.getProviderClass() |
| Modifier and Type | Interface and Description |
|---|---|
interface |
ClusterProvider
Various utils related to clustering and concurrent tasks on cluster nodes
|
| Modifier and Type | Method and Description |
|---|---|
Class<? extends Provider> |
ClusterSpi.getProviderClass() |
| Modifier and Type | Class and Description |
|---|---|
class |
InfinispanClusterProvider |
| Modifier and Type | Interface and Description |
|---|---|
interface |
AmphibianProviderFactory<ProviderType extends Provider>
Ancestor for a provider factory for both a standalone
ProviderFactory and a ComponentFactory. |
interface |
ComponentFactory<CreatedType,ProviderType extends Provider> |
interface |
SubComponentFactory<CreatedType,ProviderType extends Provider>
Useful when you want to describe config properties that are effected by the parent ComponentModel
|
| Modifier and Type | Interface and Description |
|---|---|
interface |
ComponentFactoryProvider |
| Modifier and Type | Method and Description |
|---|---|
<T extends Provider> |
ComponentFactoryProviderFactory.getProviderFactory(Class<T> clazz,
String realmId,
String componentId,
Function<KeycloakSessionFactory,ComponentModel> model) |
| Modifier and Type | Method and Description |
|---|---|
Class<? extends Provider> |
ComponentFactorySpi.getProviderClass() |
| Constructor and Description |
|---|
JsonConfigComponentModel(Class<? extends Provider> providerType,
String realmId,
String providerId,
com.fasterxml.jackson.databind.JsonNode configNode) |
| Modifier and Type | Interface and Description |
|---|---|
interface |
HttpClientProvider |
| Modifier and Type | Method and Description |
|---|---|
Class<? extends Provider> |
HttpClientSpi.getProviderClass() |
| Modifier and Type | Interface and Description |
|---|---|
interface |
InfinispanConnectionProvider |
| Modifier and Type | Class and Description |
|---|---|
class |
DefaultInfinispanConnectionProvider |
| Modifier and Type | Method and Description |
|---|---|
Class<? extends Provider> |
InfinispanConnectionSpi.getProviderClass() |
| Modifier and Type | Interface and Description |
|---|---|
interface |
JpaConnectionProvider |
| Modifier and Type | Class and Description |
|---|---|
class |
DefaultJpaConnectionProvider |
class |
JpaExceptionConverter |
| Modifier and Type | Method and Description |
|---|---|
Class<? extends Provider> |
JpaConnectionSpi.getProviderClass() |
| Modifier and Type | Interface and Description |
|---|---|
interface |
JpaEntityProvider |
| Modifier and Type | Method and Description |
|---|---|
Class<? extends Provider> |
JpaEntitySpi.getProviderClass() |
| Modifier and Type | Interface and Description |
|---|---|
interface |
JpaUpdaterProvider |
| Modifier and Type | Method and Description |
|---|---|
Class<? extends Provider> |
JpaUpdaterSpi.getProviderClass() |
| Modifier and Type | Class and Description |
|---|---|
class |
LiquibaseJpaUpdaterProvider |
| Modifier and Type | Interface and Description |
|---|---|
interface |
LiquibaseConnectionProvider |
| Modifier and Type | Class and Description |
|---|---|
class |
DefaultLiquibaseConnectionProvider |
| Modifier and Type | Method and Description |
|---|---|
Class<? extends Provider> |
LiquibaseConnectionSpi.getProviderClass() |
| Modifier and Type | Class and Description |
|---|---|
class |
LiquibaseDBLockProvider |
| Modifier and Type | Interface and Description |
|---|---|
interface |
CredentialProvider<T extends CredentialModel> |
interface |
UserCredentialStore |
static interface |
UserCredentialStore.Streams
The
UserCredentialStore.Streams interface makes all collection-based methods in UserCredentialStore
default by providing implementations that delegate to the Stream-based variants instead of the other way around. |
| Modifier and Type | Class and Description |
|---|---|
class |
OTPCredentialProvider |
class |
PasswordCredentialProvider |
class |
UserCredentialStoreManager |
class |
WebAuthnCredentialProvider
Credential provider for WebAuthn 2-factor credential of the user
|
class |
WebAuthnPasswordlessCredentialProvider
Credential provider for WebAuthn passwordless credential of the user
|
| Modifier and Type | Method and Description |
|---|---|
Class<? extends Provider> |
CredentialSpi.getProviderClass() |
| Modifier and Type | Interface and Description |
|---|---|
interface |
PasswordHashProvider |
| Modifier and Type | Class and Description |
|---|---|
class |
Pbkdf2PasswordHashProvider |
| Modifier and Type | Method and Description |
|---|---|
Class<? extends Provider> |
PasswordHashSpi.getProviderClass() |
| Modifier and Type | Interface and Description |
|---|---|
interface |
CekManagementProvider |
interface |
ClientSignatureVerifierProvider |
interface |
ContentEncryptionProvider |
interface |
HashProvider |
interface |
SignatureProvider |
| Modifier and Type | Class and Description |
|---|---|
class |
AesCbcHmacShaContentEncryptionProvider |
class |
AesGcmContentEncryptionProvider |
class |
AsymmetricClientSignatureVerifierProvider |
class |
AsymmetricSignatureProvider |
class |
ECDSAClientSignatureVerifierProvider |
class |
ECDSASignatureProvider |
class |
JavaAlgorithmHashProvider |
class |
MacSecretClientSignatureVerifierProvider |
class |
MacSecretSignatureProvider |
class |
RsaCekManagementProvider |
| Modifier and Type | Method and Description |
|---|---|
Class<? extends Provider> |
SignatureSpi.getProviderClass() |
Class<? extends Provider> |
HashSpi.getProviderClass() |
Class<? extends Provider> |
ContentEncryptionSpi.getProviderClass() |
Class<? extends Provider> |
ClientSignatureVerifierSpi.getProviderClass() |
Class<? extends Provider> |
CekManagementSpi.getProviderClass() |
| Modifier and Type | Interface and Description |
|---|---|
interface |
EmailSenderProvider |
interface |
EmailTemplateProvider |
| Modifier and Type | Class and Description |
|---|---|
class |
DefaultEmailSenderProvider |
| Modifier and Type | Method and Description |
|---|---|
Class<? extends Provider> |
EmailTemplateSpi.getProviderClass() |
Class<? extends Provider> |
EmailSenderSpi.getProviderClass() |
| Modifier and Type | Class and Description |
|---|---|
class |
FreeMarkerEmailTemplateProvider |
| Modifier and Type | Interface and Description |
|---|---|
interface |
ResourceEncodingProvider |
| Modifier and Type | Class and Description |
|---|---|
class |
GzipResourceEncodingProvider |
| Modifier and Type | Method and Description |
|---|---|
Class<? extends Provider> |
ResourceEncodingSpi.getProviderClass() |
| Modifier and Type | Interface and Description |
|---|---|
interface |
EventListenerProvider |
interface |
EventStoreProvider |
| Modifier and Type | Method and Description |
|---|---|
Class<? extends Provider> |
EventStoreSpi.getProviderClass() |
Class<? extends Provider> |
EventListenerSpi.getProviderClass() |
| Modifier and Type | Class and Description |
|---|---|
class |
EmailEventListenerProvider |
| Modifier and Type | Class and Description |
|---|---|
class |
JpaEventStoreProvider |
| Modifier and Type | Class and Description |
|---|---|
class |
JBossLoggingEventListenerProvider |
| Modifier and Type | Interface and Description |
|---|---|
interface |
ExecutorsProvider |
| Modifier and Type | Method and Description |
|---|---|
Class<? extends Provider> |
ExecutorsSpi.getProviderClass() |
| Modifier and Type | Interface and Description |
|---|---|
interface |
ClientDescriptionConverter
Provider plugin interface for importing clients from an arbitrary configuration format
|
interface |
ExportProvider |
interface |
ImportProvider |
| Modifier and Type | Class and Description |
|---|---|
class |
KeycloakClientDescriptionConverter |
| Modifier and Type | Method and Description |
|---|---|
Class<? extends Provider> |
ImportSpi.getProviderClass() |
Class<? extends Provider> |
ExportSpi.getProviderClass() |
Class<? extends Provider> |
ClientDescriptionConverterSpi.getProviderClass() |
| Modifier and Type | Class and Description |
|---|---|
class |
DirExportProvider |
class |
DirImportProvider |
| Modifier and Type | Class and Description |
|---|---|
class |
SingleFileExportProvider |
class |
SingleFileImportProvider |
| Modifier and Type | Class and Description |
|---|---|
class |
MultipleStepsExportProvider |
| Modifier and Type | Class and Description |
|---|---|
class |
KerberosFederationProvider |
| Modifier and Type | Class and Description |
|---|---|
class |
SSSDFederationProvider
SPI provider implementation to retrieve data from SSSD and authenticate
against PAM
|
| Modifier and Type | Interface and Description |
|---|---|
interface |
AccountProvider |
| Modifier and Type | Method and Description |
|---|---|
Class<? extends Provider> |
AccountSpi.getProviderClass() |
| Modifier and Type | Class and Description |
|---|---|
class |
FreeMarkerAccountProvider |
| Modifier and Type | Interface and Description |
|---|---|
interface |
LoginFormsProvider |
| Modifier and Type | Method and Description |
|---|---|
Class<? extends Provider> |
LoginFormsSpi.getProviderClass() |
| Modifier and Type | Class and Description |
|---|---|
class |
FreeMarkerLoginFormsProvider |
| Modifier and Type | Interface and Description |
|---|---|
interface |
SecurityHeadersProvider |
| Modifier and Type | Class and Description |
|---|---|
class |
DefaultSecurityHeadersProvider |
| Modifier and Type | Method and Description |
|---|---|
Class<? extends Provider> |
SecurityHeadersSpi.getProviderClass() |
| Modifier and Type | Interface and Description |
|---|---|
interface |
KeyProvider |
interface |
PublicKeyStorageProvider |
| Modifier and Type | Class and Description |
|---|---|
class |
AbstractEcdsaKeyProvider |
class |
AbstractGeneratedSecretKeyProvider |
class |
AbstractRsaKeyProvider |
class |
GeneratedAesKeyProvider |
class |
GeneratedEcdsaKeyProvider |
class |
GeneratedHmacKeyProvider |
class |
ImportedRsaKeyProvider |
class |
JavaKeystoreKeyProvider |
| Modifier and Type | Method and Description |
|---|---|
Class<? extends Provider> |
PublicKeyStorageSpi.getProviderClass() |
Class<? extends Provider> |
KeySpi.getProviderClass() |
| Modifier and Type | Class and Description |
|---|---|
class |
InfinispanPublicKeyStorageProvider |
| Modifier and Type | Interface and Description |
|---|---|
interface |
LocaleSelectorProvider |
interface |
LocaleUpdaterProvider |
| Modifier and Type | Class and Description |
|---|---|
class |
DefaultLocaleSelectorProvider |
class |
DefaultLocaleUpdaterProvider |
| Modifier and Type | Method and Description |
|---|---|
Class<? extends Provider> |
LocaleUpdaterSPI.getProviderClass() |
Class<? extends Provider> |
LocaleSelectorSPI.getProviderClass() |
| Modifier and Type | Interface and Description |
|---|---|
interface |
MigrationProvider
Various common utils needed for migration from older version to newer
|
| Modifier and Type | Method and Description |
|---|---|
Class<? extends Provider> |
MigrationSpi.getProviderClass() |
| Modifier and Type | Interface and Description |
|---|---|
interface |
ActionTokenStoreProvider
Internal action token store provider.
|
interface |
ClientProvider
Provider of the client records.
|
interface |
ClientScopeProvider
Provider of the client scopes records.
|
interface |
CodeToTokenStoreProvider
Provides single-use cache for OAuth2 code parameter.
|
interface |
DeploymentStateProvider |
interface |
GroupProvider
Provider of group records
|
interface |
OAuth2DeviceTokenStoreProvider
Provides cache for OAuth2 Device Authorization Grant tokens.
|
interface |
OAuth2DeviceUserCodeProvider |
interface |
RealmProvider |
interface |
RoleProvider
Provider of the role records.
|
interface |
SamlArtifactSessionMappingStoreProvider
Provides cache for session mapping for SAML artifacts.
|
interface |
SingleUseTokenStoreProvider
Provides single-use cache for OAuth2 code parameter.
|
interface |
TokenRevocationStoreProvider
Provides the cache for store revoked tokens.
|
interface |
UserCredentialManager |
static interface |
UserCredentialManager.Streams
The
UserCredentialManager.Streams interface makes all collection-based methods in UserCredentialManager
default by providing implementations that delegate to the Stream-based variants instead of the other way around. |
interface |
UserLoginFailureProvider |
interface |
UserProvider |
static interface |
UserProvider.Streams
The
UserProvider.Streams interface makes all collection-based methods in UserProvider default by
providing implementations that delegate to the Stream-based variants instead of the other way around. |
interface |
UserSessionProvider |
| Modifier and Type | Class and Description |
|---|---|
class |
DefaultOAuth2DeviceUserCodeProvider
The default implementation for generating/formatting user code of OAuth 2.0 Device Authorization Grant.
|
| Modifier and Type | Method and Description |
|---|---|
<T extends Provider> |
KeycloakSession.getAllProviders(Class<T> clazz) |
<T extends Provider> |
KeycloakSession.getComponentProvider(Class<T> clazz,
String componentId)
Returns a component provider for a component from the realm that is relevant to this session.
|
<T extends Provider> |
KeycloakSession.getComponentProvider(Class<T> clazz,
String componentId,
Function<KeycloakSessionFactory,ComponentModel> modelGetter)
Returns a component provider for a component from the realm that is relevant to this session.
|
<T extends Provider> |
KeycloakSession.getProvider(Class<T> clazz)
Get dedicated provider instance of provider type clazz that was created for this session.
|
<T extends Provider> |
KeycloakSession.getProvider(Class<T> clazz,
ComponentModel componentModel)
Deprecated.
Deprecated in favor of {@link #getComponentProvider)
|
<T extends Provider> |
KeycloakSession.getProvider(Class<T> clazz,
String id)
Get dedicated provider instance for a specific provider factory of id of provider type clazz that was created for this session.
|
<T extends Provider> |
KeycloakSessionFactory.getProviderFactory(Class<T> clazz) |
<T extends Provider> |
KeycloakSessionFactory.getProviderFactory(Class<T> clazz,
String id) |
<T extends Provider> |
KeycloakSessionFactory.getProviderFactory(Class<T> clazz,
String realmId,
String componentId,
Function<KeycloakSessionFactory,ComponentModel> modelGetter) |
<T extends Provider> |
KeycloakSession.listProviderIds(Class<T> clazz)
Get all provider factories that manage provider instances of class.
|
| Modifier and Type | Method and Description |
|---|---|
Class<? extends Provider> |
UserSpi.getProviderClass() |
Class<? extends Provider> |
UserSessionSpi.getProviderClass() |
Class<? extends Provider> |
UserLoginFailureSpi.getProviderClass() |
Class<? extends Provider> |
TokenRevocationStoreSpi.getProviderClass() |
Class<? extends Provider> |
SingleUseTokenStoreSpi.getProviderClass() |
Class<? extends Provider> |
SamlArtifactSessionMappingStoreSpi.getProviderClass() |
Class<? extends Provider> |
RoleSpi.getProviderClass() |
Class<? extends Provider> |
RealmSpi.getProviderClass() |
Class<? extends Provider> |
OAuth2DeviceUserCodeSpi.getProviderClass() |
Class<? extends Provider> |
OAuth2DeviceTokenStoreSpi.getProviderClass() |
Class<? extends Provider> |
GroupSpi.getProviderClass() |
Class<? extends Provider> |
DeploymentStateSpi.getProviderClass() |
Class<? extends Provider> |
CodeToTokenStoreSpi.getProviderClass() |
Class<? extends Provider> |
ClientSpi.getProviderClass() |
Class<? extends Provider> |
ClientScopeSpi.getProviderClass() |
Class<? extends Provider> |
ActionTokenStoreSpi.getProviderClass() |
Class<? extends Provider> |
KeycloakSession.getProviderClass(String providerClassName) |
| Modifier and Type | Method and Description |
|---|---|
void |
KeycloakSession.enlistForClose(Provider provider) |
| Modifier and Type | Method and Description |
|---|---|
default List<ProviderFactory> |
KeycloakSessionFactory.getProviderFactories(Class<? extends Provider> clazz)
Deprecated.
Use
getProviderFactoriesStream instead. |
Stream<ProviderFactory> |
KeycloakSessionFactory.getProviderFactoriesStream(Class<? extends Provider> clazz)
Returns stream of provider factories for the given provider.
|
Spi |
KeycloakSessionFactory.getSpi(Class<? extends Provider> providerClass) |
default Stream<ComponentModel> |
RealmModel.getStorageProviders(Class<? extends Provider> storageProviderClass)
Returns stream of ComponentModels that represent StorageProviders for class storageProviderClass in this realm.
|
| Modifier and Type | Interface and Description |
|---|---|
interface |
CacheRealmProvider |
interface |
UserCache
All these methods effect an entire cluster of Keycloak instances.
|
static interface |
UserCache.Streams
The
UserCache.Streams interface differs from UserCache in that it extends the UserProvider.Streams
interface, allowing implementations of UserCache to focus on the Stream-based methods
in the UserProvider interface. |
| Modifier and Type | Method and Description |
|---|---|
Class<? extends Provider> |
CacheUserProviderSpi.getProviderClass() |
Class<? extends Provider> |
CacheRealmProviderSpi.getProviderClass() |
| Modifier and Type | Interface and Description |
|---|---|
interface |
CachedStoreFactoryProvider |
| Modifier and Type | Method and Description |
|---|---|
Class<? extends Provider> |
CachedStoreFactorySpi.getProviderClass() |
| Modifier and Type | Class and Description |
|---|---|
class |
RealmCacheSession
- the high level architecture of this cache is an invalidation cache.
|
class |
UserCacheSession |
| Modifier and Type | Class and Description |
|---|---|
class |
StoreFactoryCacheSession |
| Modifier and Type | Interface and Description |
|---|---|
interface |
DBLockProvider
Global database lock to ensure that some actions in DB can be done just be
one cluster node at a time.
|
| Modifier and Type | Method and Description |
|---|---|
Class<? extends Provider> |
DBLockSpi.getProviderClass() |
| Modifier and Type | Class and Description |
|---|---|
class |
JpaRealmProvider |
class |
JpaUserCredentialStore |
class |
JpaUserProvider |
| Modifier and Type | Class and Description |
|---|---|
class |
JpaUserSessionPersisterProvider |
| Modifier and Type | Class and Description |
|---|---|
class |
MapAuthorizationStore |
| Modifier and Type | Class and Description |
|---|---|
class |
MapRootAuthenticationSessionProvider<K> |
| Modifier and Type | Class and Description |
|---|---|
class |
MapClientProvider<K> |
| Modifier and Type | Class and Description |
|---|---|
class |
MapClientScopeProvider<K> |
| Modifier and Type | Class and Description |
|---|---|
class |
AbstractMapProviderFactory<T extends Provider,K,V extends AbstractEntity<K>,M> |
| Modifier and Type | Class and Description |
|---|---|
class |
MapGroupProvider<K> |
| Modifier and Type | Class and Description |
|---|---|
class |
MapUserLoginFailureProvider<K> |
| Modifier and Type | Class and Description |
|---|---|
class |
MapRealmProvider<K> |
| Modifier and Type | Class and Description |
|---|---|
class |
MapRoleProvider<K> |
| Modifier and Type | Interface and Description |
|---|---|
interface |
MapStorageProvider |
| Modifier and Type | Method and Description |
|---|---|
Class<? extends Provider> |
MapStorageSpi.getProviderClass() |
| Modifier and Type | Class and Description |
|---|---|
class |
ConcurrentHashMapStorageProvider |
| Modifier and Type | Class and Description |
|---|---|
class |
MapUserProvider<K> |
| Modifier and Type | Class and Description |
|---|---|
class |
MapUserSessionProvider<UK,CK> |
| Modifier and Type | Interface and Description |
|---|---|
interface |
UserSessionPersisterProvider |
| Modifier and Type | Class and Description |
|---|---|
class |
DisabledUserSessionPersisterProvider
Persistence of userSessions is disabled .
|
| Modifier and Type | Method and Description |
|---|---|
Class<? extends Provider> |
UserSessionPersisterSpi.getProviderClass() |
| Modifier and Type | Class and Description |
|---|---|
class |
InfinispanActionTokenStoreProvider |
class |
InfinispanAuthenticationSessionProvider |
class |
InfinispanCodeToTokenStoreProvider |
class |
InfinispanOAuth2DeviceTokenStoreProvider |
class |
InfinispanSamlArtifactSessionMappingStoreProvider |
class |
InfinispanSingleUseTokenStoreProvider
TODO: Check if Boolean can be used as single-use cache argument instead of ActionTokenValueEntity.
|
class |
InfinispanStickySessionEncoderProvider |
class |
InfinispanTokenRevocationStoreProvider |
class |
InfinispanUserLoginFailureProvider |
class |
InfinispanUserSessionProvider |
| Modifier and Type | Class and Description |
|---|---|
class |
AbstractUserSessionClusterListener<SE extends SessionClusterEvent,T extends Provider> |
| Modifier and Type | Method and Description |
|---|---|
static <T extends Provider> |
KeycloakModelUtils.getComponentFactory(KeycloakSessionFactory factory,
Class<T> providerClass,
Config.Scope config,
String spiName) |
| Modifier and Type | Interface and Description |
|---|---|
interface |
PasswordPolicyManagerProvider |
interface |
PasswordPolicyProvider |
| Modifier and Type | Class and Description |
|---|---|
class |
BlacklistPasswordPolicyProvider
Checks a password against a configured password blacklist.
|
class |
DefaultPasswordPolicyManagerProvider |
class |
DigitsPasswordPolicyProvider |
class |
ForceExpiredPasswordPolicyProviderFactory |
class |
HashAlgorithmPasswordPolicyProviderFactory |
class |
HashIterationsPasswordPolicyProviderFactory |
class |
HistoryPasswordPolicyProvider |
class |
LengthPasswordPolicyProvider |
class |
LowerCasePasswordPolicyProvider |
class |
NotEmailPasswordPolicyProvider
A
PasswordPolicyProvider which does not allow to use the current email as password. |
class |
NotUsernamePasswordPolicyProvider |
class |
RegexPatternsPasswordPolicyProvider |
class |
SpecialCharsPasswordPolicyProvider |
class |
UpperCasePasswordPolicyProvider |
| Modifier and Type | Method and Description |
|---|---|
Class<? extends Provider> |
PasswordPolicySpi.getProviderClass() |
Class<? extends Provider> |
PasswordPolicyManagerSpi.getProviderClass() |
| Modifier and Type | Interface and Description |
|---|---|
interface |
ClientInstallationProvider
Provides a template/sample client config adapter file.
|
interface |
LoginProtocol |
interface |
ProtocolMapper |
| Modifier and Type | Method and Description |
|---|---|
Class<? extends Provider> |
ProtocolMapperSpi.getProviderClass() |
Class<? extends Provider> |
LoginProtocolSpi.getProviderClass() |
Class<? extends Provider> |
ClientInstallationSpi.getProviderClass() |
| Modifier and Type | Class and Description |
|---|---|
class |
DockerAuthenticator |
class |
DockerAuthV2Protocol |
| Modifier and Type | Class and Description |
|---|---|
class |
DockerComposeYamlInstallationProvider |
class |
DockerRegistryConfigFileInstallationProvider |
class |
DockerVariableOverrideInstallationProvider |
| Modifier and Type | Class and Description |
|---|---|
class |
AllowAllDockerProtocolMapper
Populates token with requested scope.
|
class |
DockerAuthV2ProtocolMapper |
| Modifier and Type | Interface and Description |
|---|---|
interface |
TokenIntrospectionProvider
Provides introspection for a determined OAuth2 token type.
|
| Modifier and Type | Class and Description |
|---|---|
class |
AccessTokenIntrospectionProvider |
class |
OIDCClientDescriptionConverter |
class |
OIDCLoginProtocol |
class |
OIDCWellKnownProvider |
class |
RefreshTokenIntrospectionProvider |
| Modifier and Type | Method and Description |
|---|---|
Class<? extends Provider> |
TokenIntrospectionSpi.getProviderClass() |
| Modifier and Type | Interface and Description |
|---|---|
interface |
OIDCExtProvider |
| Modifier and Type | Method and Description |
|---|---|
Class<? extends Provider> |
OIDCExtSPI.getProviderClass() |
| Modifier and Type | Interface and Description |
|---|---|
interface |
AuthenticationChannelProvider
Provides the interface for requesting the authentication(AuthN) and authorization(AuthZ) by an authentication device (AD) to the external entity via Authentication Channel.
|
| Modifier and Type | Class and Description |
|---|---|
class |
HttpAuthenticationChannelProvider |
| Modifier and Type | Method and Description |
|---|---|
Class<? extends Provider> |
AuthenticationChannelSpi.getProviderClass() |
| Modifier and Type | Class and Description |
|---|---|
class |
CibaRootEndpoint |
| Modifier and Type | Interface and Description |
|---|---|
interface |
CIBALoginUserResolver
Provides the resolver that converts several types of receives login hint to its corresponding UserModel.
|
| Modifier and Type | Class and Description |
|---|---|
class |
DefaultCIBALoginUserResolver |
| Modifier and Type | Method and Description |
|---|---|
Class<? extends Provider> |
CIBALoginUserResolverSpi.getProviderClass() |
| Modifier and Type | Class and Description |
|---|---|
class |
DeviceEndpoint |
| Modifier and Type | Class and Description |
|---|---|
class |
KeycloakOIDCClientInstallation |
class |
KeycloakOIDCJbossSubsystemClientCliInstallation |
class |
KeycloakOIDCJbossSubsystemClientInstallation |
| Modifier and Type | Class and Description |
|---|---|
class |
AbstractOIDCProtocolMapper |
class |
AbstractPairwiseSubMapper
Set the 'sub' claim to pairwise .
|
class |
AddressMapper |
class |
AllowedWebOriginsProtocolMapper
Protocol mapper to add allowed web origins to the access token to the 'allowed-origins' claim
|
class |
AudienceProtocolMapper |
class |
AudienceResolveProtocolMapper
Protocol mapper, which adds all client_ids of "allowed" clients to the audience field of the token.
|
class |
ClaimsParameterTokenMapper |
class |
DeployedScriptOIDCProtocolMapper |
class |
FullNameMapper
Set the 'name' claim to be first + last name.
|
class |
GroupMembershipMapper
Maps user group membership
|
class |
HardcodedClaim |
class |
HardcodedRole
Add a role to a token
|
class |
RoleNameMapper
Map an assigned role to a different position and name in the token
|
class |
ScriptBasedOIDCProtocolMapper
OIDC
ProtocolMapper that uses a provided JavaScript fragment to compute the token claim value. |
class |
SHA256PairwiseSubMapper |
class |
UserClientRoleMappingMapper
Allows mapping of user client role mappings to an ID and Access Token claim.
|
class |
UserPropertyMapper
Mappings UserModel property (the property name of a getter method) to an ID Token claim.
|
class |
UserRealmRoleMappingMapper
Allows mapping of user realm role mappings to an ID and Access Token claim.
|
class |
UserSessionNoteMapper
Mappings UserSessionModel.note to an ID Token claim.
|
| Modifier and Type | Class and Description |
|---|---|
class |
OpenShiftTokenReviewEndpoint |
| Modifier and Type | Interface and Description |
|---|---|
interface |
ArtifactResolver
Provides a way to create and resolve artifacts for SAML Artifact binding
|
| Modifier and Type | Class and Description |
|---|---|
class |
DefaultSamlArtifactResolver
ArtifactResolver for artifact-04 format.
|
class |
EntityDescriptorDescriptionConverter |
class |
SamlProtocol |
| Modifier and Type | Method and Description |
|---|---|
Class<? extends Provider> |
ArtifactResolverSpi.getProviderClass() |
| Modifier and Type | Class and Description |
|---|---|
class |
EntityDescriptorClientRegistrationProvider |
| Modifier and Type | Class and Description |
|---|---|
class |
KeycloakSamlClientInstallation |
class |
KeycloakSamlSubsystemCliInstallation |
class |
KeycloakSamlSubsystemInstallation |
class |
ModAuthMellonClientInstallation |
class |
SamlSPDescriptorClientInstallation |
| Modifier and Type | Class and Description |
|---|---|
class |
AbstractSAMLProtocolMapper |
class |
RoleListMapper |
class |
SAMLAudienceProtocolMapper
SAML mapper to add a audience restriction into the assertion, to another
client (clientId) or to a custom URI.
|
class |
SAMLAudienceResolveProtocolMapper
SAML audience resolve mapper.
|
class |
ScriptBasedMapper
This class provides a mapper that uses javascript to attach a value to an attribute for SAML tokens.
|
class |
UserAttributeNameIdMapper |
class |
UserAttributeStatementMapper
Mappings UserModel attribute (not property name of a getter method) to an AttributeStatement.
|
class |
UserPropertyAttributeStatementMapper
Mappings UserModel property (the property name of a getter method) to an AttributeStatement.
|
class |
UserSessionNoteStatementMapper
Maps a user session note to a SAML attribute
|
| Modifier and Type | Interface and Description |
|---|---|
interface |
SamlAuthenticationPreprocessor
Provider interface for SAML authentication preprocessing.
|
| Modifier and Type | Method and Description |
|---|---|
Class<? extends Provider> |
SamlAuthenticationPreprocessorSpi.getProviderClass() |
| Modifier and Type | Class and Description |
|---|---|
class |
HttpBasicAuthenticator |
| Modifier and Type | Interface and Description |
|---|---|
interface |
ProviderFactory<T extends Provider>
At boot time, keycloak discovers all factories.
|
| Modifier and Type | Interface and Description |
|---|---|
interface |
ExceptionConverter
Use to unwrap exceptions specifically if there is an exception at JTA commit
|
| Modifier and Type | Method and Description |
|---|---|
MultivaluedHashMap<Class<? extends Provider>,ProviderFactory> |
ProviderManager.getLoadedFactories()
returns a copy of internal factories.
|
Class<? extends Provider> |
ExceptionConverterSpi.getProviderClass() |
Class<? extends Provider> |
Spi.getProviderClass() |
| Modifier and Type | Interface and Description |
|---|---|
interface |
ScriptingProvider
A
Provider than provides Scripting capabilities. |
| Modifier and Type | Class and Description |
|---|---|
class |
DefaultScriptingProvider
|
| Modifier and Type | Method and Description |
|---|---|
Class<? extends Provider> |
ScriptingSpi.getProviderClass() |
| Modifier and Type | Field and Description |
|---|---|
protected Map<Class<? extends Provider>,Map<String,ProviderFactory>> |
DefaultKeycloakSessionFactory.factoriesMap |
protected Map<Class<? extends Provider>,String> |
DefaultKeycloakSessionFactory.provider |
| Modifier and Type | Method and Description |
|---|---|
<T extends Provider> |
DefaultKeycloakSession.getAllProviders(Class<T> clazz) |
<T extends Provider> |
DefaultKeycloakSession.getComponentProvider(Class<T> clazz,
String componentId) |
<T extends Provider> |
DefaultKeycloakSession.getComponentProvider(Class<T> clazz,
String componentId,
Function<KeycloakSessionFactory,ComponentModel> modelGetter) |
<T extends Provider> |
DefaultKeycloakSession.getProvider(Class<T> clazz) |
<T extends Provider> |
DefaultKeycloakSession.getProvider(Class<T> clazz,
ComponentModel componentModel) |
<T extends Provider> |
DefaultKeycloakSession.getProvider(Class<T> clazz,
String id) |
<T extends Provider> |
DefaultKeycloakSessionFactory.getProviderFactory(Class<T> clazz) |
<T extends Provider> |
DefaultKeycloakSessionFactory.getProviderFactory(Class<T> clazz,
String id) |
<T extends Provider> |
DefaultKeycloakSessionFactory.getProviderFactory(Class<T> clazz,
String realmId,
String componentId,
Function<KeycloakSessionFactory,ComponentModel> modelGetter) |
<T extends Provider> |
DefaultComponentFactoryProviderFactory.getProviderFactory(Class<T> clazz,
String realmId,
String componentId,
Function<KeycloakSessionFactory,ComponentModel> modelGetter) |
protected <T extends Provider> |
DefaultComponentFactoryProviderFactory.initializeFactory(Class<T> clazz,
String realmId,
String componentId,
ProviderFactory newFactory,
ComponentModelScope configScope) |
<T extends Provider> |
DefaultKeycloakSession.listProviderIds(Class<T> clazz) |
| Modifier and Type | Method and Description |
|---|---|
protected Map<Class<? extends Provider>,Map<String,ProviderFactory>> |
DefaultKeycloakSessionFactory.getFactoriesCopy() |
Class<? extends Provider> |
DefaultKeycloakSession.getProviderClass(String providerClassName) |
protected Map<Class<? extends Provider>,Map<String,ProviderFactory>> |
DefaultKeycloakSessionFactory.loadFactories(ProviderManager pm) |
| Modifier and Type | Method and Description |
|---|---|
void |
DefaultKeycloakSession.enlistForClose(Provider provider) |
| Modifier and Type | Method and Description |
|---|---|
Stream<ProviderFactory> |
DefaultKeycloakSessionFactory.getProviderFactoriesStream(Class<? extends Provider> clazz) |
Spi |
DefaultKeycloakSessionFactory.getSpi(Class<? extends Provider> providerClass) |
| Modifier and Type | Interface and Description |
|---|---|
interface |
ClientPolicyManager
Provides a method for handling an event defined in
ClientPolicyEvent. |
| Modifier and Type | Class and Description |
|---|---|
class |
DefaultClientPolicyManager |
| Modifier and Type | Method and Description |
|---|---|
Class<? extends Provider> |
ClientPolicyManagerSpi.getProviderClass() |
| Modifier and Type | Interface and Description |
|---|---|
interface |
ClientPolicyConditionProvider<CONFIG extends ClientPolicyConditionConfigurationRepresentation>
This condition determines to which client a client policy is adopted.
|
| Modifier and Type | Class and Description |
|---|---|
class |
AbstractClientPolicyConditionProvider<CONFIG extends ClientPolicyConditionConfigurationRepresentation> |
class |
AnyClientCondition |
class |
ClientAccessTypeCondition |
class |
ClientRolesCondition |
class |
ClientScopesCondition |
class |
ClientUpdaterContextCondition |
class |
ClientUpdaterSourceGroupsCondition |
class |
ClientUpdaterSourceHostsCondition |
class |
ClientUpdaterSourceRolesCondition |
| Modifier and Type | Method and Description |
|---|---|
Class<? extends Provider> |
ClientPolicyConditionSpi.getProviderClass() |
| Modifier and Type | Interface and Description |
|---|---|
interface |
ClientPolicyExecutorProvider<CONFIG extends ClientPolicyExecutorConfigurationRepresentation>
This executor specifies what action is executed on the client to which a client policy is adopted.
|
| Modifier and Type | Class and Description |
|---|---|
class |
ConfidentialClientAcceptExecutor |
class |
ConsentRequiredExecutor |
class |
FullScopeDisabledExecutor
Check that switch "fullScopeAllowed" is not enabled for the clients
|
class |
HolderOfKeyEnforcerExecutor |
class |
PKCEEnforcerExecutor |
class |
SecureClientAuthenticatorExecutor |
class |
SecureClientUrisExecutor |
class |
SecureRequestObjectExecutor |
class |
SecureResponseTypeExecutor |
class |
SecureSessionEnforceExecutor |
class |
SecureSigningAlgorithmExecutor |
class |
SecureSigningAlgorithmForSignedJwtExecutor |
| Modifier and Type | Method and Description |
|---|---|
Class<? extends Provider> |
ClientPolicyExecutorSpi.getProviderClass() |
| Modifier and Type | Interface and Description |
|---|---|
interface |
ClientRegistrationProvider |
| Modifier and Type | Class and Description |
|---|---|
class |
AbstractClientRegistrationProvider |
class |
AdapterInstallationClientRegistrationProvider |
class |
DefaultClientRegistrationProvider |
| Modifier and Type | Method and Description |
|---|---|
Class<? extends Provider> |
ClientRegistrationSpi.getProviderClass() |
| Modifier and Type | Class and Description |
|---|---|
class |
OIDCClientRegistrationProvider |
| Modifier and Type | Interface and Description |
|---|---|
interface |
ClientRegistrationPolicy |
| Modifier and Type | Method and Description |
|---|---|
Class<? extends Provider> |
ClientRegistrationPolicySpi.getProviderClass() |
| Modifier and Type | Class and Description |
|---|---|
class |
ClientDisabledClientRegistrationPolicy |
class |
ClientScopesClientRegistrationPolicy |
class |
ConsentRequiredClientRegistrationPolicy |
class |
MaxClientsClientRegistrationPolicy |
class |
ProtocolMappersClientRegistrationPolicy |
class |
ScopeClientRegistrationPolicy |
class |
TrustedHostClientRegistrationPolicy |
| Modifier and Type | Interface and Description |
|---|---|
interface |
BruteForceProtector |
| Modifier and Type | Class and Description |
|---|---|
class |
DefaultBruteForceProtector
A single thread will log failures.
|
| Modifier and Type | Method and Description |
|---|---|
Class<? extends Provider> |
BruteForceProtectorSpi.getProviderClass() |
| Modifier and Type | Class and Description |
|---|---|
class |
DefaultMigrationProvider
Various common utils needed for migration from older version to newer
|
| Modifier and Type | Interface and Description |
|---|---|
interface |
RealmResourceProvider
A
RealmResourceProvider creates JAX-RS |
| Modifier and Type | Method and Description |
|---|---|
Class<? extends Provider> |
RealmResourceSPI.getProviderClass() |
| Modifier and Type | Interface and Description |
|---|---|
interface |
X509ClientCertificateLookup |
| Modifier and Type | Class and Description |
|---|---|
class |
AbstractClientCertificateFromHttpHeadersLookup |
class |
ApacheProxySslClientCertificateLookup
The provider allows to extract X.509 client certificate forwarded
to keycloak configured behind the Apache reverse proxy.
|
class |
DefaultClientCertificateLookup
The provider retrieves a client certificate and the certificate chain
(if any) from the incoming TLS connection.
|
class |
HaProxySslClientCertificateLookup
The provider allows to extract X.509 client certificate forwarded
to the keycloak middleware configured behind the haproxy reverse proxy.
|
class |
NginxProxySslClientCertificateLookup
The NGINX Provider extract end user X.509 certificate send during TLS mutual authentication,
and forwarded in an http header.
|
| Modifier and Type | Method and Description |
|---|---|
Class<? extends Provider> |
X509ClientCertificateLookupSpi.getProviderClass() |
| Modifier and Type | Interface and Description |
|---|---|
interface |
AuthenticationSessionProvider |
interface |
StickySessionEncoderProvider |
| Modifier and Type | Method and Description |
|---|---|
Class<? extends Provider> |
StickySessionEncoderSpi.getProviderClass() |
Class<? extends Provider> |
AuthenticationSessionSpi.getProviderClass() |
| Modifier and Type | Class and Description |
|---|---|
class |
BitbucketIdentityProvider |
| Modifier and Type | Class and Description |
|---|---|
class |
FacebookIdentityProvider |
class |
FacebookUserAttributeMapper
User attribute mapper.
|
| Modifier and Type | Class and Description |
|---|---|
class |
GitHubIdentityProvider |
class |
GitHubUserAttributeMapper
User attribute mapper.
|
| Modifier and Type | Class and Description |
|---|---|
class |
GitLabIdentityProvider |
| Modifier and Type | Class and Description |
|---|---|
class |
GoogleIdentityProvider |
class |
GoogleUserAttributeMapper
User attribute mapper.
|
| Modifier and Type | Class and Description |
|---|---|
class |
InstagramIdentityProvider |
class |
InstagramUserAttributeMapper
User attribute mapper.
|
| Modifier and Type | Class and Description |
|---|---|
class |
LinkedInIdentityProvider
LinkedIn social provider.
|
class |
LinkedInUserAttributeMapper
User attribute mapper.
|
| Modifier and Type | Class and Description |
|---|---|
class |
MicrosoftIdentityProvider
Identity provider for Microsoft account.
|
class |
MicrosoftUserAttributeMapper
User attribute mapper.
|
| Modifier and Type | Class and Description |
|---|---|
class |
OpenshiftV3IdentityProvider
Identity provider for Openshift V3.
|
class |
OpenshiftV4IdentityProvider
Identity provider for Openshift V4.
|
| Modifier and Type | Class and Description |
|---|---|
class |
PayPalIdentityProvider |
class |
PayPalUserAttributeMapper
User attribute mapper.
|
| Modifier and Type | Class and Description |
|---|---|
class |
StackoverflowIdentityProvider
Stackoverflow social provider.
|
class |
StackoverflowUserAttributeMapper
User attribute mapper.
|
| Modifier and Type | Class and Description |
|---|---|
class |
TwitterIdentityProvider |
| Modifier and Type | Class and Description |
|---|---|
class |
AbstractStorageManager<ProviderType extends Provider,StorageProviderModelType extends CacheableStorageProviderModel> |
| Modifier and Type | Interface and Description |
|---|---|
interface |
UserStorageProvider
A class implementing this interface represents a user storage provider to Keycloak.
|
| Modifier and Type | Class and Description |
|---|---|
class |
ClientScopeStorageManager |
class |
ClientStorageManager |
class |
GroupStorageManager |
class |
RoleStorageManager |
class |
UserStorageManager |
| Modifier and Type | Method and Description |
|---|---|
Class<? extends Provider> |
UserStorageProviderSpi.getProviderClass() |
| Modifier and Type | Method and Description |
|---|---|
static Stream<ComponentModel> |
AbstractStorageManager.getStorageProviderModels(RealmModel realm,
Class<? extends Provider> storageType)
Stream of ComponentModels of storageType.
|
| Modifier and Type | Interface and Description |
|---|---|
interface |
ClientStorageProvider
Base interface for components that want to provide an alternative storage mechanism for clients
This is currently a private incomplete SPI.
|
| Modifier and Type | Method and Description |
|---|---|
Class<? extends Provider> |
ClientStorageProviderSpi.getProviderClass() |
| Modifier and Type | Interface and Description |
|---|---|
interface |
ClientScopeStorageProvider |
| Modifier and Type | Method and Description |
|---|---|
Class<? extends Provider> |
ClientScopeStorageProviderSpi.getProviderClass() |
| Modifier and Type | Interface and Description |
|---|---|
interface |
UserFederatedStorageProvider |
static interface |
UserFederatedStorageProvider.Streams
The
UserFederatedStorageProvider.Streams interface makes all collection-based methods in UserFederatedStorageProvider
default by providing implementations that delegate to the Stream-based variants instead of the other way
around. |
interface |
UserFederatedUserCredentialStore |
static interface |
UserFederatedUserCredentialStore.Streams
The
UserFederatedUserCredentialStore.Streams interface makes all collection-based methods in UserFederatedUserCredentialStore
default by providing implementations that delegate to the Stream-based variants instead of the other way
around. |
| Modifier and Type | Method and Description |
|---|---|
Class<? extends Provider> |
UserFederatedStorageProviderSpi.getProviderClass() |
| Modifier and Type | Interface and Description |
|---|---|
interface |
GroupStorageProvider |
| Modifier and Type | Method and Description |
|---|---|
Class<? extends Provider> |
GroupStorageProviderSpi.getProviderClass() |
| Modifier and Type | Class and Description |
|---|---|
class |
JpaUserFederatedStorageProvider |
| Modifier and Type | Class and Description |
|---|---|
class |
LDAPStorageProvider |
| Modifier and Type | Interface and Description |
|---|---|
interface |
LDAPStorageMapper |
| Modifier and Type | Class and Description |
|---|---|
class |
AbstractLDAPStorageMapper
Stateful per-request object
|
class |
CertificateLDAPStorageMapper |
class |
FullNameLDAPStorageMapper
Mapper useful for the LDAP deployments when some attribute (usually CN) is mapped to full name of user
|
class |
HardcodedLDAPAttributeMapper |
class |
HardcodedLDAPGroupStorageMapper |
class |
HardcodedLDAPRoleStorageMapper |
class |
UserAttributeLDAPStorageMapper |
| Modifier and Type | Method and Description |
|---|---|
Class<? extends Provider> |
LDAPStorageMapperSpi.getProviderClass() |
| Modifier and Type | Interface and Description |
|---|---|
interface |
CommonLDAPGroupMapper
Mapper related to mapping of LDAP groups to keycloak model objects (either keycloak roles or keycloak groups)
|
| Modifier and Type | Class and Description |
|---|---|
class |
GroupLDAPStorageMapper |
| Modifier and Type | Class and Description |
|---|---|
class |
RoleLDAPStorageMapper
Map realm roles or roles of particular client to LDAP groups
|
| Modifier and Type | Class and Description |
|---|---|
class |
MSADUserAccountControlStorageMapper
Mapper specific to MSAD.
|
| Modifier and Type | Class and Description |
|---|---|
class |
MSADLDSUserAccountControlStorageMapper
Mapper specific to MSAD LDS.
|
| Modifier and Type | Class and Description |
|---|---|
class |
OpenshiftClientStorageProvider |
| Modifier and Type | Interface and Description |
|---|---|
interface |
RoleStorageProvider
Base interface for components that want to provide an alternative storage mechanism for roles
|
| Modifier and Type | Method and Description |
|---|---|
Class<? extends Provider> |
RoleStorageProviderSpi.getProviderClass() |
| Modifier and Type | Interface and Description |
|---|---|
interface |
ThemeProvider |
interface |
ThemeResourceProvider
A theme resource provider can be used to load additional templates and resources.
|
interface |
ThemeSelectorProvider |
| Modifier and Type | Class and Description |
|---|---|
class |
ClasspathThemeProvider |
class |
ClasspathThemeResourceProviderFactory |
class |
DefaultThemeSelectorProvider |
class |
FolderThemeProvider |
| Modifier and Type | Method and Description |
|---|---|
Class<? extends Provider> |
ThemeSpi.getProviderClass() |
Class<? extends Provider> |
ThemeSelectorSpi.getProviderClass() |
Class<? extends Provider> |
ThemeResourceSpi.getProviderClass() |
| Modifier and Type | Interface and Description |
|---|---|
interface |
TimerProvider |
| Modifier and Type | Method and Description |
|---|---|
Class<? extends Provider> |
TimerSpi.getProviderClass() |
| Modifier and Type | Class and Description |
|---|---|
class |
BasicTimerProvider |
| Modifier and Type | Interface and Description |
|---|---|
interface |
JtaTransactionManagerLookup
JTA TransactionManager lookup
|
| Modifier and Type | Class and Description |
|---|---|
class |
JBossJtaTransactionManagerLookup |
| Modifier and Type | Method and Description |
|---|---|
Class<? extends Provider> |
TransactionManagerLookupSpi.getProviderClass() |
| Modifier and Type | Interface and Description |
|---|---|
interface |
TruststoreProvider |
| Modifier and Type | Class and Description |
|---|---|
class |
FileTruststoreProvider |
| Modifier and Type | Method and Description |
|---|---|
Class<? extends Provider> |
TruststoreSpi.getProviderClass() |
| Modifier and Type | Class and Description |
|---|---|
class |
DefaultHostnameProvider |
class |
FixedHostnameProvider
Deprecated.
|
class |
RequestHostnameProvider
Deprecated.
|
| Modifier and Type | Interface and Description |
|---|---|
interface |
HostnameProvider
The Hostname provider is used by Keycloak to decide URLs for frontend and backend requests.
|
| Modifier and Type | Method and Description |
|---|---|
Class<? extends Provider> |
HostnameSpi.getProviderClass() |
| Modifier and Type | Interface and Description |
|---|---|
interface |
UserProfileProvider
The provider responsible for creating
UserProfile instances. |
| Modifier and Type | Method and Description |
|---|---|
Class<? extends Provider> |
UserProfileSpi.getProviderClass() |
| Modifier and Type | Class and Description |
|---|---|
class |
DeclarativeUserProfileProvider
UserProfileProvider loading configuration from the changeable JSON file stored in component config. |
| Modifier and Type | Class and Description |
|---|---|
class |
AbstractUserProfileProvider<U extends UserProfileProvider>
A base class for
UserProfileProvider implementations providing the main hooks for customizations. |
class |
DefaultUserProfileProvider |
| Modifier and Type | Class and Description |
|---|---|
class |
AttributeRequiredByMetadataValidator
Validator to check that User Profile attribute value is not blank (nor null) if the attribute is required based on
AttributeMetadata predicate.
|
class |
BlankAttributeValidator
Validator to check that User Profile attribute value is not blank (null value is OK!).
|
class |
BrokeringFederatedUsernameHasValueValidator
Validator to check that User Profile username is provided during Brokerin/Federation.
|
class |
DuplicateEmailValidator
Validator to check User Profile email duplication conditions based on realm settings like isDuplicateEmailsAllowed.
|
class |
DuplicateUsernameValidator
Validator to check that User Profile username already exists in database for another user in case of it's change, and
fail in this case.
|
class |
EmailExistsAsUsernameValidator
Validator to check User Profile email duplication conditions if isDuplicateEmailsAllowed is false but
isRegistrationEmailAsUsername is true.
|
class |
ImmutableAttributeValidator
A validator that fails when the attribute is marked as read only and its value has changed.
|
class |
ReadOnlyAttributeUnchangedValidator
Validator to check that User Profile attribute value is not changed if attribute is read-only.
|
class |
RegistrationEmailAsUsernameEmailValueValidator
Validator to check User Profile email attribute value during Registration when "RegistrationEmailAsUsername()" is
enabled.
|
class |
RegistrationEmailAsUsernameUsernameValueValidator
Validator to check User Profile username attribute value during Registration when "RegistrationEmailAsUsername()" is
enabled.
|
class |
RegistrationUsernameExistsValidator
Validator to check User Profile username attribute uniqueness during registration (when
"RegistrationEmailAsUsername()" is NOT enabled).
|
class |
UsernameHasValueValidator
Validator to check that User Profile username is provided.
|
class |
UsernameMutationValidator
Validator to check User Profile username change and prevent it if not allowed in realm.
|
| Modifier and Type | Interface and Description |
|---|---|
interface |
SimpleValidator
Convenience interface to ease implementation of small
Validator implementations. |
| Modifier and Type | Class and Description |
|---|---|
class |
AbstractSimpleValidator
Base class for arbitrary value type validators.
|
class |
AbstractStringValidator
Base class for String value format validators.
|
| Modifier and Type | Method and Description |
|---|---|
Class<? extends Provider> |
ValidatorSPI.getProviderClass() |
| Modifier and Type | Class and Description |
|---|---|
class |
AbstractNumberValidator
Abstract class for number validator.
|
class |
DoubleValidator
Validate input being any kind of
Number. |
class |
EmailValidator
Email format validation - accepts plain string and collection of strings, for basic behavior like null/blank values
handling and collections support see
AbstractStringValidator. |
class |
IntegerValidator
|
class |
LengthValidator
String value length validation - accepts plain string and collection of strings, for basic behavior like null/blank
values handling and collections support see
AbstractStringValidator. |
class |
LocalDateValidator
A date validator that only takes into account the format associated with the current locale.
|
class |
NotBlankValidator
Validate that value exists and is not empty nor blank.
|
class |
NotEmptyValidator
Check that input value is not empty.
|
class |
PatternValidator
Validate String against configured RegEx pattern - accepts plain string and collection of strings, for basic behavior
like null/blank values handling and collections support see
AbstractStringValidator. |
class |
UriValidator
|
class |
ValidatorConfigValidator
Validate that input value is
ValidatorConfig and it is correct for validator (inputHint must be
ID of the validator config is for) by
Validators.validateConfig(org.keycloak.models.KeycloakSession, String, ValidatorConfig). |
| Modifier and Type | Interface and Description |
|---|---|
interface |
ClientValidationProvider |
interface |
Validator<T> |
| Modifier and Type | Class and Description |
|---|---|
class |
DefaultClientValidationProvider |
| Modifier and Type | Method and Description |
|---|---|
Class<? extends Provider> |
ClientValidationSPI.getProviderClass() |
| Modifier and Type | Interface and Description |
|---|---|
interface |
VaultProvider
Provider interface for a vault.
|
| Modifier and Type | Class and Description |
|---|---|
class |
AbstractVaultProvider
Abstract class that is meant to be extended by implementations of
VaultProvider that want to have support for
key resolvers. |
class |
FilesPlainTextVaultProvider
A text-based vault provider, which stores each secret in a separate file.
|
| Modifier and Type | Method and Description |
|---|---|
Class<? extends Provider> |
VaultSpi.getProviderClass() |
| Modifier and Type | Interface and Description |
|---|---|
interface |
WellKnownProvider |
| Modifier and Type | Method and Description |
|---|---|
Class<? extends Provider> |
WellKnownSpi.getProviderClass() |
Copyright © 2021 JBoss by Red Hat. All rights reserved.