## Uses of Class
org.keycloak.storage.ldap.idm.model.LDAPObject

- Packages that use LDAPObject
  Package | Description
  --- | ---
  org.keycloak.storage.ldap |
  org.keycloak.storage.ldap.idm.model |
  org.keycloak.storage.ldap.idm.query.internal |
  org.keycloak.storage.ldap.idm.store |
  org.keycloak.storage.ldap.idm.store.ldap |
  org.keycloak.storage.ldap.mappers |
  org.keycloak.storage.ldap.mappers.membership |
  org.keycloak.storage.ldap.mappers.membership.group |
  org.keycloak.storage.ldap.mappers.membership.role |
  org.keycloak.storage.ldap.mappers.msad |
  org.keycloak.storage.ldap.mappers.msadlds |

- - ### Uses of LDAPObject in org.keycloak.storage.ldap

    Methods in org.keycloak.storage.ldap that return LDAPObject
    Modifier and Type | Method and Description
    --- | ---
    `static LDAPObject` | LDAPUtils.`addUserToLDAP(LDAPStorageProvider ldapProvider, RealmModel realm, UserModel user)`
    `static LDAPObject` | LDAPUtils.`createLDAPGroup(LDAPStorageProvider ldapProvider, String groupName, String groupNameAttribute, Collection<String> objectClasses, String parentDn, Map<String,Set<String>> additionalAttributes, String membershipLdapAttribute)`
    `LDAPObject` | LDAPStorageUserManager.`getManagedLDAPUser(String userId)`
    `protected LDAPObject` | LDAPStorageProvider.`loadAndValidateUser(RealmModel realm, UserModel local)`
    `LDAPObject` | LDAPStorageProvider.`loadLDAPUserByUsername(RealmModel realm, String username)`
    `protected LDAPObject` | LDAPStorageProvider.`queryByEmail(RealmModel realm, String email)`
    `static LDAPObject` | LDAPUtils.`updateLDAPGroup(LDAPStorageProvider ldapProvider, LDAPObject ldapObject)`

    Methods in org.keycloak.storage.ldap that return types with arguments of type LDAPObject
    Modifier and Type | Method and Description
    --- | ---
    `static List<LDAPObject>` | LDAPUtils.`loadAllLDAPObjects(LDAPQuery ldapQuery, LDAPStorageProvider ldapProvider)` Load all LDAP objects corresponding to given query.
    `protected List<LDAPObject>` | LDAPStorageProvider.`searchLDAP(RealmModel realm, Map<String,String> attributes)`

    Methods in org.keycloak.storage.ldap with parameters of type LDAPObject
    Modifier and Type | Method and Description
    --- | ---
    `static void` | LDAPUtils.`addMember(LDAPStorageProvider ldapProvider, MembershipType membershipType, String memberAttrName, String memberChildAttrName, LDAPObject ldapParent, LDAPObject ldapChild)` Add ldapChild as member of ldapParent and save ldapParent to LDAP.
    `static void` | LDAPUtils.`checkUuid(LDAPObject ldapUser, LDAPConfig config)`
    `static void` | LDAPUtils.`computeAndSetDn(LDAPConfig config, LDAPObject ldapUser)`
    `static void` | LDAPUtils.`deleteMember(LDAPStorageProvider ldapProvider, MembershipType membershipType, String memberAttrName, String memberChildAttrName, LDAPObject ldapParent, LDAPObject ldapChild)` Remove ldapChild as member of ldapParent and save ldapParent to LDAP.
    `static void` | LDAPUtils.`fillRangedAttribute(LDAPStorageProvider ldapProvider, LDAPObject ldapObject, String name)` Performs iterative searches over an LDAPObject to return an attribute that is ranged.
    `static Set<String>` | LDAPUtils.`getExistingMemberships(LDAPStorageProvider ldapProvider, String memberAttrName, LDAPObject ldapRole)` Return all existing memberships (values of attribute 'member' ) from the given ldapRole or ldapGroup
    `static String` | LDAPUtils.`getMemberValueOfChildObject(LDAPObject ldapUser, MembershipType membershipType, String memberChildAttrName)` Get value to be used as attribute 'member' or 'memberUid' in some parent ldapObject
    `static String` | LDAPUtils.`getUsername(LDAPObject ldapUser, LDAPConfig config)`
    `protected UserModel` | LDAPStorageProvider.`importUserFromLDAP(KeycloakSession session, RealmModel realm, LDAPObject ldapUser)`
    `protected UserModel` | LDAPStorageProvider.`proxy(RealmModel realm, UserModel local, LDAPObject ldapObject, boolean newUser)`
    `void` | LDAPStorageUserManager.`setManagedProxiedUser(UserModel proxiedUser, LDAPObject ldapObject)`
    `static LDAPObject` | LDAPUtils.`updateLDAPGroup(LDAPStorageProvider ldapProvider, LDAPObject ldapObject)`

    Method parameters in org.keycloak.storage.ldap with type arguments of type LDAPObject
    Modifier and Type | Method and Description
    --- | ---
    `protected SynchronizationResult` | LDAPStorageProviderFactory.`importLdapUsers(KeycloakSessionFactory sessionFactory, String realmId, ComponentModel fedModel, List<LDAPObject> ldapUsers)`

  - ### Uses of LDAPObject in org.keycloak.storage.ldap.idm.model

    Methods in org.keycloak.storage.ldap.idm.model with parameters of type LDAPObject
    Modifier and Type | Method and Description
    --- | ---
    `void` | LDAPObject.`populateRangedAttribute(LDAPObject obj, String name)`

  - ### Uses of LDAPObject in org.keycloak.storage.ldap.idm.query.internal

    Methods in org.keycloak.storage.ldap.idm.query.internal that return LDAPObject
    Modifier and Type | Method and Description
    --- | ---
    `LDAPObject` | LDAPQuery.`getFirstResult()`

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

  - ### Uses of LDAPObject in org.keycloak.storage.ldap.idm.store

    Methods in org.keycloak.storage.ldap.idm.store that return types with arguments of type LDAPObject
    Modifier and Type | Method and Description
    --- | ---
    `List<LDAPObject>` | IdentityStore.`fetchQueryResults(LDAPQuery LDAPQuery)`

    Methods in org.keycloak.storage.ldap.idm.store with parameters of type LDAPObject
    Modifier and Type | Method and Description
    --- | ---
    `void` | IdentityStore.`add(LDAPObject ldapObject)` Persists the specified IdentityType
    `void` | IdentityStore.`remove(LDAPObject ldapObject)` Removes the specified IdentityType
    `void` | IdentityStore.`update(LDAPObject ldapObject)` Updates the specified IdentityType
    `void` | IdentityStore.`updatePassword(LDAPObject user, String password, LDAPOperationDecorator passwordUpdateDecorator)` Updates the specified credential value.
    `void` | IdentityStore.`validatePassword(LDAPObject user, String password)` Validates the specified credentials.

  - ### Uses of LDAPObject in org.keycloak.storage.ldap.idm.store.ldap

    Methods in org.keycloak.storage.ldap.idm.store.ldap that return types with arguments of type LDAPObject
    Modifier and Type | Method and Description
    --- | ---
    `List<LDAPObject>` | LDAPIdentityStore.`fetchQueryResults(LDAPQuery identityQuery)`

    Methods in org.keycloak.storage.ldap.idm.store.ldap with parameters of type LDAPObject
    Modifier and Type | Method and Description
    --- | ---
    `void` | LDAPIdentityStore.`add(LDAPObject ldapObject)`
    `protected void` | LDAPIdentityStore.`checkRename(LDAPObject ldapObject)`
    `protected BasicAttributes` | LDAPIdentityStore.`extractAttributesForSaving(LDAPObject ldapObject, boolean isCreate)`
    `protected String` | LDAPIdentityStore.`getEntryIdentifier(LDAPObject ldapObject)`
    `void` | LDAPIdentityStore.`remove(LDAPObject ldapObject)`
    `void` | LDAPIdentityStore.`update(LDAPObject ldapObject)`
    `void` | LDAPIdentityStore.`updatePassword(LDAPObject user, String password, LDAPOperationDecorator passwordUpdateDecorator)`
    `void` | LDAPIdentityStore.`validatePassword(LDAPObject user, String password)`

  - ### Uses of LDAPObject in org.keycloak.storage.ldap.mappers

    Fields in org.keycloak.storage.ldap.mappers declared as LDAPObject
    Modifier and Type | Field and Description
    --- | ---
    `protected LDAPObject` | TxAwareLDAPUserModelDelegate.`ldapUser`

    Methods in org.keycloak.storage.ldap.mappers with parameters of type LDAPObject
    Modifier and Type | Method and Description
    --- | ---
    `LDAPOperationDecorator` | PasswordUpdateCallback.`beforePasswordUpdate(UserModel user, LDAPObject ldapUser, UserCredentialModel password)`
    `protected String` | HardcodedLDAPAttributeMapper.`computeAttributeValue(String ldapAttrName, String ldapAttrValue, LDAPObject ldapUser, UserModel localUser, RealmModel realm)`
    `boolean` | LDAPStorageMapper.`onAuthenticationFailure(LDAPObject ldapUser, UserModel user, AuthenticationException ldapException, RealmModel realm)` Called when LDAP authentication of specified user fails.
    `boolean` | AbstractLDAPStorageMapper.`onAuthenticationFailure(LDAPObject ldapUser, UserModel user, AuthenticationException ldapException, RealmModel realm)`
    `void` | UserAttributeLDAPStorageMapper.`onImportUserFromLDAP(LDAPObject ldapUser, UserModel user, RealmModel realm, boolean isCreate)`
    `void` | LDAPStorageMapper.`onImportUserFromLDAP(LDAPObject ldapUser, UserModel user, RealmModel realm, boolean isCreate)` Called when importing user from LDAP to local keycloak DB.
    `void` | HardcodedLDAPRoleStorageMapper.`onImportUserFromLDAP(LDAPObject ldapUser, UserModel user, RealmModel realm, boolean isCreate)`
    `void` | HardcodedLDAPGroupStorageMapper.`onImportUserFromLDAP(LDAPObject ldapUser, UserModel user, RealmModel realm, boolean isCreate)`
    `void` | HardcodedLDAPAttributeMapper.`onImportUserFromLDAP(LDAPObject ldapUser, UserModel user, RealmModel realm, boolean isCreate)`
    `void` | HardcodedAttributeMapper.`onImportUserFromLDAP(LDAPObject ldapUser, UserModel user, RealmModel realm, boolean isCreate)`
    `void` | FullNameLDAPStorageMapper.`onImportUserFromLDAP(LDAPObject ldapUser, UserModel user, RealmModel realm, boolean isCreate)`
    `void` | UserAttributeLDAPStorageMapper.`onRegisterUserToLDAP(LDAPObject ldapUser, UserModel localUser, RealmModel realm)`
    `void` | LDAPStorageMapper.`onRegisterUserToLDAP(LDAPObject ldapUser, UserModel localUser, RealmModel realm)` Called when register new user to LDAP - just after user was created in Keycloak DB
    `void` | HardcodedLDAPRoleStorageMapper.`onRegisterUserToLDAP(LDAPObject ldapUser, UserModel localUser, RealmModel realm)`
    `void` | HardcodedLDAPGroupStorageMapper.`onRegisterUserToLDAP(LDAPObject ldapUser, UserModel localUser, RealmModel realm)`
    `void` | HardcodedLDAPAttributeMapper.`onRegisterUserToLDAP(LDAPObject ldapUser, UserModel localUser, RealmModel realm)`
    `void` | HardcodedAttributeMapper.`onRegisterUserToLDAP(LDAPObject ldapUser, UserModel localUser, RealmModel realm)`
    `void` | FullNameLDAPStorageMapper.`onRegisterUserToLDAP(LDAPObject ldapUser, UserModel localUser, RealmModel realm)`
    `void` | PasswordUpdateCallback.`passwordUpdated(UserModel user, LDAPObject ldapUser, UserCredentialModel password)`
    `void` | PasswordUpdateCallback.`passwordUpdateFailed(UserModel user, LDAPObject ldapUser, UserCredentialModel password, ModelException exception)`
    `UserModel` | UserAttributeLDAPStorageMapper.`proxy(LDAPObject ldapUser, UserModel delegate, RealmModel realm)`
    `UserModel` | LDAPStorageMapper.`proxy(LDAPObject ldapUser, UserModel delegate, RealmModel realm)` Called when invoke proxy on LDAP federation provider
    `UserModel` | HardcodedLDAPRoleStorageMapper.`proxy(LDAPObject ldapUser, UserModel delegate, RealmModel realm)`
    `UserModel` | HardcodedLDAPGroupStorageMapper.`proxy(LDAPObject ldapUser, UserModel delegate, RealmModel realm)`
    `UserModel` | HardcodedLDAPAttributeMapper.`proxy(LDAPObject ldapUser, UserModel delegate, RealmModel realm)`
    `UserModel` | HardcodedAttributeMapper.`proxy(LDAPObject ldapUser, UserModel delegate, RealmModel realm)`
    `UserModel` | FullNameLDAPStorageMapper.`proxy(LDAPObject ldapUser, UserModel delegate, RealmModel realm)`

    Constructors in org.keycloak.storage.ldap.mappers with parameters of type LDAPObject
    Constructor and Description
    `LDAPTransaction(LDAPStorageProvider ldapProvider, LDAPObject ldapUser)`
    `TxAwareLDAPUserModelDelegate(UserModel delegate, LDAPStorageProvider provider, LDAPObject ldapUser)`

  - ### Uses of LDAPObject in org.keycloak.storage.ldap.mappers.membership

    Methods in org.keycloak.storage.ldap.mappers.membership that return types with arguments of type LDAPObject
    Modifier and Type | Method and Description
    --- | ---
    `List<LDAPObject>` | UserRolesRetrieveStrategy.`getLDAPRoleMappings(CommonLDAPGroupMapper roleOrGroupMapper, LDAPObject ldapUser, LDAPConfig ldapConfig)`
    `List<LDAPObject>` | UserRolesRetrieveStrategy.LoadRolesByMember.`getLDAPRoleMappings(CommonLDAPGroupMapper roleOrGroupMapper, LDAPObject ldapUser, LDAPConfig ldapConfig)`
    `List<LDAPObject>` | UserRolesRetrieveStrategy.GetRolesFromUserMemberOfAttribute.`getLDAPRoleMappings(CommonLDAPGroupMapper roleOrGroupMapper, LDAPObject ldapUser, LDAPConfig ldapConfig)`

    Methods in org.keycloak.storage.ldap.mappers.membership with parameters of type LDAPObject
    Modifier and Type | Method and Description
    --- | ---
    `abstract List<UserModel>` | MembershipType.`getGroupMembers(RealmModel realm, CommonLDAPGroupMapper groupMapper, LDAPObject ldapGroup, int firstResult, int maxResults)`
    `List<LDAPObject>` | UserRolesRetrieveStrategy.`getLDAPRoleMappings(CommonLDAPGroupMapper roleOrGroupMapper, LDAPObject ldapUser, LDAPConfig ldapConfig)`
    `List<LDAPObject>` | UserRolesRetrieveStrategy.LoadRolesByMember.`getLDAPRoleMappings(CommonLDAPGroupMapper roleOrGroupMapper, LDAPObject ldapUser, LDAPConfig ldapConfig)`
    `List<LDAPObject>` | UserRolesRetrieveStrategy.GetRolesFromUserMemberOfAttribute.`getLDAPRoleMappings(CommonLDAPGroupMapper roleOrGroupMapper, LDAPObject ldapUser, LDAPConfig ldapConfig)`
    `abstract Set<LDAPDn>` | MembershipType.`getLDAPSubgroups(CommonLDAPGroupMapper groupMapper, LDAPObject ldapGroup)`

  - ### Uses of LDAPObject in org.keycloak.storage.ldap.mappers.membership.group

    Methods in org.keycloak.storage.ldap.mappers.membership.group that return LDAPObject
    Modifier and Type | Method and Description
    --- | ---
    `LDAPObject` | GroupLDAPStorageMapper.`createLDAPGroup(String groupName, Map<String,Set<String>> additionalAttributes)`
    `LDAPObject` | GroupLDAPStorageMapper.`loadLDAPGroupByName(String groupName)`
    `LDAPObject` | GroupLDAPStorageMapper.`updateLDAPGroup(LDAPObject ldapObject)`

    Methods in org.keycloak.storage.ldap.mappers.membership.group that return types with arguments of type LDAPObject
    Modifier and Type | Method and Description
    --- | ---
    `protected List<LDAPObject>` | GroupLDAPStorageMapper.`getAllLDAPGroups(boolean includeMemberAttribute)`
    `protected List<LDAPObject>` | GroupLDAPStorageMapper.`getLDAPGroupMappings(LDAPObject ldapUser)`

    Methods in org.keycloak.storage.ldap.mappers.membership.group with parameters of type LDAPObject
    Modifier and Type | Method and Description
    --- | ---
    `void` | GroupLDAPStorageMapper.`addGroupMappingInLDAP(RealmModel realm, GroupModel kcGroup, LDAPObject ldapUser)`
    `void` | GroupLDAPStorageMapper.`deleteGroupMappingInLDAP(LDAPObject ldapUser, LDAPObject ldapGroup)`
    `protected GroupModel` | GroupLDAPStorageMapper.`findKcGroupByLDAPGroup(RealmModel realm, LDAPObject ldapGroup)`
    `protected GroupModel` | GroupLDAPStorageMapper.`findKcGroupOrSyncFromLDAP(RealmModel realm, LDAPObject ldapGroup, UserModel user)`
    `protected List<LDAPObject>` | GroupLDAPStorageMapper.`getLDAPGroupMappings(LDAPObject ldapUser)`
    `protected Set<LDAPDn>` | GroupLDAPStorageMapper.`getLDAPSubgroups(LDAPObject ldapGroup)`
    `void` | GroupLDAPStorageMapper.`onImportUserFromLDAP(LDAPObject ldapUser, UserModel user, RealmModel realm, boolean isCreate)`
    `void` | GroupLDAPStorageMapper.`onRegisterUserToLDAP(LDAPObject ldapUser, UserModel localUser, RealmModel realm)`
    `UserModel` | GroupLDAPStorageMapper.`proxy(LDAPObject ldapUser, UserModel delegate, RealmModel realm)`
    `LDAPObject` | GroupLDAPStorageMapper.`updateLDAPGroup(LDAPObject ldapObject)`

    Constructors in org.keycloak.storage.ldap.mappers.membership.group with parameters of type LDAPObject
    Constructor and Description
    `LDAPGroupMappingsUserDelegate(RealmModel realm, UserModel user, LDAPObject ldapUser)`

  - ### Uses of LDAPObject in org.keycloak.storage.ldap.mappers.membership.role

    Methods in org.keycloak.storage.ldap.mappers.membership.role that return LDAPObject
    Modifier and Type | Method and Description
    --- | ---
    `LDAPObject` | RoleLDAPStorageMapper.`createLDAPRole(String roleName)`
    `LDAPObject` | RoleLDAPStorageMapper.`loadLDAPRoleByName(String roleName)`
    `LDAPObject` | RoleLDAPStorageMapper.`loadRoleGroupByName(String roleName)`

    Methods in org.keycloak.storage.ldap.mappers.membership.role that return types with arguments of type LDAPObject
    Modifier and Type | Method and Description
    --- | ---
    `protected List<LDAPObject>` | RoleLDAPStorageMapper.`getLDAPRoleMappings(LDAPObject ldapUser)`

    Methods in org.keycloak.storage.ldap.mappers.membership.role with parameters of type LDAPObject
    Modifier and Type | Method and Description
    --- | ---
    `void` | RoleLDAPStorageMapper.`addRoleMappingInLDAP(String roleName, LDAPObject ldapUser)`
    `void` | RoleLDAPStorageMapper.`deleteRoleMappingInLDAP(LDAPObject ldapUser, LDAPObject ldapRole)`
    `protected List<LDAPObject>` | RoleLDAPStorageMapper.`getLDAPRoleMappings(LDAPObject ldapUser)`
    `void` | RoleLDAPStorageMapper.`onImportUserFromLDAP(LDAPObject ldapUser, UserModel user, RealmModel realm, boolean isCreate)`
    `void` | RoleLDAPStorageMapper.`onRegisterUserToLDAP(LDAPObject ldapUser, UserModel localUser, RealmModel realm)`
    `UserModel` | RoleLDAPStorageMapper.`proxy(LDAPObject ldapUser, UserModel delegate, RealmModel realm)`

    Constructors in org.keycloak.storage.ldap.mappers.membership.role with parameters of type LDAPObject
    Constructor and Description
    `LDAPRoleMappingsUserDelegate(RealmModel realm, UserModel user, LDAPObject ldapUser)`

  - ### Uses of LDAPObject in org.keycloak.storage.ldap.mappers.msad

    Methods in org.keycloak.storage.ldap.mappers.msad with parameters of type LDAPObject
    Modifier and Type | Method and Description
    --- | ---
    `LDAPOperationDecorator` | MSADUserAccountControlStorageMapper.`beforePasswordUpdate(UserModel user, LDAPObject ldapUser, UserCredentialModel password)`
    `protected UserAccountControl` | MSADUserAccountControlStorageMapper.`getUserAccountControl(LDAPObject ldapUser)`
    `boolean` | MSADUserAccountControlStorageMapper.`onAuthenticationFailure(LDAPObject ldapUser, UserModel user, AuthenticationException ldapException, RealmModel realm)`
    `void` | MSADUserAccountControlStorageMapper.`onImportUserFromLDAP(LDAPObject ldapUser, UserModel user, RealmModel realm, boolean isCreate)`
    `void` | MSADUserAccountControlStorageMapper.`onRegisterUserToLDAP(LDAPObject ldapUser, UserModel localUser, RealmModel realm)`
    `void` | MSADUserAccountControlStorageMapper.`passwordUpdated(UserModel user, LDAPObject ldapUser, UserCredentialModel password)`
    `void` | MSADUserAccountControlStorageMapper.`passwordUpdateFailed(UserModel user, LDAPObject ldapUser, UserCredentialModel password, ModelException exception)`
    `UserModel` | MSADUserAccountControlStorageMapper.`proxy(LDAPObject ldapUser, UserModel delegate, RealmModel realm)`
    `protected void` | MSADUserAccountControlStorageMapper.`updateUserAccountControl(boolean updateInLDAP, LDAPObject ldapUser, UserAccountControl accountControl)`

    Constructors in org.keycloak.storage.ldap.mappers.msad with parameters of type LDAPObject
    Constructor and Description
    `MSADUserModelDelegate(UserModel delegate, LDAPObject ldapUser)`

  - ### Uses of LDAPObject in org.keycloak.storage.ldap.mappers.msadlds

    Methods in org.keycloak.storage.ldap.mappers.msadlds with parameters of type LDAPObject
    Modifier and Type | Method and Description
    --- | ---
    `LDAPOperationDecorator` | MSADLDSUserAccountControlStorageMapper.`beforePasswordUpdate(UserModel user, LDAPObject ldapUser, UserCredentialModel password)`
    `boolean` | MSADLDSUserAccountControlStorageMapper.`onAuthenticationFailure(LDAPObject ldapUser, UserModel user, AuthenticationException ldapException, RealmModel realm)`
    `void` | MSADLDSUserAccountControlStorageMapper.`onImportUserFromLDAP(LDAPObject ldapUser, UserModel user, RealmModel realm, boolean isCreate)`
    `void` | MSADLDSUserAccountControlStorageMapper.`onRegisterUserToLDAP(LDAPObject ldapUser, UserModel localUser, RealmModel realm)`
    `void` | MSADLDSUserAccountControlStorageMapper.`passwordUpdated(UserModel user, LDAPObject ldapUser, UserCredentialModel password)`
    `void` | MSADLDSUserAccountControlStorageMapper.`passwordUpdateFailed(UserModel user, LDAPObject ldapUser, UserCredentialModel password, ModelException exception)`
    `UserModel` | MSADLDSUserAccountControlStorageMapper.`proxy(LDAPObject ldapUser, UserModel delegate, RealmModel realm)`

    Constructors in org.keycloak.storage.ldap.mappers.msadlds with parameters of type LDAPObject
    Constructor and Description
    `MSADUserModelDelegate(UserModel delegate, LDAPObject ldapUser)`

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