Deprecated API

Contents

• Classes
• Enums
• Fields
• Methods
• Enum Constants

Deprecated Classes

Class	Description
org.keycloak.common.util.HttpPostRedirect	Class is deprecated and may be removed in the future. Use org.keycloak.saml.BaseSAML2BindingBuilder#buildHtml instead
org.keycloak.common.util.reflections.SetAccessiblePrivilegedAction	for removal in Keycloak 27
org.keycloak.common.util.reflections.UnSetAccessiblePrivilegedAction	for removal in Keycloak 27
org.keycloak.common.util.Resteasy	use org.keycloak.util.KeycloakSessionUtil instead
org.keycloak.representations.idm.ApplicationRepresentation
org.keycloak.representations.idm.ClientTemplateRepresentation
org.keycloak.representations.idm.OAuthClientRepresentation

Deprecated Enums

Enum	Description
org.keycloak.jose.jws.Algorithm

Deprecated Fields

Field	Description
org.keycloak.representations.idm.ApplicationRepresentation.claims
org.keycloak.representations.idm.ClientRepresentation.clientTemplate
org.keycloak.representations.idm.ClientRepresentation.defaultRoles
org.keycloak.representations.idm.ClientRepresentation.directGrantsOnly
org.keycloak.representations.idm.CredentialRepresentation.counter
org.keycloak.representations.idm.CredentialRepresentation.device
org.keycloak.representations.idm.CredentialRepresentation.hashedSaltedValue
org.keycloak.representations.idm.CredentialRepresentation.hashIterations
org.keycloak.representations.idm.CredentialRepresentation.salt
org.keycloak.representations.idm.IdentityProviderRepresentation.updateProfileFirstLoginMode
org.keycloak.representations.idm.ProtocolMapperRepresentation.consentRequired
org.keycloak.representations.idm.ProtocolMapperRepresentation.consentText
org.keycloak.representations.idm.RealmRepresentation.applications
org.keycloak.representations.idm.RealmRepresentation.applicationScopeMappings
org.keycloak.representations.idm.RealmRepresentation.certificate
org.keycloak.representations.idm.RealmRepresentation.clientTemplates
org.keycloak.representations.idm.RealmRepresentation.codeSecret
org.keycloak.representations.idm.RealmRepresentation.defaultRoles
org.keycloak.representations.idm.RealmRepresentation.oauthClients
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.RealmRepresentation.social
org.keycloak.representations.idm.RealmRepresentation.socialProviders
org.keycloak.representations.idm.RealmRepresentation.updateProfileOnInitialSocialLogin
org.keycloak.representations.idm.RealmRepresentation.userCacheEnabled
org.keycloak.representations.idm.RoleRepresentation.Composites.application
org.keycloak.representations.idm.RoleRepresentation.scopeParamRequired
org.keycloak.representations.idm.RolesRepresentation.application
org.keycloak.representations.idm.ScopeMappingRepresentation.clientTemplate
org.keycloak.representations.idm.UserConsentRepresentation.grantedRealmRoles
org.keycloak.representations.idm.UserRepresentation.applicationRoles
org.keycloak.representations.idm.UserRepresentation.socialLinks

Deprecated Methods

Method	Description
org.keycloak.common.util.reflections.Reflections.newInstance(Class<?>, String)	for removal in Keycloak 27
org.keycloak.common.util.reflections.Reflections.newInstance(Class<T>)	for removal in Keycloak 27
org.keycloak.common.util.Resteasy.pushDefaultContextObject(Class, Object)
org.keycloak.common.util.StreamUtil.readString(InputStream)	Use StreamUtil.readString(java.io.InputStream, java.nio.charset.Charset) variant.
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.jose.jws.JWSBuilder.EncodingBuilder.rsa256(PrivateKey)
org.keycloak.jose.jws.JWSBuilder.EncodingBuilder.rsa384(PrivateKey)
org.keycloak.jose.jws.JWSBuilder.EncodingBuilder.rsa512(PrivateKey)
org.keycloak.jose.jws.JWSBuilder.EncodingBuilder.sign(Algorithm, PrivateKey)
org.keycloak.representations.idm.AbstractAuthenticationExecutionRepresentation.isAutheticatorFlow()
org.keycloak.representations.idm.AbstractAuthenticationExecutionRepresentation.setAutheticatorFlow(boolean)
org.keycloak.representations.idm.authorization.ResourceRepresentation.getUri()
org.keycloak.representations.idm.authorization.ResourceRepresentation.setUri(String)
org.keycloak.representations.idm.ClientRepresentation.getClientTemplate()
org.keycloak.representations.idm.ClientRepresentation.getDefaultRoles()
org.keycloak.representations.idm.ClientRepresentation.isDirectGrantsOnly()
org.keycloak.representations.idm.ClientRepresentation.isUseTemplateConfig()
org.keycloak.representations.idm.ClientRepresentation.isUseTemplateMappers()
org.keycloak.representations.idm.ClientRepresentation.isUseTemplateScope()
org.keycloak.representations.idm.ClientRepresentation.setDefaultRoles(String[])
org.keycloak.representations.idm.CredentialRepresentation.getAlgorithm()
org.keycloak.representations.idm.CredentialRepresentation.getConfig()
org.keycloak.representations.idm.CredentialRepresentation.getCounter()
org.keycloak.representations.idm.CredentialRepresentation.getDevice()
org.keycloak.representations.idm.CredentialRepresentation.getDigits()
org.keycloak.representations.idm.CredentialRepresentation.getHashedSaltedValue()
org.keycloak.representations.idm.CredentialRepresentation.getHashIterations()
org.keycloak.representations.idm.CredentialRepresentation.getPeriod()
org.keycloak.representations.idm.CredentialRepresentation.getSalt()
org.keycloak.representations.idm.IdentityProviderRepresentation.getUpdateProfileFirstLoginMode()	deprecated and replaced by configuration on IdpReviewProfileAuthenticator
org.keycloak.representations.idm.IdentityProviderRepresentation.isAuthenticateByDefault()	Replaced by configuration option in identity provider authenticator
org.keycloak.representations.idm.IdentityProviderRepresentation.setAuthenticateByDefault(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.ProtocolMapperRepresentation.getConsentText()
org.keycloak.representations.idm.ProtocolMapperRepresentation.isConsentRequired()
org.keycloak.representations.idm.RealmRepresentation.getApplicationScopeMappings()
org.keycloak.representations.idm.RealmRepresentation.getClientTemplates()
org.keycloak.representations.idm.RealmRepresentation.getDefaultRoles()
org.keycloak.representations.idm.RealmRepresentation.getOauthClients()
org.keycloak.representations.idm.RealmRepresentation.getRequiredCredentials()
org.keycloak.representations.idm.RealmRepresentation.getSocialProviders()
org.keycloak.representations.idm.RealmRepresentation.isSocial()
org.keycloak.representations.idm.RealmRepresentation.isUpdateProfileOnInitialSocialLogin()
org.keycloak.representations.idm.RealmRepresentation.setDefaultRoles(List<String>)
org.keycloak.representations.idm.RealmRepresentation.setRequiredCredentials(Set<String>)
org.keycloak.representations.idm.RoleRepresentation.Composites.getApplication()
org.keycloak.representations.idm.RoleRepresentation.isScopeParamRequired()
org.keycloak.representations.idm.RolesRepresentation.getApplication()
org.keycloak.representations.idm.ScopeMappingRepresentation.getClientTemplate()
org.keycloak.representations.idm.UserConsentRepresentation.getGrantedRealmRoles()
org.keycloak.representations.idm.UserRepresentation.getApplicationRoles()
org.keycloak.representations.idm.UserRepresentation.getOrigin()	Use UserRepresentation.getFederationLink() instead
org.keycloak.representations.idm.UserRepresentation.isTotp()
org.keycloak.representations.idm.UserRepresentation.setOrigin(String)	Use UserRepresentation.setFederationLink(String) instead
org.keycloak.representations.idm.UserRepresentation.setTotp(Boolean)
org.keycloak.representations.IDToken.getSessionState()	Use IDToken.getSessionId() instead.
org.keycloak.TokenVerifier.checkActive(boolean)	This method is here only for backward compatibility with previous version of TokenVerifier.
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.TokenVerifier.realmUrl(String)	This method is here only for backward compatibility with previous version of TokenVerifier.

Deprecated Enum Constants

Enum Constant	Description
org.keycloak.common.enums.HostnameVerificationPolicy.STRICT
org.keycloak.common.enums.HostnameVerificationPolicy.WILDCARD