Deprecated API

Contents

• Deprecated Classes
• Deprecated Fields
• Deprecated Methods

Deprecated Classes

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

Deprecated Fields

Field and Description
org.keycloak.models.UserCredentialModel.HOTP
org.keycloak.credential.CredentialModel.HOTP
org.keycloak.credential.CredentialModel.OTP
org.keycloak.models.UserCredentialModel.PASSWORD
org.keycloak.credential.CredentialModel.PASSWORD
org.keycloak.models.UserCredentialModel.PASSWORD_HISTORY
org.keycloak.credential.CredentialModel.PASSWORD_HISTORY
org.keycloak.models.UserCredentialModel.PASSWORD_TOKEN
org.keycloak.credential.CredentialModel.PASSWORD_TOKEN
org.keycloak.models.UserCredentialModel.TOTP
org.keycloak.credential.CredentialModel.TOTP

Deprecated Methods

Method and Description
org.keycloak.models.RealmProvider.addClient(RealmModel, String) Use the corresponding method from ClientProvider.
org.keycloak.models.RealmProvider.addClient(RealmModel, String, String) Use the corresponding method from ClientProvider.
org.keycloak.credential.hash.PasswordHashProvider.encode(String, int, CredentialModel) Exists due the backwards compatibility. It is recommended to use encodedCredential(String, int)}
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.credential.CredentialModel.getAlgorithm() Recommended to use PasswordCredentialModel.getCredentialData().getAlgorithm() or OTPCredentialModel.getCredentialData().getAlgorithm()
org.keycloak.models.RealmProvider.getAlwaysDisplayInConsoleClients(RealmModel) Use the corresponding method from ClientProvider.
org.keycloak.models.RealmProvider.getClientByClientId(RealmModel, String) Use the corresponding method from ClientProvider.
org.keycloak.models.RealmProvider.getClientByClientId(String, RealmModel) Use the corresponding method from ClientProvider.
org.keycloak.storage.client.ClientLookupProvider.getClientByClientId(String, RealmModel) Use ClientLookupProvider.getClientByClientId(org.keycloak.models.RealmModel, java.lang.String) instead.
org.keycloak.models.RealmProvider.getClientById(RealmModel, String) Use the corresponding method from ClientProvider.
org.keycloak.models.RealmProvider.getClientById(String, RealmModel) Use the corresponding method from ClientProvider.
org.keycloak.storage.client.ClientLookupProvider.getClientById(String, RealmModel) Use ClientLookupProvider.getClientById(org.keycloak.models.RealmModel, java.lang.String) instead.
org.keycloak.models.RealmProvider.getClients(RealmModel) Use the corresponding method from ClientProvider.
org.keycloak.models.RealmProvider.getClients(RealmModel, Integer, Integer) Use the corresponding method from ClientProvider.
org.keycloak.models.RealmProvider.getClientsCount(RealmModel) Use the corresponding method from ClientProvider.
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.getCredentialData().getCounter()
org.keycloak.credential.CredentialModel.getDevice() Recommended to use OTPCredentialModel.getCredentialData().getDevice()
org.keycloak.credential.CredentialModel.getDigits() Recommended to use OTPCredentialModel.getCredentialData().getDigits()
org.keycloak.credential.CredentialModel.getHashIterations() Recommended to use PasswordCredentialModel.getCredentialData().getHashIterations()
org.keycloak.models.KeyManager.getHmacKeys(RealmModel)
org.keycloak.models.KeyManager.getHmacSecretKey(RealmModel, String)
org.keycloak.credential.CredentialModel.getPeriod() Recommended to use OTPCredentialModel.getCredentialData().getPeriod()
org.keycloak.models.KeyManager.getRsaCertificate(RealmModel, String)
org.keycloak.models.KeyManager.getRsaKeys(RealmModel)
org.keycloak.models.KeyManager.getRsaPublicKey(RealmModel, String)
org.keycloak.credential.CredentialModel.getSalt() Recommended to use PasswordCredentialModel.getSecretData().getSalt()
org.keycloak.models.ScopeContainerModel.getScopeMappings()
org.keycloak.credential.CredentialModel.getValue() Recommended to use PasswordCredentialModel.getSecretData().getValue() or OTPCredentialModel.getSecretData().getValue()
org.keycloak.models.IdentityProviderModel.isAuthenticateByDefault()
org.keycloak.models.UserCredentialModel.isOtp(String)
org.keycloak.models.UserCredentialModel.passwordToken(String)
org.keycloak.credential.hash.PasswordHashProvider.policyCheck(PasswordPolicy, CredentialModel) Exists due the backwards compatibility. It is recommended to use policyCheck(PasswordPolicy, PasswordCredentialModel)
org.keycloak.models.RealmProvider.removeClient(RealmModel, String) Use the corresponding method from ClientProvider.
org.keycloak.models.RealmProvider.removeClient(String, RealmModel) Use the corresponding method from ClientProvider.
org.keycloak.models.ClientProvider.removeClient(String, RealmModel) Use ClientProvider.removeClient(RealmModel, String) instead.
org.keycloak.models.RealmProvider.searchClientsByClientId(RealmModel, String, Integer, Integer) Use the corresponding method from ClientProvider.
org.keycloak.models.RealmProvider.searchClientsByClientId(String, Integer, Integer, RealmModel) Use the corresponding method from ClientProvider.
org.keycloak.storage.client.ClientLookupProvider.searchClientsByClientId(String, Integer, Integer, RealmModel) Use ClientLookupProvider.searchClientsByClientId(org.keycloak.models.RealmModel, java.lang.String, java.lang.Integer, java.lang.Integer) instead.
org.keycloak.credential.CredentialModel.setAlgorithm(String) See CredentialModel.getAlgorithm()
org.keycloak.models.IdentityProviderModel.setAuthenticateByDefault(boolean)
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.models.ClientModel.updateClient() Do not use, to be removed
org.keycloak.credential.hash.PasswordHashProvider.verify(String, CredentialModel) Exists due the backwards compatibility. It is recommended to use verify(String, PasswordCredentialModel)