Deprecated API

Contents

• Terminally Deprecated
• Classes
• Fields
• Methods
• Constructors
• Enum Constants

Terminally Deprecated Elements

Element	Description
org.keycloak.models.KeycloakContext.getContextObject(Class<T>)
org.keycloak.models.UserSessionProvider.importUserSessions(Collection<UserSessionModel>, boolean)	Deprecated as offline session preloading was removed in KC25. This method will be removed in KC27.
org.keycloak.organization.OrganizationProvider.getMembersStream(OrganizationModel, String, Boolean, Integer, Integer)	Use OrganizationProvider.getMembersStream(OrganizationModel, Map, Boolean, Integer, Integer) instead.
org.keycloak.sessions.AuthenticationSessionProvider.updateNonlocalSessionAuthNotes(AuthenticationSessionCompoundId, Map<String, String>)	For removal in Keycloak 27

Deprecated Classes

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

Deprecated 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.IdentityProviderModel.LEGACY_HIDE_ON_LOGIN_ATTR
org.keycloak.models.PasswordPolicy.RECOVERY_CODES_WARNING_THRESHOLD_DEFAULT
org.keycloak.models.PasswordPolicy.RECOVERY_CODES_WARNING_THRESHOLD_ID
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

Deprecated 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)
org.keycloak.credential.hash.PasswordHashProvider.encode(String, int, CredentialModel)	Exists due the backwards compatibility. It is recommended to use PasswordHashProvider.encodedCredential(String, int)}
org.keycloak.credential.hash.PasswordHashProvider.policyCheck(PasswordPolicy, CredentialModel)	Exists due the backwards compatibility. It is recommended to use PasswordHashProvider.policyCheck(PasswordPolicy, PasswordCredentialModel)
org.keycloak.credential.hash.PasswordHashProvider.verify(String, CredentialModel)	Exists due the backwards compatibility. It is recommended to use PasswordHashProvider.verify(String, PasswordCredentialModel)
org.keycloak.migration.MigrationModel.getResourcesTag()
org.keycloak.models.AuthenticatedClientSessionModel.getCurrentRefreshToken()	use AuthenticatedClientSessionModel.getRefreshToken(String)
org.keycloak.models.AuthenticatedClientSessionModel.getCurrentRefreshTokenUseCount()	use AuthenticatedClientSessionModel.getRefreshTokenUseCount(String)
org.keycloak.models.AuthenticatedClientSessionModel.setCurrentRefreshToken(String)	use AuthenticatedClientSessionModel.setRefreshToken(String, String)}
org.keycloak.models.AuthenticatedClientSessionModel.setCurrentRefreshTokenUseCount(int)
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.KeycloakContext.getContextObject(Class<T>)
org.keycloak.models.KeycloakSession.getProvider(Class<T>, ComponentModel)	Deprecated in favor of {@link #getComponentProvider)
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.PasswordPolicy.getRecoveryCodesWarningThreshold()
org.keycloak.models.RealmModel.addIdentityProvider(IdentityProviderModel)	Use IdentityProviderStorageProvider.create(IdentityProviderModel) instead.
org.keycloak.models.RealmModel.addIdentityProviderMapper(IdentityProviderMapperModel)	Use IDPProvider#createMapper(IdentityProviderMapperModel) instead.
org.keycloak.models.RealmModel.getIdentityProviderByAlias(String)	Use IdentityProviderStorageProvider.getByAlias(String) instead.
org.keycloak.models.RealmModel.getIdentityProviderMapperById(String)	Use IDPProvider#getMapperById(String) instead.
org.keycloak.models.RealmModel.getIdentityProviderMapperByName(String, String)	Use IDPProvider#getMapperByName(String, String) instead.
org.keycloak.models.RealmModel.getIdentityProviderMappersByAliasStream(String)	Use IDPProvider#getMappersByAliasStream(String) instead.
org.keycloak.models.RealmModel.getIdentityProviderMappersStream()	Use IDPProvider#getMappersStream() instead.
org.keycloak.models.RealmModel.getIdentityProvidersStream()	Use IdentityProviderStorageProvider.getAllStream() instead.
org.keycloak.models.RealmModel.getTopLevelGroupsStream()
org.keycloak.models.RealmModel.getTopLevelGroupsStream(Integer, Integer)
org.keycloak.models.RealmModel.isIdentityFederationEnabled()	use IdentityProviderStorageProvider.isIdentityFederationEnabled() instead.
org.keycloak.models.RealmModel.removeIdentityProviderByAlias(String)	Use IdentityProviderStorageProvider.remove(String) instead.
org.keycloak.models.RealmModel.removeIdentityProviderMapper(IdentityProviderMapperModel)	Use IDPProvider#removeMapper(IdentityProviderMapperModel) instead.
org.keycloak.models.RealmModel.updateIdentityProvider(IdentityProviderModel)	Use IdentityProviderStorageProvider.update(IdentityProviderModel) instead.
org.keycloak.models.RealmModel.updateIdentityProviderMapper(IdentityProviderMapperModel)	Use IDPProvider#updateMapper(IdentityProviderMapperModel) instead.
org.keycloak.models.SingleUseObjectKeyModel.getExpiration()	int will overflow with values after 2038. Use SingleUseObjectKeyModel.getExp() instead.
org.keycloak.models.SubjectCredentialManager.createCredentialThroughProvider(CredentialModel)
org.keycloak.models.SubjectCredentialManager.getConfiguredUserStorageCredentialTypesStream()
org.keycloak.models.SubjectCredentialManager.isConfiguredLocally(String)
org.keycloak.models.UserCredentialModel.isOtp(String)
org.keycloak.models.UserCredentialModel.passwordToken(String)
org.keycloak.models.UserSessionProvider.createUserSession(RealmModel, UserModel, String, String, String, boolean, String, String)	Use UserSessionProvider.createUserSession(String, RealmModel, UserModel, String, String, String, boolean, String, String, UserSessionModel.SessionPersistenceState) instead.
org.keycloak.models.UserSessionProvider.getClientSession(UserSessionModel, ClientModel, UUID, boolean)	Use UserSessionProvider.getClientSession(UserSessionModel, ClientModel, String, boolean) instead.
org.keycloak.models.UserSessionProvider.importUserSessions(Collection<UserSessionModel>, boolean)	Deprecated as offline session preloading was removed in KC25. This method will be removed in KC27.
org.keycloak.organization.OrganizationProvider.getMembersStream(OrganizationModel, String, Boolean, Integer, Integer)	Use OrganizationProvider.getMembersStream(OrganizationModel, Map, Boolean, Integer, Integer) 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.sessions.AuthenticationSessionProvider.updateNonlocalSessionAuthNotes(AuthenticationSessionCompoundId, Map<String, String>)	For removal in Keycloak 27
org.keycloak.storage.group.GroupLookupProvider.searchForGroupByNameStream(RealmModel, String, Integer, Integer)	Use GroupLookupProvider.searchForGroupByNameStream(RealmModel, String, Boolean, Integer, Integer) instead.
org.keycloak.storage.StorageId.isLocalStorage(ClientModel)	Use StorageId.isLocalStorage(String) instead.
org.keycloak.storage.StorageId.isLocalStorage(UserModel)	Use StorageId.isLocalStorage(String) instead.
org.keycloak.storage.StorageId.resolveProviderId(ClientModel)	Use StorageId.providerId(String) instead.
org.keycloak.storage.StorageId.resolveProviderId(UserModel)	Use StorageId.providerId(String) instead.
org.keycloak.storage.user.UserCountMethodsProvider.getUsersCount(RealmModel, String)	Use UserCountMethodsProvider.getUsersCount(RealmModel, Map) with an params map containing UserModel.SEARCH instead.
org.keycloak.storage.user.UserCountMethodsProvider.getUsersCount(RealmModel, String, Set<String>)	Use UserCountMethodsProvider.getUsersCount(RealmModel, Map, Set) with an params map containing UserModel.SEARCH instead.
org.keycloak.storage.user.UserQueryMethodsProvider.searchForUserStream(RealmModel, String)	Use UserQueryMethodsProvider.searchForUserStream(RealmModel, Map) with an params map containing UserModel.SEARCH instead.
org.keycloak.storage.user.UserQueryMethodsProvider.searchForUserStream(RealmModel, String, Integer, Integer)	Use UserQueryMethodsProvider.searchForUserStream(RealmModel, Map, Integer, Integer) with an params map containing UserModel.SEARCH instead.

Deprecated Constructors

Constructor	Description
org.keycloak.models.ModelDuplicateException()	use a variant with a message instead

Deprecated Enum Constants

Enum Constant	Description
org.keycloak.urls.UrlType.LOCAL_ADMIN	to be removed