## Uses of Class
org.keycloak.models.FederatedIdentityModel

- Packages that use FederatedIdentityModel
  Package | Description
  --- | ---
  org.keycloak.broker.oidc |
  org.keycloak.broker.provider |
  org.keycloak.broker.saml |
  org.keycloak.exportimport.util |
  org.keycloak.forms.account.freemarker.model |
  org.keycloak.models |
  org.keycloak.models.cache.infinispan |
  org.keycloak.models.cache.infinispan.entities |
  org.keycloak.models.cache.infinispan.events |
  org.keycloak.models.jpa |
  org.keycloak.models.map.user |
  org.keycloak.models.utils |
  org.keycloak.social.twitter |
  org.keycloak.storage |
  org.keycloak.storage.federated |
  org.keycloak.storage.jpa |

- - ### Uses of FederatedIdentityModel in org.keycloak.broker.oidc

    Methods in org.keycloak.broker.oidc with parameters of type FederatedIdentityModel
    Modifier and Type | Method and Description
    --- | ---
    `javax.ws.rs.core.Response` | AbstractOAuth2IdentityProvider.`retrieveToken(KeycloakSession session, FederatedIdentityModel identity)`

  - ### Uses of FederatedIdentityModel in org.keycloak.broker.provider

    Methods in org.keycloak.broker.provider with parameters of type FederatedIdentityModel
    Modifier and Type | Method and Description
    --- | ---
    `javax.ws.rs.core.Response` | IdentityProvider.`retrieveToken(KeycloakSession session, FederatedIdentityModel identity)` Returns a `Response` containing the token previously stored during the authentication process for a specific user.

  - ### Uses of FederatedIdentityModel in org.keycloak.broker.saml

    Methods in org.keycloak.broker.saml with parameters of type FederatedIdentityModel
    Modifier and Type | Method and Description
    --- | ---
    `javax.ws.rs.core.Response` | SAMLIdentityProvider.`retrieveToken(KeycloakSession session, FederatedIdentityModel identity)`

  - ### Uses of FederatedIdentityModel in org.keycloak.exportimport.util

    Methods in org.keycloak.exportimport.util with parameters of type FederatedIdentityModel
    Modifier and Type | Method and Description
    --- | ---
    `static FederatedIdentityRepresentation` | ExportUtils.`exportSocialLink(FederatedIdentityModel socialLink)`

  - ### Uses of FederatedIdentityModel in org.keycloak.forms.account.freemarker.model

    Constructors in org.keycloak.forms.account.freemarker.model with parameters of type FederatedIdentityModel
    Constructor and Description
    `FederatedIdentityEntry(FederatedIdentityModel federatedIdentityModel, String displayName, String providerId, String providerName, String guiOrder)`

  - ### Uses of FederatedIdentityModel in org.keycloak.models

    Methods in org.keycloak.models that return FederatedIdentityModel
    Modifier and Type | Method and Description
    --- | ---
    `default FederatedIdentityModel` | UserProvider.`getFederatedIdentity(RealmModel realm, UserModel user, String socialProvider)` Returns details of the association between the user and the socialProvider.
    `FederatedIdentityModel` | UserProvider.Streams.`getFederatedIdentity(RealmModel realm, UserModel user, String socialProvider)`
    `FederatedIdentityModel` | UserProvider.`getFederatedIdentity(UserModel user, String socialProvider, RealmModel realm)` Deprecated. Use `getFederatedIdentity` instead.
    `default FederatedIdentityModel` | UserProvider.Streams.`getFederatedIdentity(UserModel user, String socialProvider, RealmModel realm)`

    Methods in org.keycloak.models that return types with arguments of type FederatedIdentityModel
    Modifier and Type | Method and Description
    --- | ---
    `Set<FederatedIdentityModel>` | UserProvider.`getFederatedIdentities(UserModel user, RealmModel realm)` Deprecated. Use `getFederatedIdentitiesStream` instead.
    `default Set<FederatedIdentityModel>` | UserProvider.Streams.`getFederatedIdentities(UserModel user, RealmModel realm)`
    `default Stream<FederatedIdentityModel>` | UserProvider.`getFederatedIdentitiesStream(RealmModel realm, UserModel user)` Obtains the federated identities of the specified user.
    `Stream<FederatedIdentityModel>` | UserProvider.Streams.`getFederatedIdentitiesStream(RealmModel realm, UserModel user)`

    Methods in org.keycloak.models with parameters of type FederatedIdentityModel
    Modifier and Type | Method and Description
    --- | ---
    `void` | UserProvider.`addFederatedIdentity(RealmModel realm, UserModel user, FederatedIdentityModel socialLink)` Adds a federated identity link for the user within the realm
    `UserModel` | UserProvider.`getUserByFederatedIdentity(FederatedIdentityModel socialLink, RealmModel realm)` Deprecated. Use `getUserByFederatedIdentity` instead.
    `default UserModel` | UserProvider.Streams.`getUserByFederatedIdentity(FederatedIdentityModel socialLink, RealmModel realm)`
    `default UserModel` | UserProvider.`getUserByFederatedIdentity(RealmModel realm, FederatedIdentityModel socialLink)` Returns a userModel that corresponds to the given socialLink.
    `UserModel` | UserProvider.Streams.`getUserByFederatedIdentity(RealmModel realm, FederatedIdentityModel socialLink)`
    `void` | UserProvider.`updateFederatedIdentity(RealmModel realm, UserModel federatedUser, FederatedIdentityModel federatedIdentityModel)` Update details of association between the federatedUser and the idp given by the federatedIdentityModel

    Constructors in org.keycloak.models with parameters of type FederatedIdentityModel
    Constructor and Description
    `FederatedIdentityModel(FederatedIdentityModel originalIdentity, String userId)`

  - ### Uses of FederatedIdentityModel in org.keycloak.models.cache.infinispan

    Methods in org.keycloak.models.cache.infinispan that return FederatedIdentityModel
    Modifier and Type | Method and Description
    --- | ---
    `FederatedIdentityModel` | UserCacheSession.`getFederatedIdentity(RealmModel realm, UserModel user, String socialProvider)`

    Methods in org.keycloak.models.cache.infinispan that return types with arguments of type FederatedIdentityModel
    Modifier and Type | Method and Description
    --- | ---
    `Stream<FederatedIdentityModel>` | UserCacheSession.`getFederatedIdentitiesStream(RealmModel realm, UserModel user)`

    Methods in org.keycloak.models.cache.infinispan with parameters of type FederatedIdentityModel
    Modifier and Type | Method and Description
    --- | ---
    `void` | UserCacheSession.`addFederatedIdentity(RealmModel realm, UserModel user, FederatedIdentityModel socialLink)`
    `UserModel` | UserCacheSession.`getUserByFederatedIdentity(RealmModel realm, FederatedIdentityModel socialLink)`
    `void` | UserCacheSession.`updateFederatedIdentity(RealmModel realm, UserModel federatedUser, FederatedIdentityModel federatedIdentityModel)`

  - ### Uses of FederatedIdentityModel in org.keycloak.models.cache.infinispan.entities

    Methods in org.keycloak.models.cache.infinispan.entities that return types with arguments of type FederatedIdentityModel
    Modifier and Type | Method and Description
    --- | ---
    `Set<FederatedIdentityModel>` | CachedFederatedIdentityLinks.`getFederatedIdentities()`

    Constructor parameters in org.keycloak.models.cache.infinispan.entities with type arguments of type FederatedIdentityModel
    Constructor and Description
    `CachedFederatedIdentityLinks(Long revision, String id, RealmModel realm, Set<FederatedIdentityModel> federatedIdentities)`

  - ### Uses of FederatedIdentityModel in org.keycloak.models.cache.infinispan.events

    Methods in org.keycloak.models.cache.infinispan.events with parameters of type FederatedIdentityModel
    Modifier and Type | Method and Description
    --- | ---
    `static UserFederationLinkRemovedEvent` | UserFederationLinkRemovedEvent.`create(String userId, String realmId, FederatedIdentityModel socialLink)`

    Method parameters in org.keycloak.models.cache.infinispan.events with type arguments of type FederatedIdentityModel
    Modifier and Type | Method and Description
    --- | ---
    `static UserFullInvalidationEvent` | UserFullInvalidationEvent.`create(String userId, String username, String email, String realmId, boolean identityFederationEnabled, Stream<FederatedIdentityModel> federatedIdentities)`

  - ### Uses of FederatedIdentityModel in org.keycloak.models.jpa

    Methods in org.keycloak.models.jpa that return FederatedIdentityModel
    Modifier and Type | Method and Description
    --- | ---
    `FederatedIdentityModel` | JpaUserProvider.`getFederatedIdentity(RealmModel realm, UserModel user, String identityProvider)`

    Methods in org.keycloak.models.jpa that return types with arguments of type FederatedIdentityModel
    Modifier and Type | Method and Description
    --- | ---
    `Stream<FederatedIdentityModel>` | JpaUserProvider.`getFederatedIdentitiesStream(RealmModel realm, UserModel user)`

    Methods in org.keycloak.models.jpa with parameters of type FederatedIdentityModel
    Modifier and Type | Method and Description
    --- | ---
    `void` | JpaUserProvider.`addFederatedIdentity(RealmModel realm, UserModel user, FederatedIdentityModel identity)`
    `UserModel` | JpaUserProvider.`getUserByFederatedIdentity(RealmModel realm, FederatedIdentityModel identity)`
    `void` | JpaUserProvider.`updateFederatedIdentity(RealmModel realm, UserModel federatedUser, FederatedIdentityModel federatedIdentityModel)`

  - ### Uses of FederatedIdentityModel in org.keycloak.models.map.user

    Methods in org.keycloak.models.map.user that return FederatedIdentityModel
    Modifier and Type | Method and Description
    --- | ---
    `FederatedIdentityModel` | MapUserProvider.`getFederatedIdentity(RealmModel realm, UserModel user, String socialProvider)`
    `static FederatedIdentityModel` | UserFederatedIdentityEntity.`toModel(UserFederatedIdentityEntity entity)`

    Methods in org.keycloak.models.map.user that return types with arguments of type FederatedIdentityModel
    Modifier and Type | Method and Description
    --- | ---
    `Stream<FederatedIdentityModel>` | MapUserProvider.`getFederatedIdentitiesStream(RealmModel realm, UserModel user)`

    Methods in org.keycloak.models.map.user with parameters of type FederatedIdentityModel
    Modifier and Type | Method and Description
    --- | ---
    `void` | MapUserProvider.`addFederatedIdentity(RealmModel realm, UserModel user, FederatedIdentityModel socialLink)`
    `static UserFederatedIdentityEntity` | UserFederatedIdentityEntity.`fromModel(FederatedIdentityModel model)`
    `UserModel` | MapUserProvider.`getUserByFederatedIdentity(RealmModel realm, FederatedIdentityModel socialLink)`
    `void` | MapUserProvider.`updateFederatedIdentity(RealmModel realm, UserModel federatedUser, FederatedIdentityModel federatedIdentityModel)`

  - ### Uses of FederatedIdentityModel in org.keycloak.models.utils

    Methods in org.keycloak.models.utils with parameters of type FederatedIdentityModel
    Modifier and Type | Method and Description
    --- | ---
    `static FederatedIdentityRepresentation` | ModelToRepresentation.`toRepresentation(FederatedIdentityModel socialLink)`

  - ### Uses of FederatedIdentityModel in org.keycloak.social.twitter

    Methods in org.keycloak.social.twitter with parameters of type FederatedIdentityModel
    Modifier and Type | Method and Description
    --- | ---
    `javax.ws.rs.core.Response` | TwitterIdentityProvider.`retrieveToken(KeycloakSession session, FederatedIdentityModel identity)`

  - ### Uses of FederatedIdentityModel in org.keycloak.storage

    Methods in org.keycloak.storage that return FederatedIdentityModel
    Modifier and Type | Method and Description
    --- | ---
    `FederatedIdentityModel` | UserStorageManager.`getFederatedIdentity(RealmModel realm, UserModel user, String socialProvider)`

    Methods in org.keycloak.storage that return types with arguments of type FederatedIdentityModel
    Modifier and Type | Method and Description
    --- | ---
    `Stream<FederatedIdentityModel>` | UserStorageManager.`getFederatedIdentitiesStream(RealmModel realm, UserModel user)`

    Methods in org.keycloak.storage with parameters of type FederatedIdentityModel
    Modifier and Type | Method and Description
    --- | ---
    `void` | UserStorageManager.`addFederatedIdentity(RealmModel realm, UserModel user, FederatedIdentityModel socialLink)`
    `UserModel` | UserStorageManager.`getUserByFederatedIdentity(RealmModel realm, FederatedIdentityModel socialLink)`
    `void` | UserStorageManager.`updateFederatedIdentity(RealmModel realm, UserModel federatedUser, FederatedIdentityModel federatedIdentityModel)`

  - ### Uses of FederatedIdentityModel in org.keycloak.storage.federated

    Methods in org.keycloak.storage.federated that return FederatedIdentityModel
    Modifier and Type | Method and Description
    --- | ---
    `FederatedIdentityModel` | UserBrokerLinkFederatedStorage.`getFederatedIdentity(String userId, String socialProvider, RealmModel realm)`

    Methods in org.keycloak.storage.federated that return types with arguments of type FederatedIdentityModel
    Modifier and Type | Method and Description
    --- | ---
    `Set<FederatedIdentityModel>` | UserBrokerLinkFederatedStorage.`getFederatedIdentities(String userId, RealmModel realm)` Deprecated. Use `getFederatedIdentitiesStream` instead.
    `default Set<FederatedIdentityModel>` | UserBrokerLinkFederatedStorage.Streams.`getFederatedIdentities(String userId, RealmModel realm)`
    `default Stream<FederatedIdentityModel>` | UserBrokerLinkFederatedStorage.`getFederatedIdentitiesStream(String userId, RealmModel realm)` Obtains the identities of the federated user identified by `userId`.
    `Stream<FederatedIdentityModel>` | UserBrokerLinkFederatedStorage.Streams.`getFederatedIdentitiesStream(String userId, RealmModel realm)`

    Methods in org.keycloak.storage.federated with parameters of type FederatedIdentityModel
    Modifier and Type | Method and Description
    --- | ---
    `void` | UserBrokerLinkFederatedStorage.`addFederatedIdentity(RealmModel realm, String userId, FederatedIdentityModel socialLink)`
    `String` | UserBrokerLinkFederatedStorage.`getUserByFederatedIdentity(FederatedIdentityModel socialLink, RealmModel realm)`
    `void` | UserBrokerLinkFederatedStorage.`updateFederatedIdentity(RealmModel realm, String userId, FederatedIdentityModel federatedIdentityModel)`

  - ### Uses of FederatedIdentityModel in org.keycloak.storage.jpa

    Methods in org.keycloak.storage.jpa that return FederatedIdentityModel
    Modifier and Type | Method and Description
    --- | ---
    `FederatedIdentityModel` | JpaUserFederatedStorageProvider.`getFederatedIdentity(String userId, String socialProvider, RealmModel realm)`

    Methods in org.keycloak.storage.jpa that return types with arguments of type FederatedIdentityModel
    Modifier and Type | Method and Description
    --- | ---
    `Stream<FederatedIdentityModel>` | JpaUserFederatedStorageProvider.`getFederatedIdentitiesStream(String userId, RealmModel realm)`

    Methods in org.keycloak.storage.jpa with parameters of type FederatedIdentityModel
    Modifier and Type | Method and Description
    --- | ---
    `void` | JpaUserFederatedStorageProvider.`addFederatedIdentity(RealmModel realm, String userId, FederatedIdentityModel link)`
    `String` | JpaUserFederatedStorageProvider.`getUserByFederatedIdentity(FederatedIdentityModel link, RealmModel realm)`
    `void` | JpaUserFederatedStorageProvider.`updateFederatedIdentity(RealmModel realm, String userId, FederatedIdentityModel model)`

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