> For the complete documentation index, see [llms.txt](https://community-test.logicnets.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://community-test.logicnets.com/release-9/platform-documentation/process-node-parts/ldap-query.md).

# LDAP Query

## Description

This part can be used to query LDAP directories.

## Use

You can add the *LDAP query* part into a process node and the system will execute the query.

## Editor Fields

| Field Name                     | Description/Use                                                                                                                                                                                                                                                                         | Type/Options                 | Optional/Mandatory |
| ------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------- | ------------------ |
| Result data object             | This is the path of the data object where the system stores the query result.                                                                                                                                                                                                           | Data Object                  | Mandatory          |
| Server                         | This is the LDAP server name: e.g. [ldap.forumsys.com](http://ldap.forumsys.com)                                                                                                                                                                                                        | String                       | Mandatory          |
| Username                       | This is the user name.                                                                                                                                                                                                                                                                  | String                       | Mandatory          |
| Password                       | This is the password.                                                                                                                                                                                                                                                                   | String                       | Mandatory          |
| Base                           | This is the LDAP base. The distinguished name of the entry at which to start the search.                                                                                                                                                                                                | String                       | Mandatory          |
| Filter                         | Search filter as defined in RFC2254.                                                                                                                                                                                                                                                    |                              | Optional           |
| Attributes                     | This is the list of attributes that must be returned. All available attributes are returned when no attribute is set                                                                                                                                                                    | Collection                   | Optional           |
| Scope                          | <p><strong>Base:</strong> Search the base entry only.<br><strong>One level:</strong> Search all entries in the first level below the base entry, excluding the base entry.<br><strong>Subtree (default):</strong> Search the base entry and all entries in the tree below the base.</p> | Subtree \| Base \| One level | Mandatory          |
| Attribute names only/no values | If set, the system system returns no values are returned but returns the attribute names.                                                                                                                                                                                               | Boolean                      | Mandatory          |
| Time-out (sec)                 | This field specifies both the local search time-out value in seconds and the operation time limit sent to the server within the search request.                                                                                                                                         | Number                       | Optional           |
| Size limit                     | This is the limit on the number of entries to return from the search. A value of zero indicates no limit.                                                                                                                                                                               | Number                       | Optional           |

## Example Filters

| Search Filter                                                             | Description                                               |
| ------------------------------------------------------------------------- | --------------------------------------------------------- |
| (objectClass=\*)                                                          | All objects                                               |
| (&(objectCategory=person)(objectClass=user)(!(cn=andy)))                  | All user objects but "andy"                               |
| (sn=sm\*)                                                                 | All objects with a surname that starts with "sm"          |
| (&(objectCategory=person)(objectClass=contact)(\|(sn=Smith)(sn=Johnson))) | All contacts with a surname equal to "Smith" or "Johnson" |

## Example

Download and import the following [example project](/release-9/example-gallery/example-projects-for-parts/ldap-query-example-project.md) in your workspace.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://community-test.logicnets.com/release-9/platform-documentation/process-node-parts/ldap-query.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.