Package org.keycloak.storage.federated

Interface UserBrokerLinkFederatedStorage

All Known Subinterfaces:
UserBrokerLinkFederatedStorage.Streams, UserFederatedStorageProvider, UserFederatedStorageProvider.Streams
public interface UserBrokerLinkFederatedStorage
Version:
$Revision: 1 $
Author:
Bill Burke

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    UserBrokerLinkFederatedStorage.Streams
    Deprecated.
    This interface is no longer necessary; collection-based methods were removed from the parent interface and therefore the parent interface can be used directly

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addFederatedIdentity(org.keycloak.models.RealmModel realm, String userId, org.keycloak.models.FederatedIdentityModel socialLink)
     
    Stream<org.keycloak.models.FederatedIdentityModel>
    getFederatedIdentitiesStream(String userId, org.keycloak.models.RealmModel realm)
    Obtains the identities of the federated user identified by userId.
    org.keycloak.models.FederatedIdentityModel
    getFederatedIdentity(String userId, String socialProvider, org.keycloak.models.RealmModel realm)
     
    String
    getUserByFederatedIdentity(org.keycloak.models.FederatedIdentityModel socialLink, org.keycloak.models.RealmModel realm)
     
    void
    preRemove(org.keycloak.models.RealmModel realm, org.keycloak.models.IdentityProviderModel provider)
     
    boolean
    removeFederatedIdentity(org.keycloak.models.RealmModel realm, String userId, String socialProvider)
     
    void
    updateFederatedIdentity(org.keycloak.models.RealmModel realm, String userId, org.keycloak.models.FederatedIdentityModel federatedIdentityModel)
     

  • Method Details

    • getUserByFederatedIdentity

      String getUserByFederatedIdentity(org.keycloak.models.FederatedIdentityModel socialLink, org.keycloak.models.RealmModel realm)

    • addFederatedIdentity

      void addFederatedIdentity(org.keycloak.models.RealmModel realm, String userId, org.keycloak.models.FederatedIdentityModel socialLink)

    • removeFederatedIdentity

      boolean removeFederatedIdentity(org.keycloak.models.RealmModel realm, String userId, String socialProvider)

    • preRemove

      void preRemove(org.keycloak.models.RealmModel realm, org.keycloak.models.IdentityProviderModel provider)

    • updateFederatedIdentity

      void updateFederatedIdentity(org.keycloak.models.RealmModel realm, String userId, org.keycloak.models.FederatedIdentityModel federatedIdentityModel)

    • getFederatedIdentitiesStream

      Stream<org.keycloak.models.FederatedIdentityModel> getFederatedIdentitiesStream(String userId, org.keycloak.models.RealmModel realm)
      Obtains the identities of the federated user identified by userId.
      Parameters:
      userId - the user identifier.
      realm - a reference to the realm.
      Returns:
      a non-null Stream of federated identities associated with the user.

    • getFederatedIdentity

      org.keycloak.models.FederatedIdentityModel getFederatedIdentity(String userId, String socialProvider, org.keycloak.models.RealmModel realm)