# LDAP Output

## <img src="/files/dpfnN9QqoSvPgZ41wjVE" alt="" data-size="line"> LDAP Output

### Description <a href="#description" id="description"></a>

The LDAP Output transform allows you to write information like users, roles and other data to an LDAP server.

The following sections describe the available options for the LDAP Output transform.

| Hop Engine | <sup>✓</sup> |
| ---------- | ------------ |
| Spark      | ?            |
| Flink      | ?            |
| Dataflow   | ?            |

### General Tab

| Option                 | Description                                                                                                                                                                                                                                                                         |
| ---------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Transform name         | Name of the transform; this name has to be unique in a single pipeline.                                                                                                                                                                                                             |
| Host                   | Host can be the IP address of the LDAP directory server or its DNS name.                                                                                                                                                                                                            |
| Port                   | Port number of LDAP directory server.                                                                                                                                                                                                                                               |
| Referral               | <p>Determines how to handle referrals.</p><ul><li>Ignore: Ignore referrals.</li><li>Follow: Automatically follow any referrals.</li></ul>                                                                                                                                           |
| Derefalias             | <p>Determines how aliases are dereferenced.</p><ul><li>Always: Always dereference aliases.</li><li>Never: Never dereference aliases.</li><li>Finding: Dereference aliases only during name resolution.</li><li>Searching: Dereference aliases only after name resolution.</li></ul> |
| Protocol               | <p>Determines which protocol is used.</p><ul><li>LDAP</li><li>LDAP SSL</li><li>LDAP TLS</li></ul>                                                                                                                                                                                   |
| Use authentication     | To enable LDAP authentication.                                                                                                                                                                                                                                                      |
| Username               | The username to be passed during authentication.                                                                                                                                                                                                                                    |
| Password               | The password to be passed during authentication.                                                                                                                                                                                                                                    |
| Use certificate        | To enable the use of a certificate.                                                                                                                                                                                                                                                 |
| Trust store path       |                                                                                                                                                                                                                                                                                     |
| Trust store password   |                                                                                                                                                                                                                                                                                     |
| Trust all certificates |                                                                                                                                                                                                                                                                                     |
| Test connection        | Tests the configured connection to the LDAP server.                                                                                                                                                                                                                                 |

### Settings

| Option                       | Description                                                                   |
| ---------------------------- | ----------------------------------------------------------------------------- |
| Operation                    | Insert, Update, Upsert, Add atribute, Delete, Rename DN (distinguished name). |
| Multi valued field seperator |                                                                               |
| Fail if not exist            |                                                                               |
| Dn fieldname                 | Field which contains the distinguished name.                                  |
| Old DN fieldname             | Field which contains the old distinguished name (rename).                     |
| New DN fieldname             | Field which contains the new distinguished name (rename).                     |
| Delete RDN                   | Whether or not to delete the RDN (relative distinguished name)                |

### Fields Tab

| Option                 | Description                               |
| ---------------------- | ----------------------------------------- |
| Search base for fields | Where to start looking for fields         |
| Attributes             |                                           |
| Stream field           |                                           |
| Update                 | Whether or not to update the fields (Y/N) |
| Get fields             |                                           |
| Edit mapping           |                                           |


---

# Agent Instructions: Querying This Documentation

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

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.primeur.com/data-shaper-1.21/knowing-the-data-shaper-designer/pipelines/transforms/ldapoutput.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.