Component: LDAP 
----------------

Query LDAP or Active Directory servers to manager user accounts.

The plugin can query, modify, add and delete values.  
  
FileMaker can use LDAP or Active Directory for authentication. You can manage users in FileMaker database and send updates to your authentication server via our plugin.

| Version | macOS | Windows | Linux | Server | iOS SDK |
|---|---|---|---|---|---|
| [6.0](newinversion60.md "First functions introduced with version 6.0.") / [13.0](newinversion130.md "Newest functions in version 13.0.") | ✅ 97% | ✅ 89% | ✅ 97% | ✅ 97% | ❌ No |

  
| Item | Details | Server |
|:--|:--|:--|
| [LDAP.Add](LDAPAdd.md)  **Deprecated**    Adds an entry to a tree. | Mac/Win/Linux   6.0 | ✅ Server |
| [LDAP.AddJSON](LDAPAddJSON.md)   Adds an entry to a tree. | Mac/Win/Linux   8.0 | ✅ Server |
| [LDAP.AddList](LDAPAddList.md)  **Deprecated**    Adds an entry to a tree. | Mac/Win/Linux   6.4 | ✅ Server |
| [LDAP.AddRecord](LDAPAddRecord.md)  **Deprecated**    Adds an entry to a tree. | Mac/Win/Linux   7.0 | ✅ Server |
| [LDAP.Bind](LDAPBind.md)   Authenticates a client to the LDAP server. | Mac/Win/Linux   6.0 | ✅ Server |
| [LDAP.Connect](LDAPConnect.md)   Initializes an LDAP connection. | Mac/Win/Linux   6.0 | ✅ Server |
| [LDAP.Delete](LDAPDelete.md)   Removes a leaf entry from the directory tree. | Mac/Win/Linux   6.0 | ✅ Server |
| [LDAP.GetBinaryKeys](LDAPGetBinaryKeys.md)   Queries which attributes should be handled as binary data. | Mac/Win/Linux   12.5 | ✅ Server |
| [LDAP.GetNetworkTimeOut](LDAPGetNetworkTimeOut.md)   Queries network timeout value. | Mac/Linux   6.0 | ✅ Server |
| [LDAP.GetProtocolVersion](LDAPGetProtocolVersion.md)   Queries protocol version for this connection. | Mac/Win/Linux   6.0 | ✅ Server |
| [LDAP.GetReferrals](LDAPGetReferrals.md)   Queries the referrals option. | Mac/Win/Linux   6.0 | ✅ Server |
| [LDAP.GetTimeOut](LDAPGetTimeOut.md)   Queries timeout value. | Mac/Linux   6.0 | ✅ Server |
| [LDAP.JSON](LDAPJSON.md)   Queries JSON structure of LDAP data. | Mac/Win/Linux   8.0 | ✅ Server |
| [LDAP.List](LDAPList.md)   Lists all IDs of LDAP connections. | Mac/Win/Linux   13.0 | ✅ Server |
| [LDAP.Modify](LDAPModify.md)  **Deprecated**    Changes an existing entry. | Mac/Win/Linux   6.0 | ✅ Server |
| [LDAP.ModifyJSON](LDAPModifyJSON.md)   Changes an existing entry. | Mac/Win/Linux   8.0 | ✅ Server |
| [LDAP.ModifyRecord](LDAPModifyRecord.md)  **Deprecated**    Changes an existing entry. | Mac/Win/Linux   7.0 | ✅ Server |
| [LDAP.Release](LDAPRelease.md)   Releases the connection. | Mac/Win/Linux   6.0 | ✅ Server |
| [LDAP.ReleaseAll](LDAPReleaseAll.md)   Release all LDAP objects. | Mac/Win/Linux   10.5 | ✅ Server |
| [LDAP.Rename](LDAPRename.md)   Changes the distinguished name of an entry in the directory. | Mac/Win/Linux   6.0 | ✅ Server |
| [LDAP.Search](LDAPSearch.md)   Performs a search. | Mac/Win/Linux   6.0 | ✅ Server |
| [LDAP.SearchResult.AttributeCount](LDAPSearchResultAttributeCount.md)   Queries number of attributes for an entry. | Mac/Win/Linux   6.0 | ✅ Server |
| [LDAP.SearchResult.AttributeName](LDAPSearchResultAttributeName.md)   Returns the name of an attribute in an entry. | Mac/Win/Linux   6.0 | ✅ Server |
| [LDAP.SearchResult.AttributeNames](LDAPSearchResultAttributeNames.md)   Queries all names of attributes for an entry as a list. | Mac/Win/Linux   6.0 | ✅ Server |
| [LDAP.SearchResult.AttributeValue](LDAPSearchResultAttributeValue.md)   Queries a value from search results. | Mac/Win/Linux   6.0 | ✅ Server |
| [LDAP.SearchResult.AttributeValueCount](LDAPSearchResultAttributeValueCount.md)   Queries the number of values for an attribute. | Mac/Win/Linux   6.0 | ✅ Server |
| [LDAP.SearchResult.AttributeValues](LDAPSearchResultAttributeValues.md)   Returns the values for an attribute in an entry. | Mac/Win/Linux   6.0 | ✅ Server |
| [LDAP.SearchResult.AttributeValuesByName](LDAPSearchResultAttributeValuesByName.md)   Returns the values for an attribute in an entry. | Mac/Win/Linux   7.4 | ✅ Server |
| [LDAP.SearchResult.Count](LDAPSearchResultCount.md)   Queries number of entries in search results. | Mac/Win/Linux   6.0 | ✅ Server |
| [LDAP.SearchResult.DistinguishedName](LDAPSearchResultDistinguishedName.md)   Queries distinguished name for an entry in search results. | Mac/Win/Linux   6.0 | ✅ Server |
| [LDAP.SetBinaryKeys](LDAPSetBinaryKeys.md)   Sets which attributes should be handled as binary data. | Mac/Win/Linux   12.5 | ✅ Server |
| [LDAP.SetNetworkTimeOut](LDAPSetNetworkTimeOut.md)   Sets network timeout value. | Mac/Linux   6.0 | ✅ Server |
| [LDAP.SetProtocolVersion](LDAPSetProtocolVersion.md)   Set the protocol version to use. | Mac/Win/Linux   6.0 | ✅ Server |
| [LDAP.SetReferrals](LDAPSetReferrals.md)   Sets the referrals option. | Mac/Win/Linux   6.0 | ✅ Server |
| [LDAP.SetTimeOut](LDAPSetTimeOut.md)   Sets timeout value. | Mac/Linux   6.0 | ✅ Server |
| [LDAP.SimpleBind](LDAPSimpleBind.md)   Authenticates a client to a server, using a plaintext password. | Mac/Win/Linux   6.0 | ✅ Server |
| [LDAP.StartTLS](LDAPStartTLS.md)   Starts encrypted connection. | Mac/Win/Linux   9.3 | ✅ Server |
| [SystemInfo.ADSystemInfo](SystemInfoADSystemInfo.md)   Queries Active Directory information. | Win only   9.3 | ❌ Server |

38 functions shown.

These functions require a license (61%).

### Release notes

- **Version 15.5**
    - Fixed [LDAP.Bind](https://www.mbsplugins.eu/LDAPBind.shtml) to remove ldaps:// or ldap:// prefixes on Windows.
    - Fixed [LDAP.Search](https://www.mbsplugins.eu/LDAPSearch.shtml) to allow call with only 5 parameters.
    - Improved [LDAP.Connect](https://www.mbsplugins.eu/LDAPConnect.shtml) for Windows to remove ldap:// prefix from domain or IP as Windows doesn't like this.
- **Version 13.4**
    - Added check to [LDAP.ModifyJSON](https://www.mbsplugins.eu/LDAPModifyJSON.shtml) and [LDAP.Modify](https://www.mbsplugins.eu/LDAPModify.shtml) to complain if dn is empty.
- **Version 13.0**
    - Added [LDAP.List](https://www.mbsplugins.eu/LDAPList.shtml) function.
    - Added special handling in [LDAP](https://www.mbsplugins.eu/component_LDAP.shtml) functions for returning objectSid and objectGUID values in order to return them formatted.
    - Fixed a bug in [LDAP.Search](https://www.mbsplugins.eu/LDAPSearch.shtml) passing attribute names on macOS.
    - Fixed a memory leak in [LDAP.AddJSON](https://www.mbsplugins.eu/LDAPAddJSON.shtml) and [LDAP.ModifyJSON](https://www.mbsplugins.eu/LDAPModifyJSON.shtml) and added additional checks for the passed in JSON.
- **Version 12.5**
    - Added [LDAP.SetBinaryKeys](https://www.mbsplugins.eu/LDAPSetBinaryKeys.shtml) and [LDAP.GetBinaryKeys](https://www.mbsplugins.eu/LDAPGetBinaryKeys.shtml) functions.
- **Version 11.3**
    - Changed [LDAP.Search](https://www.mbsplugins.eu/LDAPSearch.shtml) to hex encode UUID/GUID entries with 16 raw bytes.
- **Version 10.5**
    - Added [AVExport.ReleaseAll](https://www.mbsplugins.eu/AVExportReleaseAll.shtml), [AVRecorder.ReleaseAll](https://www.mbsplugins.eu/AVRecorderReleaseAll.shtml), [CoreML.ReleaseAll](https://www.mbsplugins.eu/CoreMLReleaseAll.shtml), [DNSLookup.ReleaseAll](https://www.mbsplugins.eu/DNSLookupReleaseAll.shtml), [Dictionary.ReleaseAll](https://www.mbsplugins.eu/DictionaryReleaseAll.shtml), [FM.SQL.ReleaseAll](https://www.mbsplugins.eu/FMSQLReleaseAll.shtml), [JS.ReleaseAll](https://www.mbsplugins.eu/JSReleaseAll.shtml), [JavaScript.ReleaseAll](https://www.mbsplugins.eu/JavaScriptReleaseAll.shtml), [LDAP.ReleaseAll](https://www.mbsplugins.eu/LDAPReleaseAll.shtml), [PDFKit.ReleaseAll](https://www.mbsplugins.eu/PDFKitReleaseAll.shtml), [PKCS12.ReleaseAll](https://www.mbsplugins.eu/PKCS12ReleaseAll.shtml), [PKCS7.ReleaseAll](https://www.mbsplugins.eu/PKCS7ReleaseAll.shtml), [PKey.ReleaseAll](https://www.mbsplugins.eu/PKeyReleaseAll.shtml), [SSH.ReleaseAll](https://www.mbsplugins.eu/SSHReleaseAll.shtml), [WinSendMail.ReleaseAll](https://www.mbsplugins.eu/WinSendMailReleaseAll.shtml), [WindowsML.ReleaseAll](https://www.mbsplugins.eu/WindowsMLReleaseAll.shtml), [WordFile.ReleaseAll](https://www.mbsplugins.eu/WordFileReleaseAll.shtml), and [X509.ReleaseAll](https://www.mbsplugins.eu/X509ReleaseAll.shtml).
- **Version 10.3**
    - Added option to [LDAP.AddJSON](https://www.mbsplugins.eu/LDAPAddJSON.shtml) and [LDAP.ModifyJSON](https://www.mbsplugins.eu/LDAPModifyJSON.shtml) to include boolean keys "hex" and "base64" in JSON with true value to pass values as hex/base64 string, which the plugin decodes and passes to LDAP server.
- **Version 10.1**
    - Deprecated [LDAP.Add](https://www.mbsplugins.eu/LDAPAdd.shtml), [LDAP.AddList](https://www.mbsplugins.eu/LDAPAddList.shtml), [LDAP.AddRecord](https://www.mbsplugins.eu/LDAPAddRecord.shtml) in favor of [LDAP.AddJSON](https://www.mbsplugins.eu/LDAPAddJSON.shtml).
    - Deprecated [LDAP.Modify](https://www.mbsplugins.eu/LDAPModify.shtml) and [LDAP.ModifyRecord](https://www.mbsplugins.eu/LDAPModifyRecord.shtml) in favor of [LDAP.ModifyJSON](https://www.mbsplugins.eu/LDAPModifyJSON.shtml).
    - Fixed crash in [LDAP.AddJSON](https://www.mbsplugins.eu/LDAPAddJSON.shtml) with invalid data by improving error handling.
- **Version 9.3**
    - Fixed issue with [LDAP](http://www.mbsplugins.eu/component_LDAP.shtml) functions sometimes not passing attributes correctly on MacOS.

### Blog Entries

- [MBS FileMaker Plugin, version 12.6pr1](https://www.mbsplugins.de/archive/2022-12-01/MBS_FileMaker_Plugin_version_1/monkeybreadsoftware_blog_filemaker)
- [MBS FileMaker Plugin 12.5 News](https://www.mbsplugins.de/archive/2022-11-17/MBS_FileMaker_Plugin_125_News/monkeybreadsoftware_blog_filemaker)
- [Embrace JSON](https://www.mbsplugins.de/archive/2020-09-29/Embrace_JSON/monkeybreadsoftware_blog_filemaker)
- [MBS FileMaker Plugin 10.3 - More than 6200 Functions In One Plugin](https://www.mbsplugins.de/archive/2020-07-21/MBS_FileMaker_Plugin_103_-_Mor/monkeybreadsoftware_blog_filemaker)
- [MBS FileMaker Plugin, version 9.3pr3](https://www.mbsplugins.de/archive/2019-06-21/MBS_FileMaker_Plugin_version_9/monkeybreadsoftware_blog_filemaker)
- [MBS FileMaker Plugin, version 8.4pr5](https://www.mbsplugins.de/archive/2018-08-27/MBS_FileMaker_Plugin_version_8/monkeybreadsoftware_blog_filemaker)
- [MBS FileMaker Plugin 8.0 - More than 5000 Functions In One Plugin](https://www.mbsplugins.de/archive/2018-01-23/MBS_FileMaker_Plugin_80_-_More/monkeybreadsoftware_blog_filemaker)
- [LDAP with JSON](https://www.mbsplugins.de/archive/2017-12-11/LDAP_with_JSON/monkeybreadsoftware_blog_filemaker)
- [MBS FileMaker Plugin 6.4 for OS X/Windows](https://www.mbsplugins.de/archive/2016-09-27/MBS_FileMaker_Plugin_64_for_OS/monkeybreadsoftware_blog_filemaker)
- [MBS FileMaker Plugin 6.0 for OS X/Windows](https://www.mbsplugins.de/archive/2016-01-28/MBS_FileMaker_Plugin_60_for_OS/monkeybreadsoftware_blog_filemaker)

### FileMaker Magazin

- [Ausgabe 6/2020, Seite 25](https://filemaker-magazin.de/neuigkeit/4118-Appetithappen-FMM_202006)
- [Ausgabe 5/2020, Seite 20](https://filemaker-magazin.de/neuigkeit/4110-Appetithappen-FMM_202005)

### Example Databases

- [Network/LDAP Query](https://www.mbsplugins.eu/MBS-FileMaker-Plugin-Examples/Network/LDAP%20Query.shtml#1ScriptAnchor_)

[HTML Version](component_LDAP.shtml)