Index

A C D E F G H I J L M N O P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

AbstractStorageManager<ProviderType extends Provider,StorageProviderModelType extends CacheableStorageProviderModel> - Class in org.keycloak.storage

AbstractStorageManager(KeycloakSession, Class<? extends ProviderFactory>, Class<ProviderType>, Function<ComponentModel, StorageProviderModelType>, String) - Constructor for class org.keycloak.storage.AbstractStorageManager

AbstractUserAdapter - Class in org.keycloak.storage.adapter

This abstract class provides implementations for everything but getUsername().

AbstractUserAdapter(KeycloakSession, RealmModel, ComponentModel) - Constructor for class org.keycloak.storage.adapter.AbstractUserAdapter

AbstractUserAdapter.Streams - Class in org.keycloak.storage.adapter

The AbstractUserAdapter.Streams interface makes all collection-based methods in AbstractUserAdapter default by providing implementations that delegate to the Stream-based variants instead of the other way around.

AbstractUserAdapterFederatedStorage - Class in org.keycloak.storage.adapter

Assumes everything is managed by federated storage except for username.

AbstractUserAdapterFederatedStorage(KeycloakSession, RealmModel, ComponentModel) - Constructor for class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

AbstractUserAdapterFederatedStorage.Streams - Class in org.keycloak.storage.adapter

Deprecated.

This interface is no longer necessary; collection-based methods were removed from the parent interface and therefore the parent interface can be used directly

addConsent(RealmModel, String, UserConsentModel) - Method in interface org.keycloak.storage.federated.UserConsentFederatedStorage

addFederatedIdentity(RealmModel, String, FederatedIdentityModel) - Method in interface org.keycloak.storage.federated.UserBrokerLinkFederatedStorage

addRequiredAction(String) - Method in class org.keycloak.storage.adapter.AbstractUserAdapter

addRequiredAction(String) - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

addRequiredAction(RealmModel, String, String) - Method in interface org.keycloak.storage.federated.UserRequiredActionsFederatedStorage

addRequiredAction(UserModel.RequiredAction) - Method in class org.keycloak.storage.adapter.AbstractUserAdapter

addRequiredAction(UserModel.RequiredAction) - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

appendDefaultGroups() - Method in class org.keycloak.storage.adapter.AbstractUserAdapter

Should the realm's default groups be appended to getGroups() call? If your storage provider is not managing group mappings then it is recommended that this method return true

appendDefaultGroups() - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

Should the realm's default groups be appended to getGroups() call? If your storage provider is not managing group mappings then it is recommended that this method return true

appendDefaultRolesToRoleMappings() - Method in class org.keycloak.storage.adapter.AbstractUserAdapter

Should the realm's default roles be appended to getRoleMappings() call? If your storage provider is not managing all role mappings then it is recommended that this method return true

appendDefaultRolesToRoleMappings() - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

Should the realm's default roles be appended to getRoleMappings() call? If your storage provider is not managing all role mappings then it is recommended that this method return true

C

CACHE_INVALID_BEFORE - Static variable in class org.keycloak.storage.CacheableStorageProviderModel

CACHE_POLICY - Static variable in class org.keycloak.storage.CacheableStorageProviderModel

CacheableStorageProviderModel - Class in org.keycloak.storage

CacheableStorageProviderModel() - Constructor for class org.keycloak.storage.CacheableStorageProviderModel

CacheableStorageProviderModel(ComponentModel) - Constructor for class org.keycloak.storage.CacheableStorageProviderModel

CacheableStorageProviderModel.CachePolicy - Enum in org.keycloak.storage

CachedObject - Interface in org.keycloak.models.cache

CachedUserModel - Interface in org.keycloak.models.cache

Cached users will implement this interface

CHANGED_SYNC_PERIOD - Static variable in class org.keycloak.storage.UserStorageProviderModel

clear() - Method in interface org.keycloak.models.cache.UserCache

Clear cache entirely.

clientScopeStorageManager() - Method in interface org.keycloak.storage.LegacyStoreManagers

clientStorageManager() - Method in interface org.keycloak.storage.LegacyStoreManagers

ClientStorageProvider - Interface in org.keycloak.storage.client

Base interface for components that want to provide an alternative storage mechanism for clients This is currently a private incomplete SPI.

ClientStorageProviderModel - Class in org.keycloak.storage.client

Stored configuration of a Client Storage provider instance.

ClientStorageProviderModel() - Constructor for class org.keycloak.storage.client.ClientStorageProviderModel

ClientStorageProviderModel(ComponentModel) - Constructor for class org.keycloak.storage.client.ClientStorageProviderModel

close() - Method in interface org.keycloak.storage.UserStorageProviderFactory

commonConfig() - Static method in class org.keycloak.storage.UserStorageProviderSpi

consumeEnabledStorageProvidersWithTimeout(RealmModel, Class<T>, Consumer<T>) - Method in class org.keycloak.storage.AbstractStorageManager

Gets all enabled StorageProviders that implements the capabilityInterface and call applyFunction on each !! Each StorageProvider has a limited time for consuming !!

consumeWithTimeBound(KeycloakSession, long, Consumer<T>) - Static method in class org.keycloak.utils.ServicesUtils

create(KeycloakSession, ComponentModel) - Method in interface org.keycloak.storage.UserStorageProviderFactory

called per Keycloak transaction.

createCredential(RealmModel, String, CredentialModel) - Method in interface org.keycloak.storage.federated.UserFederatedUserCredentialStore

createCredentialThroughProvider(CredentialModel) - Method in class org.keycloak.credential.LegacyUserCredentialManager

created - Variable in class org.keycloak.storage.adapter.AbstractUserAdapter

CREATED_TIMESTAMP_ATTRIBUTE - Static variable in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

createStoredCredential(CredentialModel) - Method in class org.keycloak.credential.LegacyUserCredentialManager

credentialManager() - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

D

dailyEvictionBoundary(int, int) - Static method in class org.keycloak.storage.CacheableStorageProviderModel

dailyTimeout(int, int) - Static method in class org.keycloak.storage.CacheableStorageProviderModel

DEFAULT - Enum constant in enum org.keycloak.storage.CacheableStorageProviderModel.CachePolicy

deleteRoleMapping(RealmModel, String, RoleModel) - Method in interface org.keycloak.storage.federated.UserRoleMappingsFederatedStorage

deleteRoleMapping(RoleModel) - Method in class org.keycloak.storage.adapter.AbstractUserAdapter

deleteRoleMapping(RoleModel) - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

disableCredentialType(String) - Method in class org.keycloak.credential.LegacyUserCredentialManager

E

EMAIL_ATTRIBUTE - Static variable in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

EMAIL_VERIFIED_ATTRIBUTE - Static variable in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

ENABLED - Static variable in class org.keycloak.storage.CacheableStorageProviderModel

ENABLED - Static variable in class org.keycloak.storage.client.ClientStorageProviderModel

ENABLED_ATTRIBUTE - Static variable in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

equals(Object) - Method in class org.keycloak.storage.adapter.AbstractUserAdapter

equals(Object) - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

evict(RealmModel) - Method in interface org.keycloak.models.cache.UserCache

Evict users of a specific realm

evict(RealmModel, UserModel) - Method in interface org.keycloak.models.cache.UserCache

Evict user from cache.

EVICT_DAILY - Enum constant in enum org.keycloak.storage.CacheableStorageProviderModel.CachePolicy

EVICT_WEEKLY - Enum constant in enum org.keycloak.storage.CacheableStorageProviderModel.CachePolicy

EVICTION_DAY - Static variable in class org.keycloak.storage.CacheableStorageProviderModel

EVICTION_HOUR - Static variable in class org.keycloak.storage.CacheableStorageProviderModel

EVICTION_MINUTE - Static variable in class org.keycloak.storage.CacheableStorageProviderModel

F

FIRST_NAME_ATTRIBUTE - Static variable in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

flatMapEnabledStorageProvidersWithTimeout(RealmModel, Class<T>, Function<T, ? extends Stream<R>>) - Method in class org.keycloak.storage.AbstractStorageManager

Gets all enabled StorageProviders that implements the capabilityInterface, applies applyFunction on each of them and then join the results together.

FULL_SYNC_PERIOD - Static variable in class org.keycloak.storage.UserStorageProviderModel

G

getAttribute(String) - Method in class org.keycloak.storage.adapter.AbstractUserAdapter

Deprecated.

Use AbstractUserAdapter.getAttributeStream(String) instead

getAttribute(String) - Method in class org.keycloak.storage.adapter.AbstractUserAdapter.Streams

getAttributes() - Method in class org.keycloak.storage.adapter.AbstractUserAdapter

getAttributes() - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

getAttributes(RealmModel, String) - Method in interface org.keycloak.storage.federated.UserAttributeFederatedStorage

getAttributeStream(String) - Method in class org.keycloak.storage.adapter.AbstractUserAdapter

getAttributeStream(String) - Method in class org.keycloak.storage.adapter.AbstractUserAdapter.Streams

getAttributeStream(String) - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

getCachedWith() - Method in interface org.keycloak.models.cache.CachedUserModel

Returns a map that contains custom things that are cached along with this model.

getCacheInvalidBefore() - Method in class org.keycloak.storage.CacheableStorageProviderModel

getCachePolicy() - Method in class org.keycloak.storage.CacheableStorageProviderModel

getCacheTimestamp() - Method in interface org.keycloak.models.cache.CachedObject

getCacheTimestamp() - Method in interface org.keycloak.models.cache.CachedUserModel

When was the model was loaded from database.

getChangedSyncPeriod() - Method in class org.keycloak.storage.UserStorageProviderModel

getClientRoleMappings(ClientModel) - Method in class org.keycloak.storage.adapter.AbstractUserAdapter

Deprecated.

Use AbstractUserAdapter.getClientRoleMappingsStream(ClientModel) instead

getClientRoleMappings(ClientModel) - Method in class org.keycloak.storage.adapter.AbstractUserAdapter.Streams

getClientRoleMappingsStream(ClientModel) - Method in class org.keycloak.storage.adapter.AbstractUserAdapter

getClientRoleMappingsStream(ClientModel) - Method in class org.keycloak.storage.adapter.AbstractUserAdapter.Streams

getClientRoleMappingsStream(ClientModel) - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

Gets role mappings from federated storage and automatically appends default roles.

getClientStorageProviders() - Method in interface org.keycloak.models.LegacyRealmModel

Deprecated.

Use getClientStorageProvidersStream instead.

getClientStorageProvidersStream() - Method in interface org.keycloak.models.LegacyRealmModel

Returns sorted ClientStorageProviderModel as a stream.

getCommonProviderConfigProperties() - Method in interface org.keycloak.storage.UserStorageProviderFactory

configuration properties that are common across all UserStorageProvider implementations

getConfigProperties() - Method in interface org.keycloak.storage.UserStorageProviderFactory

getConfiguredUserStorageCredentialTypesStream() - Method in class org.keycloak.credential.LegacyUserCredentialManager

getConsentByClient(RealmModel, String, String) - Method in interface org.keycloak.storage.federated.UserConsentFederatedStorage

getConsentsStream(RealmModel, String) - Method in interface org.keycloak.storage.federated.UserConsentFederatedStorage

Obtains the consents associated with the federated user identified by userId.

getCreatedTimestamp() - Method in class org.keycloak.storage.adapter.AbstractUserAdapter

getCreatedTimestamp() - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

getDelegateForUpdate() - Method in interface org.keycloak.models.cache.CachedUserModel

Invalidates the cache for this user and returns a delegate that represents the actual data provider

getDisableableCredentialTypesStream() - Method in class org.keycloak.credential.LegacyUserCredentialManager

getEmail() - Method in class org.keycloak.storage.adapter.AbstractUserAdapter

getEnabledStorageProviders(RealmModel, Class<T>) - Method in class org.keycloak.storage.AbstractStorageManager

Returns stream of all storageProviders within the realm that implements the capabilityInterface.

getEvictionDay() - Method in class org.keycloak.storage.CacheableStorageProviderModel

getEvictionHour() - Method in class org.keycloak.storage.CacheableStorageProviderModel

getEvictionMinute() - Method in class org.keycloak.storage.CacheableStorageProviderModel

getFederatedIdentitiesStream(String, RealmModel) - Method in interface org.keycloak.storage.federated.UserBrokerLinkFederatedStorage

Obtains the identities of the federated user identified by userId.

getFederatedIdentity(String, String, RealmModel) - Method in interface org.keycloak.storage.federated.UserBrokerLinkFederatedStorage

getFederatedRoleMappings() - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

Deprecated.

Use AbstractUserAdapterFederatedStorage.getFederatedRoleMappingsStream() instead

getFederatedRoleMappingsStream() - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

getFederatedStorage() - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

getFederationLink() - Method in class org.keycloak.storage.adapter.AbstractUserAdapter

This method should not be overriden

getFederationLink() - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

This method should not be overriden

getFirstAttribute(String) - Method in class org.keycloak.storage.adapter.AbstractUserAdapter

getFirstAttribute(String) - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

getFirstName() - Method in class org.keycloak.storage.adapter.AbstractUserAdapter

getFullSyncPeriod() - Method in class org.keycloak.storage.UserStorageProviderModel

getGroups() - Method in class org.keycloak.storage.adapter.AbstractUserAdapter

Deprecated.

Use AbstractUserAdapter.getGroupsStream() instead

getGroups() - Method in class org.keycloak.storage.adapter.AbstractUserAdapter.Streams

getGroupsInternal() - Method in class org.keycloak.storage.adapter.AbstractUserAdapter

Get group membership mappings that are managed by this storage provider

getGroupsInternal() - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

Get group membership mappings that are managed by this storage provider

getGroupsStream() - Method in class org.keycloak.storage.adapter.AbstractUserAdapter

getGroupsStream() - Method in class org.keycloak.storage.adapter.AbstractUserAdapter.Streams

getGroupsStream() - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

Gets groups from federated storage and automatically appends default groups of realm.

getGroupsStream(RealmModel, String) - Method in interface org.keycloak.storage.federated.UserGroupMembershipFederatedStorage

Obtains the groups associated with the federated user.

getHelpText() - Method in interface org.keycloak.storage.UserStorageProviderFactory

getId() - Method in class org.keycloak.storage.adapter.AbstractUserAdapter

Defaults to 'f:' + storageProvider.getId() + ':' + getUsername()

getId() - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

Defaults to 'f:' + storageProvider.getId() + ':' + getUsername()

getId() - Method in interface org.keycloak.storage.UserStorageProviderFactory

This is the name of the provider and will be showed in the admin console as an option.

getLastName() - Method in class org.keycloak.storage.adapter.AbstractUserAdapter

getLastSync() - Method in class org.keycloak.storage.UserStorageProviderModel

getLifespan() - Method in class org.keycloak.storage.CacheableStorageProviderModel

getMaxLifespan() - Method in class org.keycloak.storage.CacheableStorageProviderModel

getMembershipStream(RealmModel, GroupModel, Integer, Integer) - Method in interface org.keycloak.storage.federated.UserGroupMembershipFederatedStorage

Obtains the federated users that are members of the given group in the specified realm.

getName() - Method in class org.keycloak.storage.federated.UserFederatedStorageProviderSpi

getName() - Method in class org.keycloak.storage.UserStorageProviderSpi

getNotBeforeOfUser(RealmModel, String) - Method in interface org.keycloak.storage.federated.UserNotBeforeFederatedStorage

getProviderClass() - Method in class org.keycloak.storage.federated.UserFederatedStorageProviderSpi

getProviderClass() - Method in class org.keycloak.storage.UserStorageProviderSpi

getProviderFactoryClass() - Method in class org.keycloak.storage.federated.UserFederatedStorageProviderSpi

getProviderFactoryClass() - Method in class org.keycloak.storage.UserStorageProviderSpi

getRealmRoleMappings() - Method in class org.keycloak.storage.adapter.AbstractUserAdapter

Deprecated.

Use AbstractUserAdapter.getRealmRoleMappingsStream() instead

getRealmRoleMappings() - Method in class org.keycloak.storage.adapter.AbstractUserAdapter.Streams

getRealmRoleMappingsStream() - Method in class org.keycloak.storage.adapter.AbstractUserAdapter

getRealmRoleMappingsStream() - Method in class org.keycloak.storage.adapter.AbstractUserAdapter.Streams

getRealmRoleMappingsStream() - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

Gets role mappings from federated storage and automatically appends default roles.

getRequiredActions() - Method in class org.keycloak.storage.adapter.AbstractUserAdapter

Deprecated.

User AbstractUserAdapter.getRequiredActionsStream()

getRequiredActions() - Method in class org.keycloak.storage.adapter.AbstractUserAdapter.Streams

getRequiredActionsStream() - Method in class org.keycloak.storage.adapter.AbstractUserAdapter

getRequiredActionsStream() - Method in class org.keycloak.storage.adapter.AbstractUserAdapter.Streams

getRequiredActionsStream() - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

getRequiredActionsStream(RealmModel, String) - Method in interface org.keycloak.storage.federated.UserRequiredActionsFederatedStorage

Obtains the names of required actions associated with the federated user identified by userId.

getRoleMappings() - Method in class org.keycloak.storage.adapter.AbstractUserAdapter

Deprecated.

Use AbstractUserAdapter.getRoleMappingsStream() instead

getRoleMappings() - Method in class org.keycloak.storage.adapter.AbstractUserAdapter.Streams

getRoleMappingsInternal() - Method in class org.keycloak.storage.adapter.AbstractUserAdapter

getRoleMappingsInternal() - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

getRoleMappingsStream() - Method in class org.keycloak.storage.adapter.AbstractUserAdapter

getRoleMappingsStream() - Method in class org.keycloak.storage.adapter.AbstractUserAdapter.Streams

getRoleMappingsStream() - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

Gets role mappings from federated storage and automatically appends default roles.

getRoleMappingsStream(RealmModel, String) - Method in interface org.keycloak.storage.federated.UserRoleMappingsFederatedStorage

Obtains the roles associated with the federated user identified by userId.

getRoleMembersStream(RealmModel, RoleModel, Integer, Integer) - Method in interface org.keycloak.storage.federated.UserRoleMappingsFederatedStorage

Obtains the federated users that are members of the given role in the specified realm.

getRoleStorageProviders() - Method in interface org.keycloak.models.LegacyRealmModel

Deprecated.

Use getRoleStorageProvidersStream instead.

getRoleStorageProvidersStream() - Method in interface org.keycloak.models.LegacyRealmModel

Returns sorted RoleStorageProviderModel as a stream.

getServiceAccountClientLink() - Method in class org.keycloak.storage.adapter.AbstractUserAdapter

This method should not be overriden

getServiceAccountClientLink() - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

This method should not be overriden

getStorageProviderFactory(String) - Method in class org.keycloak.storage.AbstractStorageManager

Returns a factory with the providerId, which produce instances of type CreatedProviderType

getStorageProviderInstance(RealmModel, String, Class<T>) - Method in class org.keycloak.storage.AbstractStorageManager

getStorageProviderInstance(RealmModel, String, Class<T>, boolean) - Method in class org.keycloak.storage.AbstractStorageManager

Returns an instance of provider with the providerId within the realm or null if storage provider with providerId doesn't implement capabilityInterface.

getStorageProviderInstance(StorageProviderModelType, Class<T>) - Method in class org.keycloak.storage.AbstractStorageManager

Returns an instance of provider for the model or null if storage provider based on the model doesn't implement capabilityInterface.

getStorageProviderInstance(StorageProviderModelType, Class<T>, boolean) - Method in class org.keycloak.storage.AbstractStorageManager

Returns an instance of provider for the model or null if storage provider based on the model doesn't implement capabilityInterface.

getStorageProviderModel(RealmModel, String) - Method in class org.keycloak.storage.AbstractStorageManager

Returns an instance of StorageProvider model corresponding realm and providerId

getStorageProviderModels(RealmModel, Class<? extends Provider>) - Static method in class org.keycloak.storage.AbstractStorageManager

Stream of ComponentModels of storageType.

getStorageProviderTimeout() - Method in class org.keycloak.storage.AbstractStorageManager

getStoredCredentialById(String) - Method in class org.keycloak.credential.LegacyUserCredentialManager

getStoredCredentialById(RealmModel, String, String) - Method in interface org.keycloak.storage.federated.UserFederatedUserCredentialStore

getStoredCredentialByNameAndType(String, String) - Method in class org.keycloak.credential.LegacyUserCredentialManager

getStoredCredentialByNameAndType(RealmModel, String, String, String) - Method in interface org.keycloak.storage.federated.UserFederatedUserCredentialStore

getStoredCredentialsByTypeStream(String) - Method in class org.keycloak.credential.LegacyUserCredentialManager

getStoredCredentialsByTypeStream(RealmModel, String, String) - Method in interface org.keycloak.storage.federated.UserFederatedUserCredentialStore

Obtains the credentials of type type that are associated with the federated user identified by userId.

getStoredCredentialsStream() - Method in class org.keycloak.credential.LegacyUserCredentialManager

getStoredCredentialsStream(RealmModel, String) - Method in interface org.keycloak.storage.federated.UserFederatedUserCredentialStore

Obtains the credentials associated with the federated user identified by userId.

getStoredUsersCount(RealmModel) - Method in interface org.keycloak.storage.federated.UserFederatedStorageProvider

getStoredUsersStream(RealmModel, Integer, Integer) - Method in interface org.keycloak.storage.federated.UserFederatedStorageProvider

Obtains the ids of all federated users in the realm.

getTypeMetadata() - Method in interface org.keycloak.storage.UserStorageProviderFactory

getUserByFederatedIdentity(FederatedIdentityModel, RealmModel) - Method in interface org.keycloak.storage.federated.UserBrokerLinkFederatedStorage

getUsersByUserAttributeStream(RealmModel, String, String) - Method in interface org.keycloak.storage.federated.UserAttributeFederatedStorage

Searches for federated users that have an attribute with the specified name and value.

getUserStorageProviders() - Method in interface org.keycloak.models.LegacyRealmModel

Deprecated.

Use getUserStorageProvidersStream instead.

getUserStorageProvidersStream() - Method in interface org.keycloak.models.LegacyRealmModel

Returns sorted UserStorageProviderModel as a stream.

grantRole(RealmModel, String, RoleModel) - Method in interface org.keycloak.storage.federated.UserRoleMappingsFederatedStorage

grantRole(RoleModel) - Method in class org.keycloak.storage.adapter.AbstractUserAdapter

grantRole(RoleModel) - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

groupStorageManager() - Method in interface org.keycloak.storage.LegacyStoreManagers

GroupStorageProvider - Interface in org.keycloak.storage.group

GroupStorageProviderModel - Class in org.keycloak.storage.group

Stored configuration of a Group Storage provider instance.

GroupStorageProviderModel() - Constructor for class org.keycloak.storage.group.GroupStorageProviderModel

GroupStorageProviderModel(ComponentModel) - Constructor for class org.keycloak.storage.group.GroupStorageProviderModel

H

hashCode() - Method in class org.keycloak.storage.adapter.AbstractUserAdapter

hashCode() - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

hasRole(RoleModel) - Method in class org.keycloak.storage.adapter.AbstractUserAdapter

hasRole(RoleModel) - Method in class org.keycloak.storage.adapter.AbstractUserAdapter.Streams

hasRole(RoleModel) - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

I

IMPORT_ENABLED - Static variable in class org.keycloak.storage.UserStorageProviderModel

ImportedUserValidation - Interface in org.keycloak.storage.user

This is an optional capability interface that is intended to be implemented by any UserStorageProvider that supports validating users.

ImportSynchronization - Interface in org.keycloak.storage.user

This is an optional capability interface that is intended to be implemented by any UserStorageProvider that supports syncing users to keycloak local storage.

init(Config.Scope) - Method in interface org.keycloak.storage.UserStorageProviderFactory

invalidate() - Method in interface org.keycloak.models.cache.CachedUserModel

Invalidate the cache for this model

isConfiguredFor(String) - Method in class org.keycloak.credential.LegacyUserCredentialManager

isConfiguredLocally(String) - Method in class org.keycloak.credential.LegacyUserCredentialManager

isEmailVerified() - Method in class org.keycloak.storage.adapter.AbstractUserAdapter

isEmailVerified() - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

isEnabled() - Method in class org.keycloak.storage.adapter.AbstractUserAdapter

isEnabled() - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

isEnabled() - Method in class org.keycloak.storage.CacheableStorageProviderModel

isEnabled() - Method in class org.keycloak.storage.client.ClientStorageProviderModel

isEnabled() - Method in class org.keycloak.storage.group.GroupStorageProviderModel

isEnabled() - Method in class org.keycloak.storage.role.RoleStorageProviderModel

isImportEnabled() - Method in class org.keycloak.storage.UserStorageProviderModel

isInternal() - Method in class org.keycloak.storage.federated.UserFederatedStorageProviderSpi

isInternal() - Method in class org.keycloak.storage.UserStorageProviderSpi

isMarkedForEviction() - Method in interface org.keycloak.models.cache.CachedUserModel

isMemberOf(GroupModel) - Method in class org.keycloak.storage.adapter.AbstractUserAdapter

isMemberOf(GroupModel) - Method in class org.keycloak.storage.adapter.AbstractUserAdapter.Streams

isMemberOf(GroupModel) - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

isValid(List<CredentialInput>) - Method in class org.keycloak.credential.LegacyUserCredentialManager

J

joinGroup(GroupModel) - Method in class org.keycloak.storage.adapter.AbstractUserAdapter

joinGroup(GroupModel) - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

joinGroup(RealmModel, String, GroupModel) - Method in interface org.keycloak.storage.federated.UserGroupMembershipFederatedStorage

L

LAST_NAME_ATTRIBUTE - Static variable in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

LAST_SYNC - Static variable in class org.keycloak.storage.UserStorageProviderModel

leaveGroup(GroupModel) - Method in class org.keycloak.storage.adapter.AbstractUserAdapter

leaveGroup(GroupModel) - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

leaveGroup(RealmModel, String, GroupModel) - Method in interface org.keycloak.storage.federated.UserGroupMembershipFederatedStorage

LegacyRealmModel - Interface in org.keycloak.models

LegacyStoreManagers - Interface in org.keycloak.storage

LegacyUserCredentialManager - Class in org.keycloak.credential

Handling credentials for a given user for the legacy store.

LegacyUserCredentialManager(KeycloakSession, RealmModel, UserModel) - Constructor for class org.keycloak.credential.LegacyUserCredentialManager

M

mapAttribute(String) - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

mapEnabledStorageProvidersWithTimeout(RealmModel, Class<T>, Function<T, R>) - Method in class org.keycloak.storage.AbstractStorageManager

Gets all enabled StorageProviders that implements the capabilityInterface, applies applyFunction on each of them and returns the stream.

MAX_LIFESPAN - Enum constant in enum org.keycloak.storage.CacheableStorageProviderModel.CachePolicy

MAX_LIFESPAN - Static variable in class org.keycloak.storage.CacheableStorageProviderModel

moveStoredCredentialTo(String, String) - Method in class org.keycloak.credential.LegacyUserCredentialManager

N

NO_CACHE - Enum constant in enum org.keycloak.storage.CacheableStorageProviderModel.CachePolicy

O

onCache(RealmModel, CachedUserModel, UserModel) - Method in interface org.keycloak.models.cache.OnUserCache

onCreate(KeycloakSession, RealmModel, ComponentModel) - Method in interface org.keycloak.storage.UserStorageProviderFactory

Called when UserStorageProviderModel is created.

OnUserCache - Interface in org.keycloak.models.cache

org.keycloak.credential - package org.keycloak.credential

org.keycloak.models - package org.keycloak.models

org.keycloak.models.cache - package org.keycloak.models.cache

org.keycloak.storage - package org.keycloak.storage

org.keycloak.storage.adapter - package org.keycloak.storage.adapter

org.keycloak.storage.client - package org.keycloak.storage.client

org.keycloak.storage.federated - package org.keycloak.storage.federated

org.keycloak.storage.group - package org.keycloak.storage.group

org.keycloak.storage.role - package org.keycloak.storage.role

org.keycloak.storage.user - package org.keycloak.storage.user

org.keycloak.utils - package org.keycloak.utils

P

postInit(KeycloakSessionFactory) - Method in interface org.keycloak.storage.UserStorageProviderFactory

preRemove(ClientScopeModel) - Method in interface org.keycloak.storage.federated.UserFederatedStorageProvider

preRemove(ProtocolMapperModel) - Method in interface org.keycloak.storage.federated.UserFederatedStorageProvider

preRemove(RealmModel) - Method in interface org.keycloak.storage.client.ClientStorageProvider

Callback when a realm is removed.

preRemove(RealmModel) - Method in interface org.keycloak.storage.federated.UserFederatedStorageProvider

preRemove(RealmModel) - Method in interface org.keycloak.storage.UserStorageProvider

Callback when a realm is removed.

preRemove(RealmModel, ComponentModel) - Method in interface org.keycloak.storage.federated.UserFederatedStorageProvider

preRemove(RealmModel, ClientModel) - Method in interface org.keycloak.storage.federated.UserFederatedStorageProvider

preRemove(RealmModel, GroupModel) - Method in interface org.keycloak.storage.client.ClientStorageProvider

Callback when a group is removed.

preRemove(RealmModel, GroupModel) - Method in interface org.keycloak.storage.federated.UserFederatedStorageProvider

preRemove(RealmModel, GroupModel) - Method in interface org.keycloak.storage.UserStorageProvider

Callback when a group is removed.

preRemove(RealmModel, IdentityProviderModel) - Method in interface org.keycloak.storage.federated.UserBrokerLinkFederatedStorage

preRemove(RealmModel, RoleModel) - Method in interface org.keycloak.storage.client.ClientStorageProvider

Callback when a role is removed.

preRemove(RealmModel, RoleModel) - Method in interface org.keycloak.storage.federated.UserFederatedStorageProvider

preRemove(RealmModel, RoleModel) - Method in interface org.keycloak.storage.UserStorageProvider

Callback when a role is removed.

preRemove(RealmModel, UserModel) - Method in interface org.keycloak.storage.federated.UserFederatedStorageProvider

R

READ_ONLY - Enum constant in enum org.keycloak.storage.UserStorageProvider.EditMode

user storage is read-only

realm - Variable in class org.keycloak.storage.adapter.AbstractUserAdapter

realm - Variable in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

removeAttribute(String) - Method in class org.keycloak.storage.adapter.AbstractUserAdapter

removeAttribute(String) - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

removeAttribute(RealmModel, String, String) - Method in interface org.keycloak.storage.federated.UserAttributeFederatedStorage

removeFederatedIdentity(RealmModel, String, String) - Method in interface org.keycloak.storage.federated.UserBrokerLinkFederatedStorage

removeRequiredAction(String) - Method in class org.keycloak.storage.adapter.AbstractUserAdapter

removeRequiredAction(String) - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

removeRequiredAction(RealmModel, String, String) - Method in interface org.keycloak.storage.federated.UserRequiredActionsFederatedStorage

removeRequiredAction(UserModel.RequiredAction) - Method in class org.keycloak.storage.adapter.AbstractUserAdapter

removeRequiredAction(UserModel.RequiredAction) - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

removeStoredCredential(RealmModel, String, String) - Method in interface org.keycloak.storage.federated.UserFederatedUserCredentialStore

removeStoredCredentialById(String) - Method in class org.keycloak.credential.LegacyUserCredentialManager

revokeConsentForClient(RealmModel, String, String) - Method in interface org.keycloak.storage.federated.UserConsentFederatedStorage

roleStorageManager() - Method in interface org.keycloak.storage.LegacyStoreManagers

RoleStorageProviderModel - Class in org.keycloak.storage.role

Stored configuration of a Role Storage provider instance.

RoleStorageProviderModel() - Constructor for class org.keycloak.storage.role.RoleStorageProviderModel

RoleStorageProviderModel(ComponentModel) - Constructor for class org.keycloak.storage.role.RoleStorageProviderModel

S

ServicesUtils - Class in org.keycloak.utils

Utility class for general helper methods used across the keycloak-services.

ServicesUtils() - Constructor for class org.keycloak.utils.ServicesUtils

session - Variable in class org.keycloak.storage.AbstractStorageManager

session - Variable in class org.keycloak.storage.adapter.AbstractUserAdapter

session - Variable in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

setAttribute(String, List<String>) - Method in class org.keycloak.storage.adapter.AbstractUserAdapter

setAttribute(String, List<String>) - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

setAttribute(RealmModel, String, String, List<String>) - Method in interface org.keycloak.storage.federated.UserAttributeFederatedStorage

setCacheInvalidBefore(long) - Method in class org.keycloak.storage.CacheableStorageProviderModel

setCachePolicy(CacheableStorageProviderModel.CachePolicy) - Method in class org.keycloak.storage.CacheableStorageProviderModel

setChangedSyncPeriod(int) - Method in class org.keycloak.storage.UserStorageProviderModel

setCreatedTimestamp(Long) - Method in class org.keycloak.storage.adapter.AbstractUserAdapter

setCreatedTimestamp(Long) - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

setEmail(String) - Method in class org.keycloak.storage.adapter.AbstractUserAdapter

setEmailVerified(boolean) - Method in class org.keycloak.storage.adapter.AbstractUserAdapter

setEmailVerified(boolean) - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

Stores as attribute in federated storage.

setEnabled(boolean) - Method in class org.keycloak.storage.adapter.AbstractUserAdapter

setEnabled(boolean) - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

setEnabled(boolean) - Method in class org.keycloak.storage.CacheableStorageProviderModel

setEnabled(boolean) - Method in class org.keycloak.storage.client.ClientStorageProviderModel

setEnabled(boolean) - Method in class org.keycloak.storage.group.GroupStorageProviderModel

setEnabled(boolean) - Method in class org.keycloak.storage.role.RoleStorageProviderModel

setEvictionDay(int) - Method in class org.keycloak.storage.CacheableStorageProviderModel

setEvictionHour(int) - Method in class org.keycloak.storage.CacheableStorageProviderModel

setEvictionMinute(int) - Method in class org.keycloak.storage.CacheableStorageProviderModel

setFederationLink(String) - Method in class org.keycloak.storage.adapter.AbstractUserAdapter

This method should not be overriden

setFederationLink(String) - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

This method should not be overriden

setFirstName(String) - Method in class org.keycloak.storage.adapter.AbstractUserAdapter

setFullSyncPeriod(int) - Method in class org.keycloak.storage.UserStorageProviderModel

setImportEnabled(boolean) - Method in class org.keycloak.storage.UserStorageProviderModel

setLastName(String) - Method in class org.keycloak.storage.adapter.AbstractUserAdapter

setLastSync(int) - Method in class org.keycloak.storage.UserStorageProviderModel

setMaxLifespan(long) - Method in class org.keycloak.storage.CacheableStorageProviderModel

setNotBeforeForUser(RealmModel, String, int) - Method in interface org.keycloak.storage.federated.UserNotBeforeFederatedStorage

setServiceAccountClientLink(String) - Method in class org.keycloak.storage.adapter.AbstractUserAdapter

This method should not be overriden

setServiceAccountClientLink(String) - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

This method should not be overriden

setSingleAttribute(String, String) - Method in class org.keycloak.storage.adapter.AbstractUserAdapter

setSingleAttribute(String, String) - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

setSingleAttribute(RealmModel, String, String, String) - Method in interface org.keycloak.storage.federated.UserAttributeFederatedStorage

setUsername(String) - Method in class org.keycloak.storage.adapter.AbstractUserAdapter

shouldInvalidate(CachedObject) - Method in class org.keycloak.storage.CacheableStorageProviderModel

storageId - Variable in class org.keycloak.storage.adapter.AbstractUserAdapter

storageId - Variable in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

storageProviderModel - Variable in class org.keycloak.storage.adapter.AbstractUserAdapter

storageProviderModel - Variable in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

Streams(KeycloakSession, RealmModel, ComponentModel) - Constructor for class org.keycloak.storage.adapter.AbstractUserAdapter.Streams

Streams(KeycloakSession, RealmModel, ComponentModel) - Constructor for class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage.Streams

Deprecated.

sync(KeycloakSessionFactory, String, UserStorageProviderModel) - Method in interface org.keycloak.storage.user.ImportSynchronization

syncSince(Date, KeycloakSessionFactory, String, UserStorageProviderModel) - Method in interface org.keycloak.storage.user.ImportSynchronization

T

timeBound(KeycloakSession, long, Function<T, ? extends Stream<R>>) - Static method in class org.keycloak.utils.ServicesUtils

timeBoundOne(KeycloakSession, long, Function<T, R>) - Static method in class org.keycloak.utils.ServicesUtils

U

UNSYNCED - Enum constant in enum org.keycloak.storage.UserStorageProvider.EditMode

updates to user are stored locally and not synced with user storage.

updateConsent(RealmModel, String, UserConsentModel) - Method in interface org.keycloak.storage.federated.UserConsentFederatedStorage

updateCredential(CredentialInput) - Method in class org.keycloak.credential.LegacyUserCredentialManager

updateCredential(RealmModel, String, CredentialModel) - Method in interface org.keycloak.storage.federated.UserFederatedUserCredentialStore

updateCredentialLabel(String, String) - Method in class org.keycloak.credential.LegacyUserCredentialManager

updateFederatedIdentity(RealmModel, String, FederatedIdentityModel) - Method in interface org.keycloak.storage.federated.UserBrokerLinkFederatedStorage

updateStoredCredential(CredentialModel) - Method in class org.keycloak.credential.LegacyUserCredentialManager

UserAttributeFederatedStorage - Interface in org.keycloak.storage.federated

UserAttributeFederatedStorage.Streams - Interface in org.keycloak.storage.federated

Deprecated.

This interface is no longer necessary; collection-based methods were removed from the parent interface and therefore the parent interface can be used directly

UserBrokerLinkFederatedStorage - Interface in org.keycloak.storage.federated

UserBrokerLinkFederatedStorage.Streams - Interface in org.keycloak.storage.federated

Deprecated.

This interface is no longer necessary; collection-based methods were removed from the parent interface and therefore the parent interface can be used directly

userCache(KeycloakSession) - Static method in class org.keycloak.storage.UserStorageUtil

UserCache - Interface in org.keycloak.models.cache

All these methods effect an entire cluster of Keycloak instances.

UserConsentFederatedStorage - Interface in org.keycloak.storage.federated

UserConsentFederatedStorage.Streams - Interface in org.keycloak.storage.federated

Deprecated.

This interface is no longer necessary, collection-based methods were removed from the parent interface and therefore the parent interface can be used directly

userFederatedStorage() - Method in interface org.keycloak.storage.LegacyStoreManagers

userFederatedStorage(KeycloakSession) - Static method in class org.keycloak.storage.UserStorageUtil

UserFederatedStorageProvider - Interface in org.keycloak.storage.federated

UserFederatedStorageProvider.Streams - Interface in org.keycloak.storage.federated

Deprecated.

This interface is no longer necessary; collection-based methods were removed from the parent interface and therefore the parent interface can be used directly

UserFederatedStorageProviderFactory - Interface in org.keycloak.storage.federated

UserFederatedStorageProviderSpi - Class in org.keycloak.storage.federated

UserFederatedStorageProviderSpi() - Constructor for class org.keycloak.storage.federated.UserFederatedStorageProviderSpi

UserFederatedUserCredentialStore - Interface in org.keycloak.storage.federated

UserFederatedUserCredentialStore.Streams - Interface in org.keycloak.storage.federated

Deprecated.

This interface is no longer necessary; collection-based methods were removed from the parent interface and therefore the parent interface can be used directly

UserGroupMembershipFederatedStorage - Interface in org.keycloak.storage.federated

UserGroupMembershipFederatedStorage.Streams - Interface in org.keycloak.storage.federated

Deprecated.

This interface is no longer necessary; collection-based methods were removed from the parent interface and therefore the parent interface can be used directly

userLocalStorage() - Method in interface org.keycloak.storage.LegacyStoreManagers

UserNotBeforeFederatedStorage - Interface in org.keycloak.storage.federated

UserRequiredActionsFederatedStorage - Interface in org.keycloak.storage.federated

UserRequiredActionsFederatedStorage.Streams - Interface in org.keycloak.storage.federated

Deprecated.

This interface is no longer necessary; collection-based methods were removed from the parent interface and therefore the parent interface can be used directly

UserRoleMappingsFederatedStorage - Interface in org.keycloak.storage.federated

UserRoleMappingsFederatedStorage.Streams - Interface in org.keycloak.storage.federated

Deprecated.

This interface is no longer necessary; collection-based methods were removed from the parent interface and therefore the parent interface can be used directly

userStorageManager() - Method in interface org.keycloak.storage.LegacyStoreManagers

UserStorageProvider - Interface in org.keycloak.storage

A class implementing this interface represents a user storage provider to Keycloak.

UserStorageProvider.EditMode - Enum in org.keycloak.storage

Optional type that can be used by implementations to describe edit mode of user storage

UserStorageProviderFactory<T extends UserStorageProvider> - Interface in org.keycloak.storage

UserStorageProviderModel - Class in org.keycloak.storage

Stored configuration of a User Storage provider instance.

UserStorageProviderModel() - Constructor for class org.keycloak.storage.UserStorageProviderModel

UserStorageProviderModel(ComponentModel) - Constructor for class org.keycloak.storage.UserStorageProviderModel

UserStorageProviderSpi - Class in org.keycloak.storage

UserStorageProviderSpi() - Constructor for class org.keycloak.storage.UserStorageProviderSpi

UserStorageUtil - Class in org.keycloak.storage

UserStorageUtil() - Constructor for class org.keycloak.storage.UserStorageUtil

V

validate(RealmModel, UserModel) - Method in interface org.keycloak.storage.user.ImportedUserValidation

If this method returns null, then the user in local storage will be removed

validateConfiguration(KeycloakSession, RealmModel, ComponentModel) - Method in interface org.keycloak.storage.UserStorageProviderFactory

valueOf(String) - Static method in enum org.keycloak.storage.CacheableStorageProviderModel.CachePolicy

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.keycloak.storage.UserStorageProvider.EditMode

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.keycloak.storage.CacheableStorageProviderModel.CachePolicy

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.keycloak.storage.UserStorageProvider.EditMode

Returns an array containing the constants of this enum type, in the order they are declared.

W

weeklyTimeout(int, int, int) - Static method in class org.keycloak.storage.CacheableStorageProviderModel

WRITABLE - Enum constant in enum org.keycloak.storage.UserStorageProvider.EditMode

user storage is writable

A C D E F G H I J L M N O P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form