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.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.ClientRepresentation.directGrantsOnly
org.keycloak.representations.idm.UserConsentRepresentation.grantedRealmRoles
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.RoleRepresentation.scopeParamRequired
org.keycloak.representations.idm.RealmRepresentation.social
org.keycloak.representations.idm.UserRepresentation.socialLinks
org.keycloak.representations.idm.RealmRepresentation.socialProviders
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.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.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.idm.ScopeMappingRepresentation.getClientTemplate()
org.keycloak.representations.idm.ClientRepresentation.getClientTemplate()
org.keycloak.representations.idm.RealmRepresentation.getClientTemplates()
org.keycloak.representations.idm.ProtocolMapperRepresentation.getConsentText()
org.keycloak.dom.saml.v2.metadata.ExtensionsType.getElement()
org.keycloak.representations.idm.UserConsentRepresentation.getGrantedRealmRoles()
org.keycloak.models.KeyManager.getHmacKeys(RealmModel)
org.keycloak.models.KeyManager.getHmacSecretKey(RealmModel, String)
org.keycloak.representations.idm.RealmRepresentation.getOauthClients()
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.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.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.ProtocolMapperRepresentation.isConsentRequired()
org.keycloak.representations.idm.ClientRepresentation.isDirectGrantsOnly()
org.keycloak.representations.idm.RoleRepresentation.isScopeParamRequired()
org.keycloak.representations.idm.RealmRepresentation.isSocial()
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.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.models.IdentityProviderModel.setAuthenticateByDefault(boolean)
org.keycloak.representations.idm.IdentityProviderRepresentation.setAuthenticateByDefault(boolean)
org.keycloak.dom.saml.v2.metadata.ExtensionsType.setElement(Element)
org.keycloak.representations.idm.RealmRepresentation.setRequiredCredentials(Set<String>)
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.jose.jws.JWSBuilder.EncodingBuilder.sign(Algorithm, PrivateKey)
org.keycloak.TokenVerifier.tokenType(String) This method is here only for backward compatibility with previous version of TokenVerifier.

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