Adapter - Ldap Search
This page describes version 2.0.7 of the adapter.
Overview
This adapter is used to perform simple LDAP searches.
Properties
| Name | Display | Is Required | Comments | Type | Default Value | Maximum Value | Minimum Value | Maximum Length | Minimum Length |
|---|---|---|---|---|---|---|---|---|---|
| ldapserver | LDAP Server Hostname | True | The hostname of the LDAP server e.g. ldap.nec.com | string | 1024 | 1 | |||
| port | LDAP Server Port | True | The port number to connect to the LDAP server, typically 636 for secure connections and 389 for insecure connections | integer | 636 | 1024 | 1 | ||
| ssl | SSL/TLS | False | Use secure connection to LDAP server (TLS) | boolean | true | ||||
| userDN | User DN | False | The user distinguished name that will be used for authentication. | string | 100 | 1 | |||
| baseDN | Base DN | False | The base distinguished name to search from. | string | 100 | 1 | |||
| userPassword | User Password | False | The user password that will be used for authentication. | password | 100 | 1 | |||
| searchTimeout | LDAP Search timeout | False | Seconds to hang-up LDAP search. | integer | 15 | 120 | 0 |
Commands
Search (search)
Searches the LDAP database using the specified filters.
Request Properties
| Name | Display | Description | Is Required | Type |
|---|---|---|---|---|
| baseDN | Base DN | The base distinguished name to search from. | False | string |
| scope | Search Scope | The scope of LDAP entries to search. (BASE, ONE and SUB) | True | string |
| filter | Filter | The LDAP filter string. Must be RFC 2254 compliant. | True | string |
| attributes | Attributes | The LDAP entry attribute type to return. | True | string |
| slimit | Search limit | The maximum number of LDAP entries to retrieve. | False | string |
Response Properties
| Name | Description | Type |
|---|---|---|
| ldapItems | An array of LDAP Items that were found in the search. | array |
| ldapItems[0].dn | The distinguished name. | string |
| ldapItems.attributes | The list of attributes. | array |
| codenum | The code of result. | string |
Release History
| Version | Type | Description | Tracking # | Date |
|---|---|---|---|---|
| 2.0.1 | Initial | First release in the Adapter Type store. | ||
| 2.0.5 | Maintenance | Updated third-party components and improved maintainability. | NAP-11518 | |
| 2.0.6 | Maintenance | Updated third-party components and improved maintainability. | NAP-23945 | 2022-11-29 |
| 2.0.7 | Maintenance | Updated third-party components and improved maintainability. | NAP-27635 | 2024-07-31 |