Deprecated API

Contents

• Classes
• Fields
• Methods

Classes

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

Fields

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

Methods

Method	Description
org.keycloak.credential.CredentialInputUpdater.getDisableableCredentialTypes(RealmModel, UserModel)	Use getDisableableCredentialTypesStream instead.
org.keycloak.credential.CredentialModel.getAlgorithm()	Recommended to use PasswordCredentialModel.getPasswordCredentialData().getAlgorithm() or OTPCredentialModel.getOTPCredentialData().getAlgorithm()
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.getOTPCredentialData().getCounter()
org.keycloak.credential.CredentialModel.getDevice()	Recommended to use OTPCredentialModel.getOTPCredentialData().getDevice()
org.keycloak.credential.CredentialModel.getDigits()	Recommended to use OTPCredentialModel.getOTPCredentialData().getDigits()
org.keycloak.credential.CredentialModel.getHashIterations()	Recommended to use PasswordCredentialModel.getPasswordCredentialData().getHashIterations()
org.keycloak.credential.CredentialModel.getPeriod()	Recommended to use OTPCredentialModel.getOTPCredentialData().getPeriod()
org.keycloak.credential.CredentialModel.getSalt()	Recommended to use PasswordCredentialModel.getPasswordSecretData().getSalt()
org.keycloak.credential.CredentialModel.getValue()	Recommended to use PasswordCredentialModel.getPasswordSecretData().getValue() or OTPCredentialModel.getOTPSecretData().getValue()
org.keycloak.credential.CredentialModel.setAlgorithm(String)	See CredentialModel.getAlgorithm()
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.credential.hash.PasswordHashProvider.encode(String, int, CredentialModel)	Exists due the backwards compatibility. It is recommended to use PasswordHashProvider.encodedCredential(String, int)}
org.keycloak.credential.hash.PasswordHashProvider.policyCheck(PasswordPolicy, CredentialModel)	Exists due the backwards compatibility. It is recommended to use PasswordHashProvider.policyCheck(PasswordPolicy, PasswordCredentialModel)
org.keycloak.credential.hash.PasswordHashProvider.verify(String, CredentialModel)	Exists due the backwards compatibility. It is recommended to use PasswordHashProvider.verify(String, PasswordCredentialModel)
org.keycloak.credential.UserCredentialStore.getStoredCredentials(RealmModel, UserModel)	Use getStoredCredentialsStream instead.
org.keycloak.credential.UserCredentialStore.getStoredCredentialsByType(RealmModel, UserModel, String)	Use getStoredCredentialsByTypeStream instead.
org.keycloak.migration.MigrationModel.getResourcesTag()
org.keycloak.models.ClientModel.updateClient()	Do not use, to be removed
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.ClientProvider.getAlwaysDisplayInConsoleClients(RealmModel)	use the stream variant instead
org.keycloak.models.ClientProvider.getClients(RealmModel, Integer, Integer)	use the stream variant instead
org.keycloak.models.ClientProvider.removeClient(String, RealmModel)	Use ClientProvider.removeClient(RealmModel, String) instead.
org.keycloak.models.ClientSessionContext.getClientScopes()	Use getClientScopesStream instead.
org.keycloak.models.ClientSessionContext.getProtocolMappers()	Use getProtocolMappersStream instead.
org.keycloak.models.ClientSessionContext.getRoles()	Use getRolesStream instead.
org.keycloak.models.GroupModel.getAttribute(String)	Use getAttributeStream instead.
org.keycloak.models.GroupModel.getSubGroups()	Use getSubGroupsStream instead.
org.keycloak.models.GroupProvider.getGroupById(String, RealmModel)	Use method getGroupById
org.keycloak.models.GroupProvider.getGroups(RealmModel)	Use getGroupsStream instead.
org.keycloak.models.GroupProvider.getGroupsByRole(RealmModel, RoleModel, int, int)	Use getGroupsByRoleStream instead.
org.keycloak.models.GroupProvider.getTopLevelGroups(RealmModel)	Use getTopLevelGroupsStream instead.
org.keycloak.models.IdentityProviderModel.isAuthenticateByDefault()
org.keycloak.models.IdentityProviderModel.setAuthenticateByDefault(boolean)
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.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.models.KeyManager.getHmacKeys(RealmModel)
org.keycloak.models.KeyManager.getHmacSecretKey(RealmModel, String)
org.keycloak.models.KeyManager.getKeys(RealmModel)	Use getKeysStream instead.
org.keycloak.models.KeyManager.getRsaCertificate(RealmModel, String)
org.keycloak.models.KeyManager.getRsaKeys(RealmModel)
org.keycloak.models.KeyManager.getRsaPublicKey(RealmModel, String)
org.keycloak.models.ProtocolMapperContainerModel.getProtocolMappers()	Use getProtocolMappersStream instead.
org.keycloak.models.RealmModel.getAlwaysDisplayInConsoleClients()	Use getAlwaysDisplayInConsoleClientsStream 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.models.RealmModel.getClients()	Use getClientsStream instead.
org.keycloak.models.RealmModel.getClientScopes()	Use getClientScopesStream instead.
org.keycloak.models.RealmModel.getClientStorageProviders()	Use getClientStorageProvidersStream instead.
org.keycloak.models.RealmModel.getComponents(String, String)	Use getComponentsStream instead.
org.keycloak.models.RealmModel.getDefaultClientScopes(boolean)	Use getDefaultClientScopesStream instead.
org.keycloak.models.RealmModel.getDefaultGroups()	Use getDefaultGroupsStream instead.
org.keycloak.models.RealmModel.getEnabledEventTypes()	Use getEnabledEventTypesStream instead.
org.keycloak.models.RealmModel.getEventsListeners()	Use getEventsListenersStream instead.
org.keycloak.models.RealmModel.getGroups()	Use getGroupsStream instead.
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.models.RealmModel.getRequiredActionProviders()	Use getRequiredActionProvidersStream instead.
org.keycloak.models.RealmModel.getRequiredCredentials()	Use getRequiredCredentialsStream instead.
org.keycloak.models.RealmModel.getRoleStorageProviders()	Use getRoleStorageProvidersStream instead.
org.keycloak.models.RealmModel.getSupportedLocales()	Use getSupportedLocalesStream instead.
org.keycloak.models.RealmModel.getTopLevelGroups()	Use getTopLevelGroups instead.
org.keycloak.models.RealmModel.getUserStorageProviders()	Use getUserStorageProvidersStream instead.
org.keycloak.models.RealmModel.searchClientByClientId(String, Integer, Integer)	Use searchClientByClientId instead.
org.keycloak.models.RealmModel.searchForGroupByName(String, Integer, Integer)	Use searchForGroupByName instead.
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.addRealmRole(RealmModel, String)	Use the corresponding method from RoleProvider.
org.keycloak.models.RealmProvider.addTopLevelGroup(RealmModel, GroupModel)	Use the corresponding method from GroupProvider.
org.keycloak.models.RealmProvider.createGroup(RealmModel, String)	Use the corresponding method from GroupProvider.
org.keycloak.models.RealmProvider.getAlwaysDisplayInConsoleClients(RealmModel)	Use the corresponding method from ClientProvider.
org.keycloak.models.RealmProvider.getClientByClientId(String, RealmModel)	Use the corresponding method from ClientProvider.
org.keycloak.models.RealmProvider.getClientById(String, RealmModel)	Use the corresponding method from ClientProvider.
org.keycloak.models.RealmProvider.getClientRole(RealmModel, ClientModel, String)	Use the corresponding method from RoleProvider.
org.keycloak.models.RealmProvider.getClientRoles(RealmModel, ClientModel)	Use the corresponding method from RoleProvider.
org.keycloak.models.RealmProvider.getClients(RealmModel)	Use the corresponding method from ClientProvider.
org.keycloak.models.RealmProvider.getClientScopeById(String, RealmModel)	Use the corresponding method from ClientScopeProvider.
org.keycloak.models.RealmProvider.getClientsCount(RealmModel)	Use the corresponding method from ClientProvider.
org.keycloak.models.RealmProvider.getGroupById(RealmModel, String)	Use the corresponding method from GroupProvider.
org.keycloak.models.RealmProvider.getGroups(RealmModel)	Use the corresponding method from GroupProvider.
org.keycloak.models.RealmProvider.getGroupsByRole(RealmModel, RoleModel, int, int)	Use the corresponding method from GroupProvider.
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.models.RealmProvider.getRealmRole(RealmModel, String)	Use the corresponding method from RoleProvider.
org.keycloak.models.RealmProvider.getRealmRoles(RealmModel)	Use the corresponding method from RoleProvider.
org.keycloak.models.RealmProvider.getRealms()	Use getRealmsStream instead.
org.keycloak.models.RealmProvider.getRealmsWithProviderType(Class<?>)	Use getRealmsWithProviderTypeStream instead.
org.keycloak.models.RealmProvider.getRoleById(String, RealmModel)	Use the corresponding method from RoleProvider.
org.keycloak.models.RealmProvider.getTopLevelGroups(RealmModel)	Use the corresponding method from GroupProvider.
org.keycloak.models.RealmProvider.listClientInitialAccess(RealmModel)	Use listClientInitialAccessStream instead.
org.keycloak.models.RealmProvider.moveGroup(RealmModel, GroupModel, GroupModel)	Use the corresponding method from GroupProvider.
org.keycloak.models.RealmProvider.removeClient(String, RealmModel)	Use the corresponding method from ClientProvider.
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.RealmProvider.searchClientsByClientId(String, Integer, Integer, RealmModel)	Use the corresponding method from ClientProvider.
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.models.RealmProvider.searchForRoles(RealmModel, String, Integer, Integer)	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.RoleContainerModel.getDefaultRoles()	Default roles are now managed by RealmModel.getDefaultRole(). This method will be removed.
org.keycloak.models.RoleContainerModel.getDefaultRolesStream()	Default roles are now managed by RealmModel.getDefaultRole(). This method will be removed.
org.keycloak.models.RoleContainerModel.getRoles()	Use getRolesStream instead.
org.keycloak.models.RoleContainerModel.removeDefaultRoles(String...)	Default roles are now managed by RealmModel.getDefaultRole(). This method will be removed.
org.keycloak.models.RoleContainerModel.searchForRoles(String, Integer, Integer)	Use searchForRolesStream instead.
org.keycloak.models.RoleContainerModel.updateDefaultRoles(String...)	Default roles are now managed by RealmModel.getDefaultRole(). This method will be removed.
org.keycloak.models.RoleMapperModel.getClientRoleMappings(ClientModel)	Use getClientRoleMappingsStream instead.
org.keycloak.models.RoleMapperModel.getRealmRoleMappings()	Use getRealmRoleMappingsStream instead.
org.keycloak.models.RoleMapperModel.getRoleMappings()	Use getRoleMappingsStream instead.
org.keycloak.models.RoleModel.getAttribute(String)	Use getAttributeStream instead.
org.keycloak.models.RoleModel.getComposites()	Use getCompositesStream instead.
org.keycloak.models.RoleProvider.getRealmRoles(RealmModel)	use the stream variant instead
org.keycloak.models.ScopeContainerModel.getRealmScopeMappings()	Use getRealmScopeMappingsStream instead.
org.keycloak.models.ScopeContainerModel.getScopeMappings()	Use getScopeMappingsStream instead.
org.keycloak.models.UserCredentialManager.getConfiguredUserStorageCredentialTypes(RealmModel, UserModel)	Use getConfiguredUserStorageCredentialTypesStream instead.
org.keycloak.models.UserCredentialManager.getDisableableCredentialTypes(RealmModel, UserModel)	Use getDisableableCredentialTypesStream instead.
org.keycloak.models.UserCredentialModel.isOtp(String)
org.keycloak.models.UserCredentialModel.passwordToken(String)
org.keycloak.models.UserModel.getAttribute(String)	Use getAttributeStream instead.
org.keycloak.models.UserModel.getGroups()	Use getGroupsStream instead.
org.keycloak.models.UserModel.getRequiredActions()	Use getRequiredActionsStream instead.
org.keycloak.models.UserProvider.getConsents(RealmModel, String)	Use getConsentsStream instead.
org.keycloak.models.UserProvider.getFederatedIdentities(UserModel, RealmModel)	Use getFederatedIdentitiesStream instead.
org.keycloak.models.UserProvider.getFederatedIdentity(UserModel, String, RealmModel)	Use getFederatedIdentity instead.
org.keycloak.models.UserProvider.getUserByFederatedIdentity(FederatedIdentityModel, RealmModel)	Use getUserByFederatedIdentity instead.
org.keycloak.models.UserProvider.getUsers(RealmModel, boolean)	Use getUsersStream instead.
org.keycloak.models.UserSessionProvider.addUserLoginFailure(RealmModel, String)	Use addUserLoginFailure instead.
org.keycloak.models.UserSessionProvider.getClientSession(UserSessionModel, ClientModel, UUID, boolean)	Use UserSessionProvider.getClientSession(UserSessionModel, ClientModel, String, boolean) instead.
org.keycloak.models.UserSessionProvider.getOfflineUserSessionByBrokerUserId(RealmModel, String)	Use getOfflineUserSessionByBrokerUserIdStream instead.
org.keycloak.models.UserSessionProvider.getOfflineUserSessions(RealmModel, UserModel)	Use getOfflineUserSessionsStream instead.
org.keycloak.models.UserSessionProvider.getUserLoginFailure(RealmModel, String)	Use getUserLoginFailure instead.
org.keycloak.models.UserSessionProvider.getUserSessionByBrokerUserId(RealmModel, String)	Use getUserSessionByBrokerUserIdStream instead.
org.keycloak.models.UserSessionProvider.getUserSessions(RealmModel, UserModel)	Use getUserSessionsStream instead.
org.keycloak.models.UserSessionProvider.removeAllUserLoginFailures(RealmModel)	Use removeAllUserLoginFailures instead.
org.keycloak.models.UserSessionProvider.removeUserLoginFailure(RealmModel, String)	Use removeUserLoginFailure instead.
org.keycloak.models.utils.RoleUtils.hasRoleFromGroup(Iterable<GroupModel>, RoleModel, boolean)	Use RoleUtils.hasRoleFromGroup(Stream, RoleModel, boolean) hasRoleFromGroup(Stream, RoleModel, boolean)} instead.
org.keycloak.models.utils.RoleUtils.isMember(Set<GroupModel>, GroupModel)	Use RoleUtils.isMember(Stream, GroupModel) isMember(Stream, GroupModel)} instead.
org.keycloak.sessions.AuthenticationSessionProvider.createRootAuthenticationSession(String, RealmModel)	Use AuthenticationSessionProvider.createRootAuthenticationSession(RealmModel, String) createRootAuthenticationSession} instead.
org.keycloak.storage.client.ClientLookupProvider.getClientByClientId(String, RealmModel)	Use ClientLookupProvider.getClientByClientId(org.keycloak.models.RealmModel, java.lang.String) instead.
org.keycloak.storage.client.ClientLookupProvider.getClientById(String, RealmModel)	Use ClientLookupProvider.getClientById(org.keycloak.models.RealmModel, java.lang.String) instead.
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.storage.federated.UserAttributeFederatedStorage.getUsersByUserAttribute(RealmModel, String, String)	Use getUsersByUserAttributeStream instead.
org.keycloak.storage.federated.UserBrokerLinkFederatedStorage.getFederatedIdentities(String, RealmModel)	Use getFederatedIdentitiesStream instead.
org.keycloak.storage.federated.UserConsentFederatedStorage.getConsents(RealmModel, String)	Use getConsentsStream instead.
org.keycloak.storage.federated.UserFederatedStorageProvider.getStoredUsers(RealmModel, int, int)	Use getStoredUsersStream instead.
org.keycloak.storage.federated.UserFederatedUserCredentialStore.getStoredCredentials(RealmModel, String)	Use getStoredCredentialsStream instead.
org.keycloak.storage.federated.UserFederatedUserCredentialStore.getStoredCredentialsByType(RealmModel, String, String)	Use getStoredCredentialsByTypeStream instead.
org.keycloak.storage.federated.UserGroupMembershipFederatedStorage.getGroups(RealmModel, String)	Use getGroupsStream instead.
org.keycloak.storage.federated.UserGroupMembershipFederatedStorage.getMembership(RealmModel, GroupModel, int, int)	Use getMembershipStream instead.
org.keycloak.storage.federated.UserRequiredActionsFederatedStorage.getRequiredActions(RealmModel, String)	Use getRequiredActionsStream instead.
org.keycloak.storage.federated.UserRoleMappingsFederatedStorage.getRoleMappings(RealmModel, String)	Use getRoleMappingsStream instead.
org.keycloak.storage.group.GroupLookupProvider.searchForGroupByName(RealmModel, String, Integer, Integer)	Use searchForGroupByNameStream instead.
org.keycloak.storage.StorageId.isLocalStorage(UserModel)	Use StorageId.isLocalStorage(String) instead.
org.keycloak.storage.StorageId.resolveProviderId(UserModel)	Use StorageId.providerId(String) instead.
org.keycloak.storage.user.UserLookupProvider.getUserByEmail(String, RealmModel)	Use getUserByEmail 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.storage.user.UserQueryProvider.getGroupMembers(RealmModel, GroupModel)	Use getGroupMembersStream instead.
org.keycloak.storage.user.UserQueryProvider.getRoleMembers(RealmModel, RoleModel)	Use getRoleMembersStream instead.
org.keycloak.storage.user.UserQueryProvider.getUsers(RealmModel)	Use getUsersStream instead.
org.keycloak.storage.user.UserQueryProvider.getUsersCount(String, RealmModel)	Use getUsersCount
org.keycloak.storage.user.UserQueryProvider.searchForUser(String, RealmModel)	Use searchForUserStream instead.
org.keycloak.storage.user.UserQueryProvider.searchForUserByUserAttribute(String, String, RealmModel)	Use searchForUserByUserAttributeStream instead.