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

- Packages that use UserFederationProviderModel
  Package | Description
  --- | ---
  org.keycloak.federation.kerberos |
  org.keycloak.federation.ldap |
  org.keycloak.federation.ldap.kerberos |
  org.keycloak.federation.ldap.mappers |
  org.keycloak.federation.ldap.mappers.membership.group |
  org.keycloak.federation.ldap.mappers.membership.role |
  org.keycloak.federation.ldap.mappers.msad |
  org.keycloak.mappers |
  org.keycloak.models |
  org.keycloak.models.cache.infinispan |
  org.keycloak.models.cache.infinispan.entities |
  org.keycloak.models.jpa |
  org.keycloak.models.mongo.keycloak.adapters |
  org.keycloak.models.utils |
  org.keycloak.services.managers |
  org.keycloak.services.resources.admin |
  org.keycloak.storage |
  org.keycloak.storage.federated |
  org.keycloak.storage.jpa |

- - ### Uses of UserFederationProviderModel in org.keycloak.federation.kerberos

    Fields in org.keycloak.federation.kerberos declared as UserFederationProviderModel
    Modifier and Type | Field and Description
    --- | ---
    `protected UserFederationProviderModel` | KerberosFederationProvider.`model`

    Methods in org.keycloak.federation.kerberos with parameters of type UserFederationProviderModel
    Modifier and Type | Method and Description
    --- | ---
    `UserFederationProvider` | KerberosFederationProviderFactory.`getInstance(KeycloakSession session, UserFederationProviderModel model)`
    `UserFederationSyncResult` | KerberosFederationProviderFactory.`syncAllUsers(KeycloakSessionFactory sessionFactory, String realmId, UserFederationProviderModel model)`
    `UserFederationSyncResult` | KerberosFederationProviderFactory.`syncChangedUsers(KeycloakSessionFactory sessionFactory, String realmId, UserFederationProviderModel model, Date lastSync)`

    Constructors in org.keycloak.federation.kerberos with parameters of type UserFederationProviderModel
    Constructor and Description
    `CommonKerberosConfig(UserFederationProviderModel userFederationProvider)`
    `KerberosConfig(UserFederationProviderModel userFederationProvider)`
    `KerberosFederationProvider(KeycloakSession session, UserFederationProviderModel model, KerberosFederationProviderFactory factory)`

  - ### Uses of UserFederationProviderModel in org.keycloak.federation.ldap

    Fields in org.keycloak.federation.ldap declared as UserFederationProviderModel
    Modifier and Type | Field and Description
    --- | ---
    `protected UserFederationProviderModel` | LDAPFederationProvider.`model`

    Methods in org.keycloak.federation.ldap that return UserFederationProviderModel
    Modifier and Type | Method and Description
    --- | ---
    `UserFederationProviderModel` | LDAPFederationProvider.`getModel()`

    Methods in org.keycloak.federation.ldap with parameters of type UserFederationProviderModel
    Modifier and Type | Method and Description
    --- | ---
    `LDAPFederationProvider` | LDAPFederationProviderFactory.`getInstance(KeycloakSession session, UserFederationProviderModel model)`
    `LDAPIdentityStore` | LDAPIdentityStoreRegistry.`getLdapStore(UserFederationProviderModel model)`
    `protected UserFederationSyncResult` | LDAPFederationProviderFactory.`importLdapUsers(KeycloakSessionFactory sessionFactory, String realmId, UserFederationProviderModel fedModel, List<LDAPObject> ldapUsers)`
    `void` | LDAPFederationProviderFactory.`onProviderModelCreated(RealmModel realm, UserFederationProviderModel newProviderModel)`
    `UserFederationSyncResult` | LDAPFederationProviderFactory.`syncAllUsers(KeycloakSessionFactory sessionFactory, String realmId, UserFederationProviderModel model)`
    `UserFederationSyncResult` | LDAPFederationProviderFactory.`syncChangedUsers(KeycloakSessionFactory sessionFactory, String realmId, UserFederationProviderModel model, Date lastSync)`
    `protected UserFederationSyncResult` | LDAPFederationProviderFactory.`syncImpl(KeycloakSessionFactory sessionFactory, LDAPQuery userQuery, String realmId, UserFederationProviderModel fedModel)`
    `protected void` | LDAPFederationProviderFactory.`syncMappers(KeycloakSessionFactory sessionFactory, String realmId, UserFederationProviderModel model)`
    `void` | LDAPFederationProviderFactory.`validateConfig(RealmModel realm, UserFederationProviderModel providerModel)`

    Constructors in org.keycloak.federation.ldap with parameters of type UserFederationProviderModel
    Constructor and Description
    `LDAPFederationProvider(LDAPFederationProviderFactory factory, KeycloakSession session, UserFederationProviderModel model, LDAPIdentityStore ldapIdentityStore)`

  - ### Uses of UserFederationProviderModel in org.keycloak.federation.ldap.kerberos

    Constructors in org.keycloak.federation.ldap.kerberos with parameters of type UserFederationProviderModel
    Constructor and Description
    `LDAPProviderKerberosConfig(UserFederationProviderModel userFederationProvider)`

  - ### Uses of UserFederationProviderModel in org.keycloak.federation.ldap.mappers

    Methods in org.keycloak.federation.ldap.mappers with parameters of type UserFederationProviderModel
    Modifier and Type | Method and Description
    --- | ---
    `Map<String,String>` | UserAttributeLDAPFederationMapperFactory.`getDefaultConfig(UserFederationProviderModel providerModel)`
    `Map<String,String>` | HardcodedLDAPRoleMapperFactory.`getDefaultConfig(UserFederationProviderModel providerModel)`
    `Map<String,String>` | FullNameLDAPFederationMapperFactory.`getDefaultConfig(UserFederationProviderModel providerModel)`
    `void` | UserAttributeLDAPFederationMapperFactory.`validateConfig(RealmModel realm, UserFederationProviderModel fedProviderModel, UserFederationMapperModel mapperModel)`
    `void` | HardcodedLDAPRoleMapperFactory.`validateConfig(RealmModel realm, UserFederationProviderModel fedProviderModel, UserFederationMapperModel mapperModel)`
    `void` | FullNameLDAPFederationMapperFactory.`validateConfig(RealmModel realm, UserFederationProviderModel fedProviderModel, UserFederationMapperModel mapperModel)`

  - ### Uses of UserFederationProviderModel in org.keycloak.federation.ldap.mappers.membership.group

    Methods in org.keycloak.federation.ldap.mappers.membership.group with parameters of type UserFederationProviderModel
    Modifier and Type | Method and Description
    --- | ---
    `Map<String,String>` | GroupLDAPFederationMapperFactory.`getDefaultConfig(UserFederationProviderModel providerModel)`
    `void` | GroupLDAPFederationMapperFactory.`validateConfig(RealmModel realm, UserFederationProviderModel fedProviderModel, UserFederationMapperModel mapperModel)`

  - ### Uses of UserFederationProviderModel in org.keycloak.federation.ldap.mappers.membership.role

    Methods in org.keycloak.federation.ldap.mappers.membership.role with parameters of type UserFederationProviderModel
    Modifier and Type | Method and Description
    --- | ---
    `Map<String,String>` | RoleLDAPFederationMapperFactory.`getDefaultConfig(UserFederationProviderModel providerModel)`
    `void` | RoleLDAPFederationMapperFactory.`validateConfig(RealmModel realm, UserFederationProviderModel fedProviderModel, UserFederationMapperModel mapperModel)`

  - ### Uses of UserFederationProviderModel in org.keycloak.federation.ldap.mappers.msad

    Methods in org.keycloak.federation.ldap.mappers.msad with parameters of type UserFederationProviderModel
    Modifier and Type | Method and Description
    --- | ---
    `Map<String,String>` | MSADUserAccountControlMapperFactory.`getDefaultConfig(UserFederationProviderModel providerModel)`
    `void` | MSADUserAccountControlMapperFactory.`validateConfig(RealmModel realm, UserFederationProviderModel fedProviderModel, UserFederationMapperModel mapperModel)`

  - ### Uses of UserFederationProviderModel in org.keycloak.mappers

    Methods in org.keycloak.mappers with parameters of type UserFederationProviderModel
    Modifier and Type | Method and Description
    --- | ---
    `Map<String,String>` | UserFederationMapperFactory.`getDefaultConfig(UserFederationProviderModel providerModel)` Used to detect what are default values for ProviderConfigProperties specified during mapper creation
    `void` | UserFederationMapperFactory.`validateConfig(RealmModel realm, UserFederationProviderModel fedProviderModel, UserFederationMapperModel mapperModel)` Called when instance of mapperModel is created for this factory through admin endpoint

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

    Methods in org.keycloak.models that return UserFederationProviderModel
    Modifier and Type | Method and Description
    --- | ---
    `UserFederationProviderModel` | RealmModel.`addUserFederationProvider(String providerName, Map<String,String> config, int priority, String displayName, int fullSyncPeriod, int changedSyncPeriod, int lastSync)`
    `UserFederationProviderModel` | UserFederationProviderCreationEventImpl.`getCreatedFederationProvider()`
    `UserFederationProviderModel` | RealmModel.UserFederationProviderCreationEvent.`getCreatedFederationProvider()`

    Methods in org.keycloak.models that return types with arguments of type UserFederationProviderModel
    Modifier and Type | Method and Description
    --- | ---
    `List<UserFederationProviderModel>` | RealmModel.`getUserFederationProviders()`

    Methods in org.keycloak.models with parameters of type UserFederationProviderModel
    Modifier and Type | Method and Description
    --- | ---
    `protected UserFederationProvider` | UserFederationManager.`getFederationProvider(UserFederationProviderModel model)`
    `UserFederationProvider` | UserFederationProviderFactory.`getInstance(KeycloakSession session, UserFederationProviderModel model)` called per Keycloak transaction.
    `abstract void` | UserFederationEventAwareProviderFactory.`onProviderModelCreated(RealmModel realm, UserFederationProviderModel createdProviderModel)`
    `void` | UserProvider.`preRemove(RealmModel realm, UserFederationProviderModel link)`
    `void` | UserFederationManager.`preRemove(RealmModel realm, UserFederationProviderModel model)`
    `void` | RealmModel.`removeUserFederationProvider(UserFederationProviderModel provider)`
    `UserFederationSyncResult` | UserFederationProviderFactory.`syncAllUsers(KeycloakSessionFactory sessionFactory, String realmId, UserFederationProviderModel model)` Sync all users from the provider storage to Keycloak storage.
    `UserFederationSyncResult` | UserFederationProviderFactory.`syncChangedUsers(KeycloakSessionFactory sessionFactory, String realmId, UserFederationProviderModel model, Date lastSync)` Sync just changed (added / updated / removed) users from the provider storage to Keycloak storage.
    `void` | RealmModel.`updateUserFederationProvider(UserFederationProviderModel provider)`
    `void` | UserFederationValidatingProviderFactory.`validateConfig(RealmModel realm, UserFederationProviderModel providerModel)` Called when instance of mapperModel is created for this factory through admin endpoint

    Method parameters in org.keycloak.models with type arguments of type UserFederationProviderModel
    Modifier and Type | Method and Description
    --- | ---
    `void` | RealmModel.`setUserFederationProviders(List<UserFederationProviderModel> providers)`

    Constructors in org.keycloak.models with parameters of type UserFederationProviderModel
    Constructor and Description
    `UserFederationProviderCreationEventImpl(RealmModel realm, UserFederationProviderModel createdFederationProvider)`

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

    Methods in org.keycloak.models.cache.infinispan that return UserFederationProviderModel
    Modifier and Type | Method and Description
    --- | ---
    `UserFederationProviderModel` | RealmAdapter.`addUserFederationProvider(String providerName, Map<String,String> config, int priority, String displayName, int fullSyncPeriod, int changedSyncPeriod, int lastSync)`

    Methods in org.keycloak.models.cache.infinispan that return types with arguments of type UserFederationProviderModel
    Modifier and Type | Method and Description
    --- | ---
    `List<UserFederationProviderModel>` | RealmAdapter.`getUserFederationProviders()`

    Methods in org.keycloak.models.cache.infinispan with parameters of type UserFederationProviderModel
    Modifier and Type | Method and Description
    --- | ---
    `void` | UserCacheSession.`preRemove(RealmModel realm, UserFederationProviderModel link)`
    `void` | RealmAdapter.`removeUserFederationProvider(UserFederationProviderModel provider)`
    `void` | RealmAdapter.`updateUserFederationProvider(UserFederationProviderModel provider)`

    Method parameters in org.keycloak.models.cache.infinispan with type arguments of type UserFederationProviderModel
    Modifier and Type | Method and Description
    --- | ---
    `void` | RealmAdapter.`setUserFederationProviders(List<UserFederationProviderModel> providers)`

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

    Fields in org.keycloak.models.cache.infinispan.entities with type parameters of type UserFederationProviderModel
    Modifier and Type | Field and Description
    --- | ---
    `protected List<UserFederationProviderModel>` | CachedRealm.`userFederationProviders`

    Methods in org.keycloak.models.cache.infinispan.entities that return types with arguments of type UserFederationProviderModel
    Modifier and Type | Method and Description
    --- | ---
    `List<UserFederationProviderModel>` | CachedRealm.`getUserFederationProviders()`

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

    Methods in org.keycloak.models.jpa that return UserFederationProviderModel
    Modifier and Type | Method and Description
    --- | ---
    `UserFederationProviderModel` | RealmAdapter.`addUserFederationProvider(String providerName, Map<String,String> config, int priority, String displayName, int fullSyncPeriod, int changedSyncPeriod, int lastSync)`

    Methods in org.keycloak.models.jpa that return types with arguments of type UserFederationProviderModel
    Modifier and Type | Method and Description
    --- | ---
    `List<UserFederationProviderModel>` | RealmAdapter.`getUserFederationProviders()`

    Methods in org.keycloak.models.jpa with parameters of type UserFederationProviderModel
    Modifier and Type | Method and Description
    --- | ---
    `void` | JpaUserProvider.`preRemove(RealmModel realm, UserFederationProviderModel link)`
    `void` | RealmAdapter.`removeUserFederationProvider(UserFederationProviderModel provider)`
    `void` | RealmAdapter.`updateUserFederationProvider(UserFederationProviderModel model)`

    Method parameters in org.keycloak.models.jpa with type arguments of type UserFederationProviderModel
    Modifier and Type | Method and Description
    --- | ---
    `void` | RealmAdapter.`setUserFederationProviders(List<UserFederationProviderModel> providers)`

  - ### Uses of UserFederationProviderModel in org.keycloak.models.mongo.keycloak.adapters

    Methods in org.keycloak.models.mongo.keycloak.adapters that return UserFederationProviderModel
    Modifier and Type | Method and Description
    --- | ---
    `UserFederationProviderModel` | RealmAdapter.`addUserFederationProvider(String providerName, Map<String,String> config, int priority, String displayName, int fullSyncPeriod, int changedSyncPeriod, int lastSync)`

    Methods in org.keycloak.models.mongo.keycloak.adapters that return types with arguments of type UserFederationProviderModel
    Modifier and Type | Method and Description
    --- | ---
    `List<UserFederationProviderModel>` | RealmAdapter.`getUserFederationProviders()`

    Methods in org.keycloak.models.mongo.keycloak.adapters with parameters of type UserFederationProviderModel
    Modifier and Type | Method and Description
    --- | ---
    `void` | MongoUserProvider.`preRemove(RealmModel realm, UserFederationProviderModel link)`
    `void` | RealmAdapter.`removeUserFederationProvider(UserFederationProviderModel provider)`
    `void` | RealmAdapter.`updateUserFederationProvider(UserFederationProviderModel model)`

    Method parameters in org.keycloak.models.mongo.keycloak.adapters with type arguments of type UserFederationProviderModel
    Modifier and Type | Method and Description
    --- | ---
    `void` | RealmAdapter.`setUserFederationProviders(List<UserFederationProviderModel> providers)`

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

    Methods in org.keycloak.models.utils that return UserFederationProviderModel
    Modifier and Type | Method and Description
    --- | ---
    `static UserFederationProviderModel` | KeycloakModelUtils.`findUserFederationProviderByDisplayName(String displayName, RealmModel realm)`
    `static UserFederationProviderModel` | KeycloakModelUtils.`findUserFederationProviderById(String fedProviderId, RealmModel realm)`

    Methods in org.keycloak.models.utils with parameters of type UserFederationProviderModel
    Modifier and Type | Method and Description
    --- | ---
    `static void` | KeycloakModelUtils.`ensureUniqueDisplayName(String displayName, UserFederationProviderModel myProvider, List<UserFederationProviderModel> federationProviders)` Ensure that displayName of myProvider (if not null) is unique and there is no other provider with same displayName in the list.
    `static UserFederationProviderFactory` | KeycloakModelUtils.`getFederationProviderFactory(KeycloakSession session, UserFederationProviderModel model)`
    `static UserFederationProvider` | KeycloakModelUtils.`getFederationProviderInstance(KeycloakSession session, UserFederationProviderModel model)`
    `static UserFederationProviderRepresentation` | ModelToRepresentation.`toRepresentation(UserFederationProviderModel model)`

    Method parameters in org.keycloak.models.utils with type arguments of type UserFederationProviderModel
    Modifier and Type | Method and Description
    --- | ---
    `static void` | KeycloakModelUtils.`ensureUniqueDisplayName(String displayName, UserFederationProviderModel myProvider, List<UserFederationProviderModel> federationProviders)` Ensure that displayName of myProvider (if not null) is unique and there is no other provider with same displayName in the list.

  - ### Uses of UserFederationProviderModel in org.keycloak.services.managers

    Methods in org.keycloak.services.managers that return UserFederationProviderModel
    Modifier and Type | Method and Description
    --- | ---
    `UserFederationProviderModel` | UsersSyncManager.FederationProviderClusterEvent.`getFederationProvider()`

    Methods in org.keycloak.services.managers with parameters of type UserFederationProviderModel
    Modifier and Type | Method and Description
    --- | ---
    `static UsersSyncManager.FederationProviderClusterEvent` | UsersSyncManager.FederationProviderClusterEvent.`createEvent(boolean removed, String realmId, UserFederationProviderModel fedProvider)`
    `void` | UsersSyncManager.`notifyToRefreshPeriodicSync(KeycloakSession session, RealmModel realm, UserFederationProviderModel federationProvider, boolean removed)`
    `protected void` | UsersSyncManager.`refreshPeriodicSyncForProvider(KeycloakSessionFactory sessionFactory, TimerProvider timer, UserFederationProviderModel fedProvider, String realmId)`
    `protected void` | UsersSyncManager.`removePeriodicSyncForProvider(TimerProvider timer, UserFederationProviderModel fedProvider)`
    `void` | UsersSyncManager.FederationProviderClusterEvent.`setFederationProvider(UserFederationProviderModel federationProvider)`
    `UserFederationSyncResult` | UsersSyncManager.`syncAllUsers(KeycloakSessionFactory sessionFactory, String realmId, UserFederationProviderModel fedProvider)`
    `UserFederationSyncResult` | UsersSyncManager.`syncChangedUsers(KeycloakSessionFactory sessionFactory, String realmId, UserFederationProviderModel fedProvider)`

  - ### Uses of UserFederationProviderModel in org.keycloak.services.resources.admin

    Methods in org.keycloak.services.resources.admin with parameters of type UserFederationProviderModel
    Modifier and Type | Method and Description
    --- | ---
    `static boolean` | UserFederationProvidersResource.`checkKerberosCredential(KeycloakSession session, RealmModel realm, UserFederationProviderModel model)` Automatically add "kerberos" to required realm credentials if it's supported by saved provider
    `static void` | UserFederationProvidersResource.`validateFederationProviderConfig(KeycloakSession session, RealmAuth auth, RealmModel realm, UserFederationProviderModel model)`

    Constructors in org.keycloak.services.resources.admin with parameters of type UserFederationProviderModel
    Constructor and Description
    `UserFederationProviderResource(KeycloakSession session, RealmModel realm, RealmAuth auth, UserFederationProviderModel federationProviderModel, AdminEventBuilder adminEvent)`

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

    Methods in org.keycloak.storage with parameters of type UserFederationProviderModel
    Modifier and Type | Method and Description
    --- | ---
    `void` | UserStorageManager.`preRemove(RealmModel realm, UserFederationProviderModel model)`

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

    Methods in org.keycloak.storage.federated with parameters of type UserFederationProviderModel
    Modifier and Type | Method and Description
    --- | ---
    `void` | UserFederatedStorageProvider.`preRemove(RealmModel realm, UserFederationProviderModel link)`

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

    Methods in org.keycloak.storage.jpa with parameters of type UserFederationProviderModel
    Modifier and Type | Method and Description
    --- | ---
    `void` | JpaUserFederatedStorageProvider.`preRemove(RealmModel realm, UserFederationProviderModel link)`

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