Skip navigation links
Keycloak Server Private SPI 26.3.3
  • Overview
  • Package
  • Class
  • Use
  • Tree
  • Deprecated
  • Index
  • Help

Deprecated API

Contents

  • Terminally Deprecated
  • Classes
  • Enum Classes
  • Fields
  • Methods
  • Enum Constants
  • Terminally Deprecated Elements
    Element
    Description
    org.keycloak.authentication.RequiredActionProvider.getMaxAuthAge()
    in favor of RequiredActionProvider.getMaxAuthAge(KeycloakSession) to support individual configuration of max auth age for all required actions. This method has no effect anymore. Defines the max time after a user login, after which re-authentication is requested for an AIA. 0 means that re-authentication is always requested. On default uses configured max_auth_age value from the required action config. If not configured, it uses the default max_auth_age value from the KeycloakConstants class.
    org.keycloak.cluster.ClusterProvider.DCNotify
    For removal in Keycloak 27.
    org.keycloak.cluster.ClusterProvider.notify(String, Collection<? extends ClusterEvent>, boolean, ClusterProvider.DCNotify)
    use ClusterProvider.notify(String, Collection, boolean) instead. ClusterProvider.DCNotify is deprecated. For removal in Keycloak 27.
    org.keycloak.cluster.ClusterProvider.notify(String, ClusterEvent, boolean, ClusterProvider.DCNotify)
    use ClusterProvider.notify(String, ClusterEvent, boolean) instead. ClusterProvider.DCNotify is deprecated. For removal in Keycloak 27.
  • Deprecated Classes
    Class
    Description
    org.keycloak.credential.hash.Pbkdf2PasswordHashProviderFactory
    The PBKDF2 provider with SHA1 and the recommended number of 1.300.000 iterations is known to be very slow. We recommend to use the PBKDF2 variants with SHA256 or SHA512 instead.
    org.keycloak.policy.RecoveryCodesWarningThresholdPasswordPolicyProviderFactory
    Please use rather the recovery codes required action to configure warning threshold for recovery codes. This password policy may be removed in the future versions.
    org.keycloak.storage.ImportRealmFromRepresentationEvent
    org.keycloak.storage.PartialImportRealmFromRepresentationEvent
  • Deprecated Enum Classes
    Enum Class
    Description
    org.keycloak.cluster.ClusterProvider.DCNotify
    For removal in Keycloak 27.
  • Deprecated Fields
    Field
    Description
    org.keycloak.models.BrowserSecurityHeaders.realmDefaultHeaders
    org.keycloak.models.LDAPConstants.USE_TRUSTSTORE_LDAPS_ONLY
    Use LDAPConstants.USE_TRUSTSTORE_ALWAYS instead.
  • Deprecated Methods
    Method
    Description
    org.keycloak.authentication.RequiredActionProvider.getMaxAuthAge()
    in favor of RequiredActionProvider.getMaxAuthAge(KeycloakSession) to support individual configuration of max auth age for all required actions. This method has no effect anymore. Defines the max time after a user login, after which re-authentication is requested for an AIA. 0 means that re-authentication is always requested. On default uses configured max_auth_age value from the required action config. If not configured, it uses the default max_auth_age value from the KeycloakConstants class.
    org.keycloak.broker.provider.BrokeredIdentityContext.setName(String)
    use BrokeredIdentityContext.setFirstName(String) and BrokeredIdentityContext.setLastName(String) instead
    org.keycloak.cluster.ClusterProvider.notify(String, Collection<? extends ClusterEvent>, boolean, ClusterProvider.DCNotify)
    use ClusterProvider.notify(String, Collection, boolean) instead. ClusterProvider.DCNotify is deprecated. For removal in Keycloak 27.
    org.keycloak.cluster.ClusterProvider.notify(String, ClusterEvent, boolean, ClusterProvider.DCNotify)
    use ClusterProvider.notify(String, ClusterEvent, boolean) instead. ClusterProvider.DCNotify is deprecated. For removal in Keycloak 27.
    org.keycloak.component.AmphibianProviderFactory.create(KeycloakSession, ComponentModel)
    org.keycloak.connections.httpclient.HttpClientProvider.get(String)
    For String content, use HttpClientProvider.getString(String), for binary data use HttpClientProvider.getInputStream(String). To be removed in Keycloak 27.
    org.keycloak.events.admin.AdminEventQuery.fromTime(Date)
    org.keycloak.events.admin.AdminEventQuery.toTime(Date)
    org.keycloak.events.EventQuery.fromDate(Date)
    org.keycloak.events.EventQuery.toDate(Date)
    org.keycloak.events.EventStoreProvider.clear()
    Unused method. Currently, used only in the testsuite
    org.keycloak.events.EventStoreProvider.clearAdmin()
    Unused method. Currently, used only in the testsuite
    org.keycloak.events.EventStoreProvider.clearExpiredEvents()
    This method is problem from the performance perspective. Some storages can provide better way for doing this (e.g. entry lifespan in the Infinispan server, etc.). We need to leave solving event expiration to each storage provider separately using expiration field on entity level.
    org.keycloak.models.UserSessionProviderFactory.loadPersistentSessions(KeycloakSessionFactory, int, int)
    org.keycloak.models.utils.ModelToRepresentation.toGroupHierarchy(GroupModel, boolean)
    org.keycloak.models.utils.ModelToRepresentation.toGroupHierarchy(GroupModel, boolean, String)
    org.keycloak.models.utils.ModelToRepresentation.toGroupHierarchy(GroupModel, boolean, String, Boolean)
    org.keycloak.models.utils.ModelToRepresentation.toGroupHierarchy(KeycloakSession, RealmModel, boolean)
    org.keycloak.models.utils.RealmModelDelegate.getTopLevelGroupsStream()
    org.keycloak.models.utils.RealmModelDelegate.getTopLevelGroupsStream(Integer, Integer)
  • Deprecated Enum Constants
    Enum Constant
    Description
    org.keycloak.cookie.CookieScope.LEGACY
    org.keycloak.cookie.CookieScope.LEGACY_JS
    org.keycloak.events.EventType.REMOVE_TOTP
    org.keycloak.events.EventType.REMOVE_TOTP_ERROR
    org.keycloak.events.EventType.UPDATE_PASSWORD
    org.keycloak.events.EventType.UPDATE_PASSWORD_ERROR
    org.keycloak.events.EventType.UPDATE_TOTP
    org.keycloak.events.EventType.UPDATE_TOTP_ERROR
    org.keycloak.events.EventType.VALIDATE_ACCESS_TOKEN
    see KEYCLOAK-2266
    org.keycloak.events.EventType.VALIDATE_ACCESS_TOKEN_ERROR

Copyright © 2025 JBoss by Red Hat. All rights reserved.