Deprecated API

Contents

• Interfaces
• Classes
• Fields
• Methods

Interfaces

Interface	Description
org.keycloak.credential.CredentialInputUpdater.Streams	This interface is no longer necessary, collection-based methods were removed from the parent interface and therefore the parent interface can be used directly
org.keycloak.credential.UserCredentialStore.Streams	This interface is no longer necessary, collection-based methods were removed from the parent interface and therefore the parent interface can be used directly
org.keycloak.models.GroupModel.Streams	This interface is no longer necessary, collection-based methods were removed from the parent interface and therefore the parent interface can be used directly
org.keycloak.models.RoleMapperModel.Streams	This interface is no longer necessary, collection-based methods were removed from the parent interface and therefore the parent interface can be used directly
org.keycloak.models.UserCredentialManager	Instead of this class, use UserModel.credentialManager() instead.
org.keycloak.models.UserCredentialManager.Streams	This interface is no longer necessary, collection-based methods were removed from the parent interface and therefore the parent interface can be used directly
org.keycloak.models.UserModel.Streams	This interface is no longer necessary, collection-based methods were removed from the parent interface and therefore the parent interface can be used directly
org.keycloak.models.UserProvider.Streams	This interface is no longer necessary, collection-based methods were removed from the parent interface and therefore the parent interface can be used directly
org.keycloak.storage.user.UserLookupProvider.Streams	This interface is no longer necessary, collection-based methods were removed from the parent interface and therefore the parent interface can be used directly
org.keycloak.storage.user.UserQueryProvider.Streams	This interface is no longer necessary, collection-based methods were removed from the parent interface and therefore the parent interface can be used directly

Classes

Class	Description
org.keycloak.models.credential.PasswordUserCredentialModel	Recommended to use UserCredentialModel as it contains all the functionality required by this class

Fields

Field	Description
org.keycloak.credential.CredentialModel.HOTP
org.keycloak.credential.CredentialModel.OTP
org.keycloak.credential.CredentialModel.PASSWORD
org.keycloak.credential.CredentialModel.PASSWORD_HISTORY
org.keycloak.credential.CredentialModel.PASSWORD_TOKEN
org.keycloak.credential.CredentialModel.TOTP
org.keycloak.models.RoleModel.SearchableFields.IS_CLIENT_ROLE	Please use RoleModel.SearchableFields.CLIENT_ID SearchableField with operators EXISTS/NOT_EXISTS to replace field IS_CLIENT_ROLE with operator EQ with value true/false.
org.keycloak.models.UserCredentialModel.HOTP
org.keycloak.models.UserCredentialModel.PASSWORD
org.keycloak.models.UserCredentialModel.PASSWORD_HISTORY
org.keycloak.models.UserCredentialModel.PASSWORD_TOKEN
org.keycloak.models.UserCredentialModel.TOTP

Methods

Method	Description
org.keycloak.credential.CredentialModel.getAlgorithm()	Recommended to use PasswordCredentialModel.getPasswordCredentialData().getAlgorithm() or OTPCredentialModel.getOTPCredentialData().getAlgorithm()
org.keycloak.credential.CredentialModel.getConfig()	Recommended to use CredentialModel.getCredentialData() instead and use the subtype of CredentialData specific to your credential
org.keycloak.credential.CredentialModel.getCounter()	Recommended to use OTPCredentialModel.getOTPCredentialData().getCounter()
org.keycloak.credential.CredentialModel.getDevice()	Recommended to use OTPCredentialModel.getOTPCredentialData().getDevice()
org.keycloak.credential.CredentialModel.getDigits()	Recommended to use OTPCredentialModel.getOTPCredentialData().getDigits()
org.keycloak.credential.CredentialModel.getHashIterations()	Recommended to use PasswordCredentialModel.getPasswordCredentialData().getHashIterations()
org.keycloak.credential.CredentialModel.getPeriod()	Recommended to use OTPCredentialModel.getOTPCredentialData().getPeriod()
org.keycloak.credential.CredentialModel.getSalt()	Recommended to use PasswordCredentialModel.getPasswordSecretData().getSalt()
org.keycloak.credential.CredentialModel.getValue()	Recommended to use PasswordCredentialModel.getPasswordSecretData().getValue() or OTPCredentialModel.getOTPSecretData().getValue()
org.keycloak.credential.CredentialModel.setAlgorithm(String)	See CredentialModel.getAlgorithm()
org.keycloak.credential.CredentialModel.setConfig(MultivaluedHashMap<String, String>)	Recommended to use CredentialModel.setCredentialData(String) instead and use the subtype of CredentialData specific to your credential
org.keycloak.credential.CredentialModel.setCounter(int)	See CredentialModel.getCounter()
org.keycloak.credential.CredentialModel.setDevice(String)	See CredentialModel.getDevice()
org.keycloak.credential.CredentialModel.setDigits(int)	See CredentialModel.setDigits(int)
org.keycloak.credential.CredentialModel.setHashIterations(int)	See CredentialModel.getHashIterations()
org.keycloak.credential.CredentialModel.setPeriod(int)	See CredentialModel.setPeriod(int)
org.keycloak.credential.CredentialModel.setSalt(byte[])	See CredentialModel.getSalt()
org.keycloak.credential.CredentialModel.setValue(String)	See CredentialModel.getValue()
org.keycloak.credential.hash.PasswordHashProvider.encode(String, int, CredentialModel)	Exists due the backwards compatibility. It is recommended to use encodedCredential(String, int)}
org.keycloak.credential.hash.PasswordHashProvider.policyCheck(PasswordPolicy, CredentialModel)	Exists due the backwards compatibility. It is recommended to use policyCheck(PasswordPolicy, PasswordCredentialModel)
org.keycloak.credential.hash.PasswordHashProvider.verify(String, CredentialModel)	Exists due the backwards compatibility. It is recommended to use verify(String, PasswordCredentialModel)
org.keycloak.migration.MigrationModel.getResourcesTag()
org.keycloak.models.ClientModel.updateClient()	Do not use, to be removed
org.keycloak.models.ClientProvider.getAllRedirectUrisOfEnabledClients(RealmModel)	Do not use, this is only to support a deprecated logout endpoint and will vanish with it's removal
org.keycloak.models.IdentityProviderModel.isAuthenticateByDefault()
org.keycloak.models.IdentityProviderModel.setAuthenticateByDefault(boolean)
org.keycloak.models.KeycloakSession.clientLocalStorage()	Access to the legacy store is no longer possible via this method. Adjust your code according to the Keycloak 19 Upgrading Guide.
org.keycloak.models.KeycloakSession.clientScopeLocalStorage()	Access to the legacy store is no longer possible via this method. Adjust your code according to the Keycloak 19 Upgrading Guide.
org.keycloak.models.KeycloakSession.clientScopeStorageManager()	Use KeycloakSession.clientScopes() instead
org.keycloak.models.KeycloakSession.clientStorageManager()
org.keycloak.models.KeycloakSession.getProvider(Class<T>, ComponentModel)	Deprecated in favor of {@link #getComponentProvider)
org.keycloak.models.KeycloakSession.groupLocalStorage()	Access to the legacy store is no longer possible via this method. Adjust your code according to the Keycloak 19 Upgrading Guide.
org.keycloak.models.KeycloakSession.groupStorageManager()
org.keycloak.models.KeycloakSession.realmLocalStorage()
org.keycloak.models.KeycloakSession.roleLocalStorage()	Access to the legacy store is no longer possible via this method. Adjust your code according to the Keycloak 19 Upgrading Guide.
org.keycloak.models.KeycloakSession.roleStorageManager()
org.keycloak.models.KeycloakSession.userCache()	The access to the UserCache interface is no longer possible here, and this method is about to be removed. Adjust your code according to the Keycloak 19 Upgrading Guide.
org.keycloak.models.KeycloakSession.userCredentialManager()	Use UserModel.credentialManager() instead.
org.keycloak.models.KeycloakSession.userLocalStorage()
org.keycloak.models.KeycloakSession.userStorageManager()
org.keycloak.models.KeyManager.getActiveAesKey(RealmModel)
org.keycloak.models.KeyManager.getActiveHmacKey(RealmModel)
org.keycloak.models.KeyManager.getActiveRsaKey(RealmModel)
org.keycloak.models.KeyManager.getAesKeys(RealmModel)
org.keycloak.models.KeyManager.getAesSecretKey(RealmModel, String)
org.keycloak.models.KeyManager.getHmacKeys(RealmModel)
org.keycloak.models.KeyManager.getHmacSecretKey(RealmModel, String)
org.keycloak.models.KeyManager.getRsaCertificate(RealmModel, String)
org.keycloak.models.KeyManager.getRsaKeys(RealmModel)
org.keycloak.models.KeyManager.getRsaPublicKey(RealmModel, String)
org.keycloak.models.RealmModel.searchForGroupByNameStream(String, Integer, Integer)	Use GroupLookupProvider.searchForGroupByNameStream(RealmModel, String, Boolean, Integer, Integer) instead.
org.keycloak.models.RealmProvider.addClient(RealmModel, String, String)	Use the corresponding method from ClientProvider.
org.keycloak.models.RealmProvider.addClientRole(RealmModel, ClientModel, String)	Use the corresponding method from RoleProvider.
org.keycloak.models.RealmProvider.addRealmRole(RealmModel, String)	Use the corresponding method from RoleProvider.
org.keycloak.models.RealmProvider.addTopLevelGroup(RealmModel, GroupModel)	Use the corresponding method from GroupProvider.
org.keycloak.models.RealmProvider.createGroup(RealmModel, String)	Use the corresponding method from GroupProvider.
org.keycloak.models.RealmProvider.getClientRole(RealmModel, ClientModel, String)	Use the corresponding method from RoleProvider.
org.keycloak.models.RealmProvider.getClientRoles(RealmModel, ClientModel)	Use the corresponding method from RoleProvider.
org.keycloak.models.RealmProvider.getClientScopeById(String, RealmModel)	Use the corresponding method from ClientScopeProvider.
org.keycloak.models.RealmProvider.getClientsCount(RealmModel)	Use the corresponding method from ClientProvider.
org.keycloak.models.RealmProvider.getGroupById(RealmModel, String)	Use the corresponding method from GroupProvider.
org.keycloak.models.RealmProvider.getGroupsCount(RealmModel, Boolean)	Use the corresponding method from GroupProvider.
org.keycloak.models.RealmProvider.getGroupsCountByNameContaining(RealmModel, String)	Use the corresponding method from GroupProvider.
org.keycloak.models.RealmProvider.getRealmRole(RealmModel, String)	Use the corresponding method from RoleProvider.
org.keycloak.models.RealmProvider.getRealmRoles(RealmModel, Integer, Integer)	Use the corresponding method from RoleProvider.
org.keycloak.models.RealmProvider.getRoleById(String, RealmModel)	Use the corresponding method from RoleProvider.
org.keycloak.models.RealmProvider.moveGroup(RealmModel, GroupModel, GroupModel)	Use the corresponding method from GroupProvider.
org.keycloak.models.RealmProvider.removeGroup(RealmModel, GroupModel)	Use the corresponding method from GroupProvider.
org.keycloak.models.RealmProvider.removeRole(RealmModel, RoleModel)	Use the corresponding method from RoleProvider.
org.keycloak.models.RealmProvider.searchForClientRoles(RealmModel, ClientModel, String, Integer, Integer)	Use the corresponding method from RoleProvider.
org.keycloak.models.RealmProvider.searchForRoles(RealmModel, String, Integer, Integer)	Use the corresponding method from RoleProvider.
org.keycloak.models.RoleContainerModel.addDefaultRole(String)	Default roles are now managed by RealmModel.getDefaultRole(). This method will be removed.
org.keycloak.models.RoleContainerModel.getDefaultRoles()	Default roles are now managed by RealmModel.getDefaultRole(). This method will be removed.
org.keycloak.models.RoleContainerModel.getDefaultRolesStream()	Default roles are now managed by RealmModel.getDefaultRole(). This method will be removed.
org.keycloak.models.RoleContainerModel.removeDefaultRoles(String...)	Default roles are now managed by RealmModel.getDefaultRole(). This method will be removed.
org.keycloak.models.RoleContainerModel.updateDefaultRoles(String...)	Default roles are now managed by RealmModel.getDefaultRole(). This method will be removed.
org.keycloak.models.SubjectCredentialManager.createCredentialThroughProvider(CredentialModel)
org.keycloak.models.SubjectCredentialManager.getConfiguredUserStorageCredentialTypesStream()
org.keycloak.models.SubjectCredentialManager.isConfiguredLocally(String)
org.keycloak.models.UserCredentialManager.getConfiguredUserStorageCredentialTypesStream(RealmModel, UserModel)	Use UserModel.credentialManager() and then call SubjectCredentialManager.getConfiguredUserStorageCredentialTypesStream()
org.keycloak.models.UserCredentialManager.getDisableableCredentialTypesStream(RealmModel, UserModel)	Use UserModel.credentialManager() and then call SubjectCredentialManager.getDisableableCredentialTypesStream()
org.keycloak.models.UserCredentialModel.isOtp(String)
org.keycloak.models.UserCredentialModel.passwordToken(String)
org.keycloak.models.UserProvider.getUsersStream(RealmModel, boolean)	Use UserQueryProvider.searchForUserStream(RealmModel, Map) with UserModel.INCLUDE_SERVICE_ACCOUNT within params instead.
org.keycloak.models.UserSessionProvider.getClientSession(UserSessionModel, ClientModel, UUID, boolean)	Use UserSessionProvider.getClientSession(UserSessionModel, ClientModel, String, boolean) instead.
org.keycloak.sessions.AuthenticationSessionProvider.removeAllExpired()	manual removal of expired entities should not be used anymore. It is responsibility of the store implementation to handle expirable entities
org.keycloak.sessions.AuthenticationSessionProvider.removeExpired(RealmModel)	manual removal of expired entities should not be used anymore. It is responsibility of the store implementation to handle expirable entities
org.keycloak.storage.group.GroupLookupProvider.searchForGroupByNameStream(RealmModel, String, Integer, Integer)	Use GroupLookupProvider.searchForGroupByNameStream(RealmModel, String, Boolean, Integer, Integer) instead.
org.keycloak.storage.StorageId.isLocalStorage(UserModel)	Use StorageId.isLocalStorage(String) instead.
org.keycloak.storage.StorageId.resolveProviderId(UserModel)	Use StorageId.providerId(String) instead.
org.keycloak.storage.user.UserQueryProvider.getUsersStream(RealmModel)	Use UserQueryProvider.searchForUserStream(RealmModel, Map) with an empty params map instead.