Package org.keycloak.storage.federated

Interface UserConsentFederatedStorage

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

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    UserConsentFederatedStorage.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
    addConsent(org.keycloak.models.RealmModel realm, String userId, org.keycloak.models.UserConsentModel consent)
     
    org.keycloak.models.UserConsentModel
    getConsentByClient(org.keycloak.models.RealmModel realm, String userId, String clientInternalId)
     
    Stream<org.keycloak.models.UserConsentModel>
    getConsentsStream(org.keycloak.models.RealmModel realm, String userId)
    Obtains the consents associated with the federated user identified by userId.
    boolean
    revokeConsentForClient(org.keycloak.models.RealmModel realm, String userId, String clientInternalId)
     
    void
    updateConsent(org.keycloak.models.RealmModel realm, String userId, org.keycloak.models.UserConsentModel consent)
     

  • Method Details

    • addConsent

      void addConsent(org.keycloak.models.RealmModel realm, String userId, org.keycloak.models.UserConsentModel consent)

    • getConsentByClient

      org.keycloak.models.UserConsentModel getConsentByClient(org.keycloak.models.RealmModel realm, String userId, String clientInternalId)

    • getConsentsStream

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

    • updateConsent

      void updateConsent(org.keycloak.models.RealmModel realm, String userId, org.keycloak.models.UserConsentModel consent)

    • revokeConsentForClient

      boolean revokeConsentForClient(org.keycloak.models.RealmModel realm, String userId, String clientInternalId)