> For the complete documentation index, see [llms.txt](https://docs.amitysolutions.com/ekoai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.amitysolutions.com/ekoai/getting-started/eko/eko-ad-sync/prerequisites-and-installation-requirements/active-directory-ad-configuration-details.md).

# Active Directory (AD) Configuration Details

To successfully integrate the Eko Active Directory Connector (EkoADC) with your organization's directory service, the customer must provide specific configuration details related to their Active Directory (AD) or LDAP-compatible system. These details are necessary for Amity Solutions to configure the EkoADC software and enable secure synchronization and authentication processes.

## 1. Required AD Connection Details

The following information ensures EkoADC can establish and maintain communication with your on-premises Active Directory.

<table><thead><tr><th width="192.91796875">Configuration Detail</th><th width="235.25390625">Example Value</th><th>Description</th></tr></thead><tbody><tr><td>LDAP/Active Directory IP address</td><td><code>ldaps://x.x.x.x</code></td><td>The network address used by EkoADC to locate the AD server.</td></tr><tr><td>Protocol</td><td>LDAPS (Recommended)</td><td>Specifies the protocol used: LDAP or the secure version, LDAPS.</td></tr><tr><td>Port</td><td>636</td><td>The network port utilized for the connection (e.g., 636 for LDAPS or 389 for standard LDAP).</td></tr><tr><td>LDAP Username</td><td></td><td>The designated account used by EkoADC to bind and search the AD.</td></tr><tr><td>LDAP Password</td><td></td><td>The corresponding password for the LDAP Username.</td></tr><tr><td>Base DN</td><td><code>DC=EXAMPLE,DC=COM</code></td><td>The starting point (distinguished name) in the directory tree where EkoADC begins searching for users.</td></tr><tr><td>Group DN</td><td><code>DC=EXAMPLE,DC=COM</code> (Optional)</td><td>Specifies a distinguished name if synchronization is required for users belonging to only a specific group.</td></tr><tr><td>Filter</td><td><code>(objectclass=user)</code> (Optional)</td><td>A special filter that can be used to restrict the types of objects (e.g., only user accounts) that EkoADC synchronizes.</td></tr></tbody></table>

## 2. Required AD Attributes

For accurate user provisioning, EkoADC needs to map specific attributes from the Active Directory schema to the corresponding fields in the Eko Database. The customer must confirm which AD attributes will supply the necessary user data.

Required attributes include fields such as:

* Unique ID
* Username (e.g., `sAMAccountName`)
* Firstname (e.g., `givenName`)
* Lastname (e.g., `sn`)
* Email (e.g., `mail`)
* Telephone Number
* Office
* Title
* Department
* Company

These attributes enable features like mapping the `sAMAccountName` to the Eko fields `username` and `network_uid`.

> For Eko Call integration, specific attributes such as `ipPhone`, `pager`, and `telephoneNumber` are also mapped to corresponding Eko Call fields like `ext_number`, `class_of_service`, and `did_number`.

## 3. Additional Configuration Parameters

The configuration may also include settings related to user data handling. However, these are typically managed by Amity Solutions:

* **User Search Limit**: Defines the maximum number of users fetched per search operation (e.g., 10000).
* Login Pattern.
* Time Offset.
* **Proxy Configuration**: If the EkoADC needs to communicate externally through a customer proxy, proxy details (`protocol`, `host`, `port`, `username`, `password`) are required in the `proxy` section of the configuration.


---

# 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 dynamically by asking a question.

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

```
GET https://docs.amitysolutions.com/ekoai/getting-started/eko/eko-ad-sync/prerequisites-and-installation-requirements/active-directory-ad-configuration-details.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.