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

- Packages that use UserFederationMapperModel
  Package | Description
  --- | ---
  org.keycloak.federation.ldap |
  org.keycloak.federation.ldap.idm.query.internal |
  org.keycloak.federation.ldap.mappers |
  org.keycloak.federation.ldap.mappers.membership |
  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 |

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

    Methods in org.keycloak.federation.ldap that return types with arguments of type UserFederationMapperModel
    Modifier and Type | Method and Description
    --- | ---
    `List<UserFederationMapperModel>` | LDAPFederationProvider.`sortMappersAsc(Collection<UserFederationMapperModel> mappers)`
    `protected List<UserFederationMapperModel>` | LDAPFederationProvider.`sortMappersDesc(Collection<UserFederationMapperModel> mappers)`

    Methods in org.keycloak.federation.ldap with parameters of type UserFederationMapperModel
    Modifier and Type | Method and Description
    --- | ---
    `LDAPFederationMapper` | LDAPFederationProvider.`getMapper(UserFederationMapperModel mapperModel)`

    Method parameters in org.keycloak.federation.ldap with type arguments of type UserFederationMapperModel
    Modifier and Type | Method and Description
    --- | ---
    `List<UserFederationMapperModel>` | LDAPFederationProvider.`sortMappersAsc(Collection<UserFederationMapperModel> mappers)`
    `protected List<UserFederationMapperModel>` | LDAPFederationProvider.`sortMappersDesc(Collection<UserFederationMapperModel> mappers)`

  - ### Uses of UserFederationMapperModel in org.keycloak.federation.ldap.idm.query.internal

    Methods in org.keycloak.federation.ldap.idm.query.internal that return types with arguments of type UserFederationMapperModel
    Modifier and Type | Method and Description
    --- | ---
    `List<UserFederationMapperModel>` | LDAPQuery.`getMappers()`

    Method parameters in org.keycloak.federation.ldap.idm.query.internal with type arguments of type UserFederationMapperModel
    Modifier and Type | Method and Description
    --- | ---
    `LDAPQuery` | LDAPQuery.`addMappers(Collection<UserFederationMapperModel> mappers)`

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

    Fields in org.keycloak.federation.ldap.mappers declared as UserFederationMapperModel
    Modifier and Type | Field and Description
    --- | ---
    `protected UserFederationMapperModel` | AbstractLDAPFederationMapper.`mapperModel`

    Methods in org.keycloak.federation.ldap.mappers that return types with arguments of type UserFederationMapperModel
    Modifier and Type | Method and Description
    --- | ---
    `static List<UserFederationMapperModel>` | LDAPMappersComparator.`sortAsc(LDAPConfig ldapConfig, Collection<UserFederationMapperModel> mappers)`
    `static List<UserFederationMapperModel>` | LDAPMappersComparator.`sortDesc(LDAPConfig ldapConfig, Collection<UserFederationMapperModel> mappers)`

    Methods in org.keycloak.federation.ldap.mappers with parameters of type UserFederationMapperModel
    Modifier and Type | Method and Description
    --- | ---
    `void` | LDAPFederationMapperBridge.`beforeLDAPQuery(UserFederationMapperModel mapperModel, LDAPQuery query)`
    `void` | LDAPFederationMapper.`beforeLDAPQuery(UserFederationMapperModel mapperModel, LDAPQuery query)` Called before LDAP Identity query for retrieve LDAP users was executed.
    `protected void` | AbstractLDAPFederationMapperFactory.`checkMandatoryConfigAttribute(String name, String displayName, UserFederationMapperModel mapperModel)`
    `protected AbstractLDAPFederationMapper` | UserAttributeLDAPFederationMapperFactory.`createMapper(UserFederationMapperModel mapperModel, LDAPFederationProvider federationProvider, RealmModel realm)`
    `protected AbstractLDAPFederationMapper` | HardcodedLDAPRoleMapperFactory.`createMapper(UserFederationMapperModel mapperModel, LDAPFederationProvider federationProvider, RealmModel realm)`
    `protected AbstractLDAPFederationMapper` | FullNameLDAPFederationMapperFactory.`createMapper(UserFederationMapperModel mapperModel, LDAPFederationProvider federationProvider, RealmModel realm)`
    `protected abstract AbstractLDAPFederationMapper` | AbstractLDAPFederationMapperFactory.`createMapper(UserFederationMapperModel mapperModel, LDAPFederationProvider federationProvider, RealmModel realm)`
    `List<UserModel>` | LDAPFederationMapperBridge.`getGroupMembers(UserFederationMapperModel mapperModel, UserFederationProvider ldapProvider, RealmModel realm, GroupModel group, int firstResult, int maxResults)`
    `boolean` | LDAPFederationMapperBridge.`onAuthenticationFailure(UserFederationMapperModel mapperModel, LDAPFederationProvider ldapProvider, LDAPObject ldapUser, UserModel user, AuthenticationException ldapException, RealmModel realm)`
    `boolean` | LDAPFederationMapper.`onAuthenticationFailure(UserFederationMapperModel mapperModel, LDAPFederationProvider ldapProvider, LDAPObject ldapUser, UserModel user, AuthenticationException ldapException, RealmModel realm)` Called when LDAP authentication of specified user fails.
    `void` | LDAPFederationMapperBridge.`onImportUserFromLDAP(UserFederationMapperModel mapperModel, LDAPFederationProvider ldapProvider, LDAPObject ldapUser, UserModel user, RealmModel realm, boolean isCreate)`
    `void` | LDAPFederationMapper.`onImportUserFromLDAP(UserFederationMapperModel mapperModel, LDAPFederationProvider ldapProvider, LDAPObject ldapUser, UserModel user, RealmModel realm, boolean isCreate)` Called when importing user from LDAP to local keycloak DB.
    `void` | LDAPFederationMapperBridge.`onRegisterUserToLDAP(UserFederationMapperModel mapperModel, LDAPFederationProvider ldapProvider, LDAPObject ldapUser, UserModel localUser, RealmModel realm)`
    `void` | LDAPFederationMapper.`onRegisterUserToLDAP(UserFederationMapperModel mapperModel, LDAPFederationProvider ldapProvider, LDAPObject ldapUser, UserModel localUser, RealmModel realm)` Called when register new user to LDAP - just after user was created in Keycloak DB
    `static boolean` | AbstractLDAPFederationMapper.`parseBooleanParameter(UserFederationMapperModel mapperModel, String paramName)`
    `UserModel` | LDAPFederationMapperBridge.`proxy(UserFederationMapperModel mapperModel, LDAPFederationProvider ldapProvider, LDAPObject ldapUser, UserModel delegate, RealmModel realm)`
    `UserModel` | LDAPFederationMapper.`proxy(UserFederationMapperModel mapperModel, LDAPFederationProvider ldapProvider, LDAPObject ldapUser, UserModel delegate, RealmModel realm)` Called when invoke proxy on LDAP federation provider
    `UserFederationSyncResult` | LDAPFederationMapperBridge.`syncDataFromFederationProviderToKeycloak(UserFederationMapperModel mapperModel, UserFederationProvider federationProvider, KeycloakSession session, RealmModel realm)`
    `UserFederationSyncResult` | LDAPFederationMapperBridge.`syncDataFromKeycloakToFederationProvider(UserFederationMapperModel mapperModel, UserFederationProvider federationProvider, KeycloakSession session, RealmModel realm)`
    `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)`

    Method parameters in org.keycloak.federation.ldap.mappers with type arguments of type UserFederationMapperModel
    Modifier and Type | Method and Description
    --- | ---
    `static List<UserFederationMapperModel>` | LDAPMappersComparator.`sortAsc(LDAPConfig ldapConfig, Collection<UserFederationMapperModel> mappers)`
    `static List<UserFederationMapperModel>` | LDAPMappersComparator.`sortDesc(LDAPConfig ldapConfig, Collection<UserFederationMapperModel> mappers)`

    Constructors in org.keycloak.federation.ldap.mappers with parameters of type UserFederationMapperModel
    Constructor and Description
    `AbstractLDAPFederationMapper(UserFederationMapperModel mapperModel, LDAPFederationProvider ldapProvider, RealmModel realm)`
    `FullNameLDAPFederationMapper(UserFederationMapperModel mapperModel, LDAPFederationProvider ldapProvider, RealmModel realm)`
    `HardcodedLDAPRoleMapper(UserFederationMapperModel mapperModel, LDAPFederationProvider ldapProvider, RealmModel realm)`
    `UserAttributeLDAPFederationMapper(UserFederationMapperModel mapperModel, LDAPFederationProvider ldapProvider, RealmModel realm)`

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

    Fields in org.keycloak.federation.ldap.mappers.membership declared as UserFederationMapperModel
    Modifier and Type | Field and Description
    --- | ---
    `protected UserFederationMapperModel` | CommonLDAPGroupMapperConfig.`mapperModel`

    Constructors in org.keycloak.federation.ldap.mappers.membership with parameters of type UserFederationMapperModel
    Constructor and Description
    `CommonLDAPGroupMapperConfig(UserFederationMapperModel mapperModel)`

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

    Methods in org.keycloak.federation.ldap.mappers.membership.group with parameters of type UserFederationMapperModel
    Modifier and Type | Method and Description
    --- | ---
    `protected AbstractLDAPFederationMapper` | GroupLDAPFederationMapperFactory.`createMapper(UserFederationMapperModel mapperModel, LDAPFederationProvider federationProvider, RealmModel realm)`
    `void` | GroupLDAPFederationMapperFactory.`validateConfig(RealmModel realm, UserFederationProviderModel fedProviderModel, UserFederationMapperModel mapperModel)`

    Constructors in org.keycloak.federation.ldap.mappers.membership.group with parameters of type UserFederationMapperModel
    Constructor and Description
    `GroupLDAPFederationMapper(UserFederationMapperModel mapperModel, LDAPFederationProvider ldapProvider, RealmModel realm, GroupLDAPFederationMapperFactory factory)`
    `GroupMapperConfig(UserFederationMapperModel mapperModel)`

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

    Methods in org.keycloak.federation.ldap.mappers.membership.role with parameters of type UserFederationMapperModel
    Modifier and Type | Method and Description
    --- | ---
    `protected AbstractLDAPFederationMapper` | RoleLDAPFederationMapperFactory.`createMapper(UserFederationMapperModel mapperModel, LDAPFederationProvider federationProvider, RealmModel realm)`
    `void` | RoleLDAPFederationMapperFactory.`validateConfig(RealmModel realm, UserFederationProviderModel fedProviderModel, UserFederationMapperModel mapperModel)`

    Constructors in org.keycloak.federation.ldap.mappers.membership.role with parameters of type UserFederationMapperModel
    Constructor and Description
    `RoleLDAPFederationMapper(UserFederationMapperModel mapperModel, LDAPFederationProvider ldapProvider, RealmModel realm, RoleLDAPFederationMapperFactory factory)`
    `RoleMapperConfig(UserFederationMapperModel mapperModel)`

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

    Methods in org.keycloak.federation.ldap.mappers.msad with parameters of type UserFederationMapperModel
    Modifier and Type | Method and Description
    --- | ---
    `protected AbstractLDAPFederationMapper` | MSADUserAccountControlMapperFactory.`createMapper(UserFederationMapperModel mapperModel, LDAPFederationProvider federationProvider, RealmModel realm)`
    `void` | MSADUserAccountControlMapperFactory.`validateConfig(RealmModel realm, UserFederationProviderModel fedProviderModel, UserFederationMapperModel mapperModel)`

    Constructors in org.keycloak.federation.ldap.mappers.msad with parameters of type UserFederationMapperModel
    Constructor and Description
    `MSADUserAccountControlMapper(UserFederationMapperModel mapperModel, LDAPFederationProvider ldapProvider, RealmModel realm)`

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

    Methods in org.keycloak.mappers with parameters of type UserFederationMapperModel
    Modifier and Type | Method and Description
    --- | ---
    `List<UserModel>` | UserFederationMapper.`getGroupMembers(UserFederationMapperModel mapperModel, UserFederationProvider federationProvider, RealmModel realm, GroupModel group, int firstResult, int maxResults)` Return empty list if doesn't support storing of groups
    `UserFederationSyncResult` | UserFederationMapper.`syncDataFromFederationProviderToKeycloak(UserFederationMapperModel mapperModel, UserFederationProvider federationProvider, KeycloakSession session, RealmModel realm)` Sync data from federated storage to Keycloak.
    `UserFederationSyncResult` | UserFederationMapper.`syncDataFromKeycloakToFederationProvider(UserFederationMapperModel mapperModel, UserFederationProvider federationProvider, KeycloakSession session, RealmModel realm)` Sync data from Keycloak back to federated storage
    `void` | UserFederationMapperFactory.`validateConfig(RealmModel realm, UserFederationProviderModel fedProviderModel, UserFederationMapperModel mapperModel)` Called when instance of mapperModel is created for this factory through admin endpoint

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

    Methods in org.keycloak.models that return UserFederationMapperModel
    Modifier and Type | Method and Description
    --- | ---
    `UserFederationMapperModel` | RealmModel.`addUserFederationMapper(UserFederationMapperModel mapper)`
    `UserFederationMapperModel` | RealmModel.`getUserFederationMapperById(String id)`
    `UserFederationMapperModel` | RealmModel.`getUserFederationMapperByName(String federationProviderId, String name)`

    Methods in org.keycloak.models that return types with arguments of type UserFederationMapperModel
    Modifier and Type | Method and Description
    --- | ---
    `Set<UserFederationMapperModel>` | RealmModel.`getUserFederationMappers()`
    `Set<UserFederationMapperModel>` | RealmModel.`getUserFederationMappersByFederationProvider(String federationProviderId)`

    Methods in org.keycloak.models with parameters of type UserFederationMapperModel
    Modifier and Type | Method and Description
    --- | ---
    `UserFederationMapperModel` | RealmModel.`addUserFederationMapper(UserFederationMapperModel mapper)`
    `void` | RealmModel.`removeUserFederationMapper(UserFederationMapperModel mapper)`
    `void` | RealmModel.`updateUserFederationMapper(UserFederationMapperModel mapper)`

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

    Methods in org.keycloak.models.cache.infinispan that return UserFederationMapperModel
    Modifier and Type | Method and Description
    --- | ---
    `UserFederationMapperModel` | RealmAdapter.`addUserFederationMapper(UserFederationMapperModel mapper)`
    `UserFederationMapperModel` | RealmAdapter.`getUserFederationMapperById(String id)`
    `UserFederationMapperModel` | RealmAdapter.`getUserFederationMapperByName(String federationProviderId, String name)`

    Methods in org.keycloak.models.cache.infinispan that return types with arguments of type UserFederationMapperModel
    Modifier and Type | Method and Description
    --- | ---
    `Set<UserFederationMapperModel>` | RealmAdapter.`getUserFederationMappers()`
    `Set<UserFederationMapperModel>` | RealmAdapter.`getUserFederationMappersByFederationProvider(String federationProviderId)`

    Methods in org.keycloak.models.cache.infinispan with parameters of type UserFederationMapperModel
    Modifier and Type | Method and Description
    --- | ---
    `UserFederationMapperModel` | RealmAdapter.`addUserFederationMapper(UserFederationMapperModel mapper)`
    `void` | RealmAdapter.`removeUserFederationMapper(UserFederationMapperModel mapper)`
    `void` | RealmAdapter.`updateUserFederationMapper(UserFederationMapperModel mapper)`

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

    Fields in org.keycloak.models.cache.infinispan.entities with type parameters of type UserFederationMapperModel
    Modifier and Type | Field and Description
    --- | ---
    `protected MultivaluedHashMap<String,UserFederationMapperModel>` | CachedRealm.`userFederationMappers`
    `protected Set<UserFederationMapperModel>` | CachedRealm.`userFederationMapperSet`

    Methods in org.keycloak.models.cache.infinispan.entities that return types with arguments of type UserFederationMapperModel
    Modifier and Type | Method and Description
    --- | ---
    `MultivaluedHashMap<String,UserFederationMapperModel>` | CachedRealm.`getUserFederationMappers()`
    `Set<UserFederationMapperModel>` | CachedRealm.`getUserFederationMapperSet()`

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

    Methods in org.keycloak.models.jpa that return UserFederationMapperModel
    Modifier and Type | Method and Description
    --- | ---
    `UserFederationMapperModel` | RealmAdapter.`addUserFederationMapper(UserFederationMapperModel model)`
    `protected UserFederationMapperModel` | RealmAdapter.`entityToModel(UserFederationMapperEntity entity)`
    `UserFederationMapperModel` | RealmAdapter.`getUserFederationMapperById(String id)`
    `UserFederationMapperModel` | RealmAdapter.`getUserFederationMapperByName(String federationProviderId, String name)`

    Methods in org.keycloak.models.jpa that return types with arguments of type UserFederationMapperModel
    Modifier and Type | Method and Description
    --- | ---
    `Set<UserFederationMapperModel>` | RealmAdapter.`getUserFederationMappers()`
    `Set<UserFederationMapperModel>` | RealmAdapter.`getUserFederationMappersByFederationProvider(String federationProviderId)`

    Methods in org.keycloak.models.jpa with parameters of type UserFederationMapperModel
    Modifier and Type | Method and Description
    --- | ---
    `UserFederationMapperModel` | RealmAdapter.`addUserFederationMapper(UserFederationMapperModel model)`
    `void` | RealmAdapter.`removeUserFederationMapper(UserFederationMapperModel mapper)`
    `void` | RealmAdapter.`updateUserFederationMapper(UserFederationMapperModel mapper)`

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

    Methods in org.keycloak.models.mongo.keycloak.adapters that return UserFederationMapperModel
    Modifier and Type | Method and Description
    --- | ---
    `UserFederationMapperModel` | RealmAdapter.`addUserFederationMapper(UserFederationMapperModel model)`
    `protected UserFederationMapperModel` | RealmAdapter.`entityToModel(UserFederationMapperEntity entity)`
    `UserFederationMapperModel` | RealmAdapter.`getUserFederationMapperById(String id)`
    `UserFederationMapperModel` | RealmAdapter.`getUserFederationMapperByName(String federationProviderId, String name)`

    Methods in org.keycloak.models.mongo.keycloak.adapters that return types with arguments of type UserFederationMapperModel
    Modifier and Type | Method and Description
    --- | ---
    `Set<UserFederationMapperModel>` | RealmAdapter.`getUserFederationMappers()`
    `Set<UserFederationMapperModel>` | RealmAdapter.`getUserFederationMappersByFederationProvider(String federationProviderId)`

    Methods in org.keycloak.models.mongo.keycloak.adapters with parameters of type UserFederationMapperModel
    Modifier and Type | Method and Description
    --- | ---
    `UserFederationMapperModel` | RealmAdapter.`addUserFederationMapper(UserFederationMapperModel model)`
    `void` | RealmAdapter.`removeUserFederationMapper(UserFederationMapperModel mapper)`
    `void` | RealmAdapter.`updateUserFederationMapper(UserFederationMapperModel mapper)`

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

    Methods in org.keycloak.models.utils that return UserFederationMapperModel
    Modifier and Type | Method and Description
    --- | ---
    `static UserFederationMapperModel` | KeycloakModelUtils.`createUserFederationMapperModel(String name, String federationProviderId, String mapperType, String... config)`
    `static UserFederationMapperModel` | RepresentationToModel.`toModel(RealmModel realm, UserFederationMapperRepresentation rep)`

    Methods in org.keycloak.models.utils with parameters of type UserFederationMapperModel
    Modifier and Type | Method and Description
    --- | ---
    `static UserFederationMapperRepresentation` | ModelToRepresentation.`toRepresentation(RealmModel realm, UserFederationMapperModel model)`

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