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.common.util.RandomString Replaced by SecretGenerator
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.RealmRepresentation.defaultRoles
org.keycloak.representations.idm.ClientRepresentation.defaultRoles
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.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.models.RealmProvider.addClientRole(RealmModel, ClientModel, String) Use the corresponding method from RoleProvider.
org.keycloak.models.RealmProvider.addClientRole(RealmModel, ClientModel, String, String) Use the corresponding method from RoleProvider.
org.keycloak.models.RoleContainerModel.addDefaultRole(String) Default roles are now managed by RealmModel.getDefaultRole(). This method will be removed.
org.keycloak.models.RealmProvider.addRealmRole(RealmModel, String) Use the corresponding method from RoleProvider.
org.keycloak.models.RealmProvider.addRealmRole(RealmModel, String, String) Use the corresponding method from RoleProvider.
org.keycloak.models.RealmProvider.addTopLevelGroup(RealmModel, GroupModel) Use the corresponding method from GroupProvider.
org.keycloak.models.UserSessionProvider.addUserLoginFailure(RealmModel, String) Use addUserLoginFailure instead.
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.models.RealmProvider.createGroup(RealmModel, String) Use the corresponding method from GroupProvider.
org.keycloak.models.RealmProvider.createGroup(RealmModel, String, GroupModel) Use the corresponding method from GroupProvider.
org.keycloak.models.RealmProvider.createGroup(RealmModel, String, String) Use the corresponding method from GroupProvider.
org.keycloak.models.RealmProvider.createGroup(RealmModel, String, String, GroupModel) Use the corresponding method from GroupProvider.
org.keycloak.sessions.AuthenticationSessionProvider.createRootAuthenticationSession(String, RealmModel) Use AuthenticationSessionProvider.createRootAuthenticationSession(RealmModel, String) createRootAuthenticationSession} instead.
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.getPasswordCredentialData().getAlgorithm() or OTPCredentialModel.getOTPCredentialData().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.models.RealmModel.getAlwaysDisplayInConsoleClients() Use getAlwaysDisplayInConsoleClientsStream instead.
org.keycloak.models.RealmProvider.getAlwaysDisplayInConsoleClients(RealmModel) Use the corresponding method from ClientProvider.
org.keycloak.models.ClientProvider.getAlwaysDisplayInConsoleClients(RealmModel) use the stream variant instead
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.models.UserModel.getAttribute(String) Use getAttributeStream instead.
org.keycloak.models.RoleModel.getAttribute(String) Use getAttributeStream instead.
org.keycloak.models.GroupModel.getAttribute(String) Use getAttributeStream instead.
org.keycloak.models.RealmModel.getAuthenticationExecutions(String) Use getAuthenticationExecutionsStream instead.
org.keycloak.models.RealmModel.getAuthenticationFlows() Use getAuthenticationFlowsStream instead.
org.keycloak.models.RealmModel.getAuthenticatorConfigs() Use getAuthenticatorConfigsStream instead.
org.keycloak.representations.IDToken.getAuthTime() int will overflow with values after 2038. Use IDToken.getAuth_time() instead.
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(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.getClientRole(RealmModel, ClientModel, String) Use the corresponding method from RoleProvider.
org.keycloak.models.RoleMapperModel.getClientRoleMappings(ClientModel) Use getClientRoleMappingsStream instead.
org.keycloak.models.RealmProvider.getClientRoles(RealmModel, ClientModel) Use the corresponding method from RoleProvider.
org.keycloak.models.RealmProvider.getClientRoles(RealmModel, ClientModel, Integer, Integer) Use the corresponding method from RoleProvider.
org.keycloak.models.RealmModel.getClients() Use getClientsStream instead.
org.keycloak.models.RealmModel.getClients(Integer, Integer) Use getClientsStream instead.
org.keycloak.models.RealmProvider.getClients(RealmModel) Use the corresponding method from ClientProvider.
org.keycloak.models.ClientProvider.getClients(RealmModel) use the stream variant instead Effectively the same as the call getClients(realm, null, null).
org.keycloak.models.RealmProvider.getClients(RealmModel, Integer, Integer) Use the corresponding method from ClientProvider.
org.keycloak.models.ClientProvider.getClients(RealmModel, Integer, Integer) use the stream variant instead
org.keycloak.models.RealmProvider.getClientScopeById(RealmModel, String) Use the corresponding method from ClientScopeProvider.
org.keycloak.models.RealmProvider.getClientScopeById(String, RealmModel) Use the corresponding method from ClientScopeProvider.
org.keycloak.models.RealmModel.getClientScopes() Use getClientScopesStream instead.
org.keycloak.models.ClientSessionContext.getClientScopes() Use getClientScopesStream instead.
org.keycloak.models.RealmProvider.getClientsCount(RealmModel) Use the corresponding method from ClientProvider.
org.keycloak.models.UserSessionProvider.getClientSession(UserSessionModel, ClientModel, UUID, boolean) Use UserSessionProvider.getClientSession(UserSessionModel, ClientModel, String, boolean) instead.
org.keycloak.models.RealmModel.getClientStorageProviders() Use getClientStorageProvidersStream instead.
org.keycloak.representations.idm.ScopeMappingRepresentation.getClientTemplate()
org.keycloak.representations.idm.ClientRepresentation.getClientTemplate()
org.keycloak.representations.idm.RealmRepresentation.getClientTemplates()
org.keycloak.models.RealmModel.getComponents() Use getComponentsStream instead.
org.keycloak.models.RealmModel.getComponents(String) Use getComponentsStream instead.
org.keycloak.models.RealmModel.getComponents(String, String) Use getComponentsStream instead.
org.keycloak.models.RoleModel.getComposites() Use getCompositesStream instead.
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.models.UserCredentialManager.getConfiguredUserStorageCredentialTypes(RealmModel, UserModel) Use getConfiguredUserStorageCredentialTypesStream instead.
org.keycloak.models.UserProvider.getConsents(RealmModel, String) Use getConsentsStream instead.
org.keycloak.storage.federated.UserConsentFederatedStorage.getConsents(RealmModel, String) Use getConsentsStream instead.
org.keycloak.representations.idm.ProtocolMapperRepresentation.getConsentText()
org.keycloak.credential.CredentialModel.getCounter() Recommended to use OTPCredentialModel.getOTPCredentialData().getCounter()
org.keycloak.representations.idm.CredentialRepresentation.getCounter()
org.keycloak.models.RealmModel.getDefaultClientScopes(boolean) Use getDefaultClientScopesStream instead.
org.keycloak.models.RealmModel.getDefaultGroups() Use getDefaultGroupsStream instead.
org.keycloak.models.RoleContainerModel.getDefaultRoles() Default roles are now managed by RealmModel.getDefaultRole(). This method will be removed.
org.keycloak.representations.idm.RealmRepresentation.getDefaultRoles()
org.keycloak.representations.idm.ClientRepresentation.getDefaultRoles()
org.keycloak.models.RoleContainerModel.getDefaultRolesStream() Default roles are now managed by RealmModel.getDefaultRole(). This method will be removed.
org.keycloak.credential.CredentialModel.getDevice() Recommended to use OTPCredentialModel.getOTPCredentialData().getDevice()
org.keycloak.representations.idm.CredentialRepresentation.getDevice()
org.keycloak.credential.CredentialModel.getDigits() Recommended to use OTPCredentialModel.getOTPCredentialData().getDigits()
org.keycloak.representations.idm.CredentialRepresentation.getDigits()
org.keycloak.credential.CredentialInputUpdater.getDisableableCredentialTypes(RealmModel, UserModel) Use getDisableableCredentialTypesStream instead.
org.keycloak.models.UserCredentialManager.getDisableableCredentialTypes(RealmModel, UserModel) Use getDisableableCredentialTypesStream instead.
org.keycloak.dom.saml.v2.metadata.ExtensionsType.getElement()
org.keycloak.models.RealmModel.getEnabledEventTypes() Use getEnabledEventTypesStream instead.
org.keycloak.models.RealmModel.getEventsListeners() Use getEventsListenersStream instead.
org.keycloak.representations.JsonWebToken.getExpiration() int will overflow with values after 2038. Use JsonWebToken.getExp() instead.
org.keycloak.storage.federated.UserBrokerLinkFederatedStorage.getFederatedIdentities(String, RealmModel) Use getFederatedIdentitiesStream instead.
org.keycloak.models.UserProvider.getFederatedIdentities(UserModel, RealmModel) Use getFederatedIdentitiesStream instead.
org.keycloak.models.UserProvider.getFederatedIdentity(UserModel, String, RealmModel) Use getFederatedIdentity instead.
org.keycloak.representations.idm.UserConsentRepresentation.getGrantedRealmRoles()
org.keycloak.models.RealmProvider.getGroupById(RealmModel, String) Use the corresponding method from GroupProvider.
org.keycloak.models.RealmProvider.getGroupById(String, RealmModel) Use the corresponding method from GroupProvider.
org.keycloak.models.GroupProvider.getGroupById(String, RealmModel) Use method getGroupById
org.keycloak.storage.user.UserQueryProvider.getGroupMembers(RealmModel, GroupModel) Use getGroupMembersStream instead.
org.keycloak.storage.user.UserQueryProvider.getGroupMembers(RealmModel, GroupModel, int, int) Use getGroupMembersStream instead.
org.keycloak.models.UserModel.getGroups() Use getGroupsStream instead.
org.keycloak.models.RealmModel.getGroups() Use getGroupsStream instead.
org.keycloak.models.UserModel.getGroups(int, int) Use getGroupsStream instead.
org.keycloak.models.RealmProvider.getGroups(RealmModel) Use the corresponding method from GroupProvider.
org.keycloak.models.GroupProvider.getGroups(RealmModel) Use getGroupsStream instead.
org.keycloak.storage.federated.UserGroupMembershipFederatedStorage.getGroups(RealmModel, String) Use getGroupsStream instead.
org.keycloak.models.UserModel.getGroups(String, int, int) Use getGroupsStream instead.
org.keycloak.models.RealmProvider.getGroupsByRole(RealmModel, RoleModel, int, int) Use the corresponding method from GroupProvider.
org.keycloak.models.GroupProvider.getGroupsByRole(RealmModel, RoleModel, int, int) Use getGroupsByRoleStream instead.
org.keycloak.models.RealmProvider.getGroupsCount(RealmModel, Boolean) Use the corresponding method from GroupProvider.
org.keycloak.models.RealmProvider.getGroupsCountByNameContaining(RealmModel, String) Use the corresponding method from GroupProvider.
org.keycloak.representations.idm.CredentialRepresentation.getHashedSaltedValue()
org.keycloak.credential.CredentialModel.getHashIterations() Recommended to use PasswordCredentialModel.getPasswordCredentialData().getHashIterations()
org.keycloak.representations.idm.CredentialRepresentation.getHashIterations()
org.keycloak.models.KeyManager.getHmacKeys(RealmModel)
org.keycloak.models.KeyManager.getHmacSecretKey(RealmModel, String)
org.keycloak.models.RealmModel.getIdentityProviderMappers() Use getIdentityProviderMappersStream instead.
org.keycloak.models.RealmModel.getIdentityProviderMappersByAlias(String) Use getIdentityProviderMappersByAliasStream instead.
org.keycloak.models.RealmModel.getIdentityProviders() Use getIdentityProvidersStream instead.
org.keycloak.representations.JsonWebToken.getIssuedAt() int will overflow with values after 2038. Use JsonWebToken.getIat() instead.
org.keycloak.models.KeyManager.getKeys(RealmModel) Use getKeysStream instead.
org.keycloak.models.KeyManager.getKeys(RealmModel, KeyUse, String) Use getKeysStream instead.
org.keycloak.storage.federated.UserGroupMembershipFederatedStorage.getMembership(RealmModel, GroupModel, int, int) Use getMembershipStream 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.models.UserSessionProvider.getOfflineUserSessionByBrokerUserId(RealmModel, String) Use getOfflineUserSessionByBrokerUserIdStream instead.
org.keycloak.models.UserSessionProvider.getOfflineUserSessions(RealmModel, ClientModel, int, int) use getOfflineUserSessionsStream instead.
org.keycloak.models.UserSessionProvider.getOfflineUserSessions(RealmModel, UserModel) Use getOfflineUserSessionsStream instead.
org.keycloak.credential.CredentialModel.getPeriod() Recommended to use OTPCredentialModel.getOTPCredentialData().getPeriod()
org.keycloak.representations.idm.CredentialRepresentation.getPeriod()
org.keycloak.models.ProtocolMapperContainerModel.getProtocolMappers() Use getProtocolMappersStream instead.
org.keycloak.models.ClientSessionContext.getProtocolMappers() Use getProtocolMappersStream instead.
org.keycloak.models.KeycloakSession.getProvider(Class<T>, ComponentModel) Deprecated in favor of {@link #getComponentProvider)
org.keycloak.models.KeycloakSessionFactory.getProviderFactories(Class<? extends Provider>) Use getProviderFactoriesStream instead.
org.keycloak.models.RealmProvider.getRealmRole(RealmModel, String) Use the corresponding method from RoleProvider.
org.keycloak.models.RoleMapperModel.getRealmRoleMappings() Use getRealmRoleMappingsStream instead.
org.keycloak.models.RoleProvider.getRealmRoles(RealmModel) use the stream variant instead
org.keycloak.models.RealmProvider.getRealmRoles(RealmModel) Use the corresponding method from RoleProvider.
org.keycloak.models.RealmProvider.getRealmRoles(RealmModel, Integer, Integer) Use the corresponding method from RoleProvider.
org.keycloak.models.RealmProvider.getRealms() Use getRealmsStream instead.
org.keycloak.models.ScopeContainerModel.getRealmScopeMappings() Use getRealmScopeMappingsStream instead.
org.keycloak.models.RealmProvider.getRealmsWithProviderType(Class<?>) Use getRealmsWithProviderTypeStream instead.
org.keycloak.models.RealmModel.getRequiredActionProviders() Use getRequiredActionProvidersStream instead.
org.keycloak.models.UserModel.getRequiredActions() Use getRequiredActionsStream instead.
org.keycloak.storage.federated.UserRequiredActionsFederatedStorage.getRequiredActions(RealmModel, String) Use getRequiredActionsStream instead.
org.keycloak.models.RealmModel.getRequiredCredentials() Use getRequiredCredentialsStream instead.
org.keycloak.representations.idm.RealmRepresentation.getRequiredCredentials()
org.keycloak.migration.MigrationModel.getResourcesTag()
org.keycloak.models.RealmProvider.getRoleById(String, RealmModel) Use the corresponding method from RoleProvider.
org.keycloak.models.RoleMapperModel.getRoleMappings() Use getRoleMappingsStream instead.
org.keycloak.storage.federated.UserRoleMappingsFederatedStorage.getRoleMappings(RealmModel, String) Use getRoleMappingsStream instead.
org.keycloak.storage.user.UserQueryProvider.getRoleMembers(RealmModel, RoleModel) Use getRoleMembersStream instead.
org.keycloak.storage.user.UserQueryProvider.getRoleMembers(RealmModel, RoleModel, int, int) Use getRoleMembersStream instead.
org.keycloak.models.RoleContainerModel.getRoles() Use getRolesStream instead.
org.keycloak.models.ClientSessionContext.getRoles() Use getRolesStream instead.
org.keycloak.models.RoleContainerModel.getRoles(Integer, Integer) Use getRolesStream instead.
org.keycloak.models.RealmModel.getRoleStorageProviders() Use getRoleStorageProvidersStream instead.
org.keycloak.admin.client.resource.RoleResource.getRoleUserMembers() please use RoleResource.getUserMembers()
org.keycloak.admin.client.resource.RoleResource.getRoleUserMembers(Integer, Integer) please use RoleResource.getUserMembers(Integer, Integer)
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.getPasswordSecretData().getSalt()
org.keycloak.representations.idm.CredentialRepresentation.getSalt()
org.keycloak.models.ScopeContainerModel.getScopeMappings() Use getScopeMappingsStream instead.
org.keycloak.representations.idm.RealmRepresentation.getSocialProviders()
org.keycloak.storage.federated.UserFederatedUserCredentialStore.getStoredCredentials(RealmModel, String) Use getStoredCredentialsStream instead.
org.keycloak.credential.UserCredentialStore.getStoredCredentials(RealmModel, UserModel) Use getStoredCredentialsStream instead.
org.keycloak.storage.federated.UserFederatedUserCredentialStore.getStoredCredentialsByType(RealmModel, String, String) Use getStoredCredentialsByTypeStream instead.
org.keycloak.credential.UserCredentialStore.getStoredCredentialsByType(RealmModel, UserModel, String) Use getStoredCredentialsByTypeStream instead.
org.keycloak.storage.federated.UserFederatedStorageProvider.getStoredUsers(RealmModel, int, int) Use getStoredUsersStream instead.
org.keycloak.models.GroupModel.getSubGroups() Use getSubGroupsStream instead.
org.keycloak.models.RealmModel.getSupportedLocales() Use getSupportedLocalesStream instead.
org.keycloak.models.RealmModel.getTopLevelGroups() Use getTopLevelGroups instead.
org.keycloak.models.RealmModel.getTopLevelGroups(Integer, Integer) Use getTopLevelGroupsStream instead.
org.keycloak.models.RealmProvider.getTopLevelGroups(RealmModel) Use the corresponding method from GroupProvider.
org.keycloak.models.GroupProvider.getTopLevelGroups(RealmModel) Use getTopLevelGroupsStream instead.
org.keycloak.models.RealmProvider.getTopLevelGroups(RealmModel, Integer, Integer) Use the corresponding method from GroupProvider.
org.keycloak.models.GroupProvider.getTopLevelGroups(RealmModel, Integer, Integer) Use getTopLevelGroupsStream instead.
org.keycloak.representations.idm.IdentityProviderRepresentation.getUpdateProfileFirstLoginMode() deprecated and replaced by configuration on IdpReviewProfileAuthenticator
org.keycloak.representations.idm.authorization.ResourceRepresentation.getUri()
org.keycloak.storage.user.UserLookupProvider.getUserByEmail(String, RealmModel) Use getUserByEmail instead.
org.keycloak.models.UserProvider.getUserByFederatedIdentity(FederatedIdentityModel, RealmModel) Use getUserByFederatedIdentity instead.
org.keycloak.storage.user.UserLookupProvider.getUserById(String, RealmModel) Use getUserById instead.
org.keycloak.storage.user.UserLookupProvider.getUserByUsername(String, RealmModel) Use getUserByUsername instead.
org.keycloak.models.UserSessionProvider.getUserLoginFailure(RealmModel, String) Use getUserLoginFailure instead.
org.keycloak.storage.user.UserQueryProvider.getUsers(RealmModel) Use getUsersStream instead.
org.keycloak.models.UserProvider.getUsers(RealmModel, boolean) Use getUsersStream instead.
org.keycloak.storage.user.UserQueryProvider.getUsers(RealmModel, int, int) Use getUsersStream instead.
org.keycloak.models.UserProvider.getUsers(RealmModel, int, int, boolean) Use getUsersStream instead.
org.keycloak.storage.federated.UserAttributeFederatedStorage.getUsersByUserAttribute(RealmModel, String, String) Use getUsersByUserAttributeStream instead.
org.keycloak.storage.user.UserQueryProvider.getUsersCount(Map<String, String>, RealmModel) Use getUsersCount instead.
org.keycloak.storage.user.UserQueryProvider.getUsersCount(Map<String, String>, RealmModel, Set<String>) Use getUsersCount instead.
org.keycloak.storage.user.UserQueryProvider.getUsersCount(String, RealmModel) Use getUsersCount
org.keycloak.storage.user.UserQueryProvider.getUsersCount(String, RealmModel, Set<String>) Use getUsersCount instead.
org.keycloak.models.UserSessionProvider.getUserSessionByBrokerUserId(RealmModel, String) Use getUserSessionByBrokerUserIdStream instead.
org.keycloak.models.UserSessionProvider.getUserSessions(RealmModel, ClientModel) Use getUserSessionsStream instead.
org.keycloak.models.UserSessionProvider.getUserSessions(RealmModel, ClientModel, int, int) Use getUserSessionsStream instead.
org.keycloak.models.UserSessionProvider.getUserSessions(RealmModel, UserModel) Use getUserSessionsStream instead.
org.keycloak.models.RealmModel.getUserStorageProviders() Use getUserStorageProvidersStream instead.
org.keycloak.credential.CredentialModel.getValue() Recommended to use PasswordCredentialModel.getPasswordSecretData().getValue() or OTPCredentialModel.getOTPSecretData().getValue()
org.keycloak.models.utils.RoleUtils.hasRoleFromGroup(Iterable<GroupModel>, RoleModel, boolean) Use RoleUtils.hasRoleFromGroup(Stream, RoleModel, boolean) hasRoleFromGroup(Stream, RoleModel, boolean)} instead.
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.storage.StorageId.isLocalStorage(ClientModel) Use StorageId.isLocalStorage(String) instead.
org.keycloak.storage.StorageId.isLocalStorage(UserModel) Use StorageId.isLocalStorage(String) instead.
org.keycloak.models.utils.RoleUtils.isMember(Set<GroupModel>, GroupModel) Use RoleUtils.isMember(Stream, GroupModel) isMember(Stream, GroupModel)} instead.
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.models.RealmProvider.listClientInitialAccess(RealmModel) Use listClientInitialAccessStream instead.
org.keycloak.common.util.ServerCookie.maybeQuote(int, StringBuffer, String) - Not used
org.keycloak.models.RealmProvider.moveGroup(RealmModel, GroupModel, GroupModel) Use the corresponding method from GroupProvider.
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.models.UserSessionProvider.removeAllUserLoginFailures(RealmModel) Use removeAllUserLoginFailures instead.
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.RoleContainerModel.removeDefaultRoles(String...) Default roles are now managed by RealmModel.getDefaultRole(). This method will be removed.
org.keycloak.models.RealmProvider.removeGroup(RealmModel, GroupModel) Use the corresponding method from GroupProvider.
org.keycloak.models.RealmProvider.removeRole(RealmModel, RoleModel) Use the corresponding method from RoleProvider.
org.keycloak.models.UserSessionProvider.removeUserLoginFailure(RealmModel, String) Use removeUserLoginFailure instead.
org.keycloak.admin.client.resource.UserResource.resetPasswordEmail()
org.keycloak.admin.client.resource.UserResource.resetPasswordEmail(String)
org.keycloak.storage.StorageId.resolveProviderId(ClientModel) Use StorageId.providerId(String) instead.
org.keycloak.storage.StorageId.resolveProviderId(UserModel) Use StorageId.providerId(String) instead.
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.RealmModel.searchClientByClientId(String, Integer, Integer) Use searchClientByClientId instead.
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.searchClientsByClientIdStream(org.keycloak.models.RealmModel, java.lang.String, java.lang.Integer, java.lang.Integer) instead.
org.keycloak.models.RealmProvider.searchForClientRoles(RealmModel, ClientModel, String, Integer, Integer) Use the corresponding method from RoleProvider.
org.keycloak.models.RealmProvider.searchForGroupByName(RealmModel, String, Integer, Integer) Use the corresponding method from GroupProvider.
org.keycloak.storage.group.GroupLookupProvider.searchForGroupByName(RealmModel, String, Integer, Integer) Use searchForGroupByNameStream instead.
org.keycloak.models.RealmModel.searchForGroupByName(String, Integer, Integer) Use searchForGroupByName instead.
org.keycloak.models.RealmProvider.searchForRoles(RealmModel, String, Integer, Integer) Use the corresponding method from RoleProvider.
org.keycloak.models.RoleContainerModel.searchForRoles(String, Integer, Integer) Use searchForRolesStream instead.
org.keycloak.storage.user.UserQueryProvider.searchForUser(Map<String, String>, RealmModel) Use searchForUserStream instead.
org.keycloak.storage.user.UserQueryProvider.searchForUser(Map<String, String>, RealmModel, int, int) Use searchForUserStream instead.
org.keycloak.storage.user.UserQueryProvider.searchForUser(String, RealmModel) Use searchForUserStream instead.
org.keycloak.storage.user.UserQueryProvider.searchForUser(String, RealmModel, int, int) Use searchForUserStream instead.
org.keycloak.storage.user.UserQueryProvider.searchForUserByUserAttribute(String, String, RealmModel) Use searchForUserByUserAttributeStream instead.
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.representations.idm.RealmRepresentation.setDefaultRoles(List<String>)
org.keycloak.representations.idm.ClientRepresentation.setDefaultRoles(String[])
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.models.ClientModel.updateClient() Do not use, to be removed
org.keycloak.models.RoleContainerModel.updateDefaultRoles(String...) Default roles are now managed by RealmModel.getDefaultRole(). This method will be removed.
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