Deprecated API

Contents

• Deprecated Classes
• Deprecated Enums
• Deprecated Fields
• Deprecated Methods
• Deprecated Enum Constants

Deprecated Classes

Class and Description
org.keycloak.representations.idm.ApplicationRepresentation
org.keycloak.representations.idm.ClientTemplateRepresentation
org.keycloak.common.util.HttpPostRedirect Class is deprecated and may be removed in the future. Use org.keycloak.saml.BaseSAML2BindingBuilder#buildHtml instead
org.keycloak.representations.idm.OAuthClientRepresentation
org.keycloak.models.credential.PasswordUserCredentialModel Recommended to use UserCredentialModel as it contains all the functionality required by this class
org.keycloak.RSATokenVerifier

Deprecated Enums

Enum and Description
org.keycloak.jose.jws.Algorithm

Deprecated Fields

Field and Description
org.keycloak.representations.idm.RolesRepresentation.application
org.keycloak.representations.idm.RoleRepresentation.Composites.application
org.keycloak.representations.idm.UserRepresentation.applicationRoles
org.keycloak.representations.idm.RealmRepresentation.applications
org.keycloak.representations.idm.RealmRepresentation.applicationScopeMappings
org.keycloak.representations.idm.RealmRepresentation.certificate
org.keycloak.representations.idm.ApplicationRepresentation.claims
org.keycloak.representations.idm.ScopeMappingRepresentation.clientTemplate
org.keycloak.representations.idm.ClientRepresentation.clientTemplate
org.keycloak.representations.idm.RealmRepresentation.clientTemplates
org.keycloak.representations.idm.RealmRepresentation.codeSecret
org.keycloak.representations.idm.ProtocolMapperRepresentation.consentRequired
org.keycloak.representations.idm.ProtocolMapperRepresentation.consentText
org.keycloak.representations.idm.CredentialRepresentation.counter
org.keycloak.representations.idm.CredentialRepresentation.device
org.keycloak.representations.idm.ClientRepresentation.directGrantsOnly
org.keycloak.representations.idm.UserConsentRepresentation.grantedRealmRoles
org.keycloak.representations.idm.CredentialRepresentation.hashedSaltedValue
org.keycloak.representations.idm.CredentialRepresentation.hashIterations
org.keycloak.credential.CredentialModel.HOTP
org.keycloak.models.UserCredentialModel.HOTP
org.keycloak.representations.idm.RealmRepresentation.oauthClients
org.keycloak.credential.CredentialModel.OTP
org.keycloak.credential.CredentialModel.PASSWORD
org.keycloak.models.UserCredentialModel.PASSWORD
org.keycloak.credential.CredentialModel.PASSWORD_HISTORY
org.keycloak.models.UserCredentialModel.PASSWORD_HISTORY
org.keycloak.credential.CredentialModel.PASSWORD_TOKEN
org.keycloak.models.UserCredentialModel.PASSWORD_TOKEN
org.keycloak.representations.idm.RealmRepresentation.passwordCredentialGrantAllowed
org.keycloak.representations.idm.RealmRepresentation.privateKey
org.keycloak.representations.idm.RealmRepresentation.publicKey
org.keycloak.representations.idm.RealmRepresentation.realmCacheEnabled
org.keycloak.representations.idm.RealmRepresentation.requiredCredentials
org.keycloak.representations.idm.CredentialRepresentation.salt
org.keycloak.representations.idm.RoleRepresentation.scopeParamRequired
org.keycloak.representations.idm.RealmRepresentation.social
org.keycloak.representations.idm.UserRepresentation.socialLinks
org.keycloak.representations.idm.RealmRepresentation.socialProviders
org.keycloak.credential.CredentialModel.TOTP
org.keycloak.models.UserCredentialModel.TOTP
org.keycloak.representations.idm.IdentityProviderRepresentation.updateProfileFirstLoginMode
org.keycloak.representations.idm.RealmRepresentation.updateProfileOnInitialSocialLogin
org.keycloak.representations.idm.RealmRepresentation.userCacheEnabled

Deprecated Methods

Method and Description
org.keycloak.TokenVerifier.checkActive(boolean) This method is here only for backward compatibility with previous version of TokenVerifier.
org.keycloak.common.util.ServerCookie.checkName(String) - Not used
org.keycloak.TokenVerifier.checkRealmUrl(boolean) This method is here only for backward compatibility with previous version of TokenVerifier.
org.keycloak.TokenVerifier.checkTokenType(boolean) This method is here only for backward compatibility with previous version of TokenVerifier.
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.representations.JsonWebToken.expiration(int) int will overflow with values after 2038. Use JsonWebToken.exp(Long) instead.
org.keycloak.authorization.client.resource.PermissionResource.forResource(PermissionRequest) use PermissionResource.create(PermissionRequest)
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.representations.idm.CredentialRepresentation.getAlgorithm()
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.representations.idm.RolesRepresentation.getApplication()
org.keycloak.representations.idm.RoleRepresentation.Composites.getApplication()
org.keycloak.representations.idm.UserRepresentation.getApplicationRoles()
org.keycloak.representations.idm.RealmRepresentation.getApplicationScopeMappings()
org.keycloak.representations.IDToken.getAuthTime() int will overflow with values after 2038. Use IDToken.getAuth_time() instead.
org.keycloak.representations.idm.ScopeMappingRepresentation.getClientTemplate()
org.keycloak.representations.idm.ClientRepresentation.getClientTemplate()
org.keycloak.representations.idm.RealmRepresentation.getClientTemplates()
org.keycloak.credential.CredentialModel.getConfig() Recommended to use CredentialModel.getCredentialData() instead and use the subtype of CredentialData specific to your credential
org.keycloak.representations.idm.CredentialRepresentation.getConfig()
org.keycloak.representations.idm.ProtocolMapperRepresentation.getConsentText()
org.keycloak.credential.CredentialModel.getCounter() Recommended to use OTPCredentialModel.getCredentialData().getCounter()
org.keycloak.representations.idm.CredentialRepresentation.getCounter()
org.keycloak.credential.CredentialModel.getDevice() Recommended to use OTPCredentialModel.getCredentialData().getDevice()
org.keycloak.representations.idm.CredentialRepresentation.getDevice()
org.keycloak.credential.CredentialModel.getDigits() Recommended to use OTPCredentialModel.getCredentialData().getDigits()
org.keycloak.representations.idm.CredentialRepresentation.getDigits()
org.keycloak.dom.saml.v2.metadata.ExtensionsType.getElement()
org.keycloak.representations.JsonWebToken.getExpiration() int will overflow with values after 2038. Use JsonWebToken.getExp() instead.
org.keycloak.representations.idm.UserConsentRepresentation.getGrantedRealmRoles()
org.keycloak.representations.idm.CredentialRepresentation.getHashedSaltedValue()
org.keycloak.credential.CredentialModel.getHashIterations() Recommended to use PasswordCredentialModel.getCredentialData().getHashIterations()
org.keycloak.representations.idm.CredentialRepresentation.getHashIterations()
org.keycloak.models.KeyManager.getHmacKeys(RealmModel)
org.keycloak.models.KeyManager.getHmacSecretKey(RealmModel, String)
org.keycloak.representations.JsonWebToken.getIssuedAt() int will overflow with values after 2038. Use JsonWebToken.getIat() instead.
org.keycloak.representations.JsonWebToken.getNotBefore() int will overflow with values after 2038. Use JsonWebToken.getNbf() instead.
org.keycloak.representations.idm.RealmRepresentation.getOauthClients()
org.keycloak.credential.CredentialModel.getPeriod() Recommended to use OTPCredentialModel.getCredentialData().getPeriod()
org.keycloak.representations.idm.CredentialRepresentation.getPeriod()
org.keycloak.representations.idm.RealmRepresentation.getRequiredCredentials()
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.representations.idm.CredentialRepresentation.getSalt()
org.keycloak.representations.idm.RealmRepresentation.getSocialProviders()
org.keycloak.representations.idm.IdentityProviderRepresentation.getUpdateProfileFirstLoginMode() deprecated and replaced by configuration on IdpReviewProfileAuthenticator
org.keycloak.representations.idm.authorization.ResourceRepresentation.getUri()
org.keycloak.credential.CredentialModel.getValue() Recommended to use PasswordCredentialModel.getSecretData().getValue() or OTPCredentialModel.getSecretData().getValue()
org.keycloak.jose.jws.JWSBuilder.EncodingBuilder.hmac256(byte[])
org.keycloak.jose.jws.JWSBuilder.EncodingBuilder.hmac256(SecretKey)
org.keycloak.jose.jws.JWSBuilder.EncodingBuilder.hmac384(byte[])
org.keycloak.jose.jws.JWSBuilder.EncodingBuilder.hmac384(SecretKey)
org.keycloak.jose.jws.JWSBuilder.EncodingBuilder.hmac512(byte[])
org.keycloak.jose.jws.JWSBuilder.EncodingBuilder.hmac512(SecretKey)
org.keycloak.models.IdentityProviderModel.isAuthenticateByDefault()
org.keycloak.representations.idm.IdentityProviderRepresentation.isAuthenticateByDefault() Replaced by configuration option in identity provider authenticator
org.keycloak.representations.idm.AbstractAuthenticationExecutionRepresentation.isAutheticatorFlow()
org.keycloak.representations.idm.ProtocolMapperRepresentation.isConsentRequired()
org.keycloak.representations.idm.ClientRepresentation.isDirectGrantsOnly()
org.keycloak.models.UserCredentialModel.isOtp(String)
org.keycloak.representations.idm.RoleRepresentation.isScopeParamRequired()
org.keycloak.representations.idm.RealmRepresentation.isSocial()
org.keycloak.representations.JsonWebToken.issuedAt(int) int will overflow with values after 2038. Use JsonWebToken.iat(Long) ()} instead.
org.keycloak.representations.idm.UserRepresentation.isTotp()
org.keycloak.representations.idm.RealmRepresentation.isUpdateProfileOnInitialSocialLogin()
org.keycloak.representations.idm.ClientRepresentation.isUseTemplateConfig()
org.keycloak.representations.idm.ClientRepresentation.isUseTemplateMappers()
org.keycloak.representations.idm.ClientRepresentation.isUseTemplateScope()
org.keycloak.common.util.ServerCookie.maybeQuote(int, StringBuffer, String) - Not used
org.keycloak.representations.JsonWebToken.notBefore(int) int will overflow with values after 2038. Use JsonWebToken.nbf(Long) instead.
org.keycloak.models.UserCredentialModel.passwordToken(String)
org.keycloak.credential.hash.PasswordHashProvider.policyCheck(PasswordPolicy, CredentialModel) Exists due the backwards compatibility. It is recommended to use PasswordHashProvider.policyCheck(PasswordPolicy, PasswordCredentialModel)
org.keycloak.common.util.StreamUtil.readString(InputStream) Use StreamUtil.readString(java.io.InputStream, java.nio.charset.Charset) variant.
org.keycloak.TokenVerifier.realmUrl(String) This method is here only for backward compatibility with previous version of TokenVerifier.
org.keycloak.admin.client.resource.UserResource.resetPasswordEmail()
org.keycloak.admin.client.resource.UserResource.resetPasswordEmail(String)
org.keycloak.jose.jws.JWSBuilder.EncodingBuilder.rsa256(PrivateKey)
org.keycloak.jose.jws.JWSBuilder.EncodingBuilder.rsa384(PrivateKey)
org.keycloak.jose.jws.JWSBuilder.EncodingBuilder.rsa512(PrivateKey)
org.keycloak.credential.CredentialModel.setAlgorithm(String) See CredentialModel.getAlgorithm()
org.keycloak.models.IdentityProviderModel.setAuthenticateByDefault(boolean)
org.keycloak.representations.idm.IdentityProviderRepresentation.setAuthenticateByDefault(boolean)
org.keycloak.representations.idm.AbstractAuthenticationExecutionRepresentation.setAutheticatorFlow(boolean)
org.keycloak.representations.IDToken.setAuthTime(int) int will overflow with values after 2038. Use IDToken.setAuth_time(Long) ()} instead.
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.dom.saml.v2.metadata.ExtensionsType.setElement(Element)
org.keycloak.credential.CredentialModel.setHashIterations(int) See CredentialModel.getHashIterations()
org.keycloak.credential.CredentialModel.setPeriod(int) See CredentialModel.setPeriod(int)
org.keycloak.representations.idm.RealmRepresentation.setRequiredCredentials(Set<String>)
org.keycloak.credential.CredentialModel.setSalt(byte[]) See CredentialModel.getSalt()
org.keycloak.representations.idm.UserRepresentation.setTotp(Boolean)
org.keycloak.representations.idm.IdentityProviderRepresentation.setUpdateProfileFirstLogin(boolean) IdentityProviderRepresentation.setUpdateProfileFirstLoginMode(String)
org.keycloak.representations.idm.IdentityProviderRepresentation.setUpdateProfileFirstLoginMode(String) deprecated and replaced by configuration on IdpReviewProfileAuthenticator
org.keycloak.representations.idm.authorization.ResourceRepresentation.setUri(String)
org.keycloak.credential.CredentialModel.setValue(String) See CredentialModel.getValue()
org.keycloak.jose.jws.JWSBuilder.EncodingBuilder.sign(Algorithm, PrivateKey)
org.keycloak.admin.client.resource.RealmResource.testLDAPConnection(String, String, String, String, String, String)
org.keycloak.admin.client.resource.RealmResource.testSMTPConnection(String)
org.keycloak.credential.hash.PasswordHashProvider.verify(String, CredentialModel) Exists due the backwards compatibility. It is recommended to use PasswordHashProvider.verify(String, PasswordCredentialModel)

Deprecated Enum Constants

Enum Constant and Description
org.keycloak.saml.common.constants.JBossSAMLConstants.EXTENSIONS Use namespace-aware variant instead
org.keycloak.saml.common.constants.JBossSAMLConstants.RESPONSE Use namespace-aware variant instead