Package org.keycloak.storage.federated

Interface UserFederatedUserCredentialStore

All Superinterfaces:
org.keycloak.provider.Provider
All Known Subinterfaces:
UserFederatedStorageProvider, UserFederatedStorageProvider.Streams, UserFederatedUserCredentialStore.Streams
public interface UserFederatedUserCredentialStore extends org.keycloak.provider.Provider
Version:
$Revision: 1 $
Author:
Bill Burke

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    UserFederatedUserCredentialStore.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
    org.keycloak.credential.CredentialModel
    createCredential(org.keycloak.models.RealmModel realm, String userId, org.keycloak.credential.CredentialModel cred)
     
    org.keycloak.credential.CredentialModel
    getStoredCredentialById(org.keycloak.models.RealmModel realm, String userId, String id)
     
    org.keycloak.credential.CredentialModel
    getStoredCredentialByNameAndType(org.keycloak.models.RealmModel realm, String userId, String name, String type)
     
    Stream<org.keycloak.credential.CredentialModel>
    getStoredCredentialsByTypeStream(org.keycloak.models.RealmModel realm, String userId, String type)
    Obtains the credentials of type type that are associated with the federated user identified by userId.
    Stream<org.keycloak.credential.CredentialModel>
    getStoredCredentialsStream(org.keycloak.models.RealmModel realm, String userId)
    Obtains the credentials associated with the federated user identified by userId.
    boolean
    removeStoredCredential(org.keycloak.models.RealmModel realm, String userId, String id)
     
    void
    updateCredential(org.keycloak.models.RealmModel realm, String userId, org.keycloak.credential.CredentialModel cred)
     

    Methods inherited from interface org.keycloak.provider.Provider

    close

  • Method Details

    • updateCredential

      void updateCredential(org.keycloak.models.RealmModel realm, String userId, org.keycloak.credential.CredentialModel cred)

    • createCredential

      org.keycloak.credential.CredentialModel createCredential(org.keycloak.models.RealmModel realm, String userId, org.keycloak.credential.CredentialModel cred)

    • removeStoredCredential

      boolean removeStoredCredential(org.keycloak.models.RealmModel realm, String userId, String id)

    • getStoredCredentialById

      org.keycloak.credential.CredentialModel getStoredCredentialById(org.keycloak.models.RealmModel realm, String userId, String id)

    • getStoredCredentialsStream

      Stream<org.keycloak.credential.CredentialModel> getStoredCredentialsStream(org.keycloak.models.RealmModel realm, String userId)
      Obtains the credentials 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 credentials.

    • getStoredCredentialsByTypeStream

      Stream<org.keycloak.credential.CredentialModel> getStoredCredentialsByTypeStream(org.keycloak.models.RealmModel realm, String userId, String type)
      Obtains the credentials of type type that are associated with the federated user identified by userId.
      Parameters:
      realm - a reference to the realm.
      userId - the user identifier.
      type - the credential type.
      Returns:
      a non-null Stream of credentials.

    • getStoredCredentialByNameAndType

      org.keycloak.credential.CredentialModel getStoredCredentialByNameAndType(org.keycloak.models.RealmModel realm, String userId, String name, String type)