> For the complete documentation index, see [llms.txt](https://docs.tpi.dev/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.tpi.dev/guide/client-management/gtw-ldap-idp.md).

# GTW LDAP IdP

<mark style="color:green;">**Path: Client Management > GTW LDAP IdP**</mark>

In this section, you can find instructions on how to maintain the LDAP/Windows AD authentication servers using the gateway.

![](https://content.gitbook.com/content/0choIC1BbdPOkKWOYGgk/blobs/cyMoxLDss231ZSMJCt5N/0.png)

### Search GTW LDAP IdP <a href="#toc169186061" id="toc169186061"></a>

To search for GTW LDAP IdP, you can search using the relevant information as keywords.

<figure><img src="https://content.gitbook.com/content/0choIC1BbdPOkKWOYGgk/blobs/pUUpeE5LEa9x2liGdd67/1.png" alt=""><figcaption></figcaption></figure>

### Client ID of GTW LDAP IdP <a href="#toc169186062" id="toc169186062"></a>

1. To view the details of GTW LDAP IdP, you can search using the relevant information as keywords, and click on the ![](https://content.gitbook.com/content/0choIC1BbdPOkKWOYGgk/blobs/83PnOBDJvVSbdwqbaB97/2.png) icon to access the **Client ID** page.

<figure><img src="https://content.gitbook.com/content/0choIC1BbdPOkKWOYGgk/blobs/VfNrzQ1ctmAAYRcd9ylI/3.png" alt=""><figcaption></figcaption></figure>

2. Users can create, update, view details, and delete them from client IDs.

<figure><img src="https://content.gitbook.com/content/0choIC1BbdPOkKWOYGgk/blobs/DVXdMcypDpGZmc4peFmd/4.png" alt=""><figcaption></figcaption></figure>

#### **Create Client ID**

In this section, you can find instructions on how to add an LDAP connection information under this client ID.

1. Click **Create** to access the creation page.

<figure><img src="https://content.gitbook.com/content/0choIC1BbdPOkKWOYGgk/blobs/Rlt52tELKKYzMb5lPT1t/5.png" alt=""><figcaption></figcaption></figure>

2. Fill in the data or make selections as instructed below. The fields marked with “<mark style="color:red;">\*</mark>” are required.

* **Client Id**<mark style="color:red;">\*</mark>**:** A unique identifier used by third-party applications for identification and accessing protected resources.
* **Enable**<mark style="color:red;">\*</mark>**:** This account is active (**Y**) or inactive (**N**).
* **Remark:** User's comments.
* **URL**<mark style="color:red;">\*</mark>**:** LDAP / Windows AD host location, one URL can be created.
* **Base DN**<mark style="color:red;">\*</mark>**:** Specify the start or root node for the search in the LDAP directory tree.
* **Bind DN**<mark style="color:red;">\*</mark>**:** A node in the LDAP directory tree used to verify the identity of a user or application for appropriate actions in the directories.
* **Timeout(ms)**<mark style="color:red;">\*</mark>**:** Expiration time (unit: milliseconds).
* **Page Title**<mark style="color:red;">\*</mark>**:** Header of the login page.
* **Icon:** Click **Choose file** to select and upload an identifiable LDAP image.

3. Click **Create** to save and exit.

<figure><img src="https://content.gitbook.com/content/0choIC1BbdPOkKWOYGgk/blobs/MJmIdtasP6MCmi71kBFj/6.png" alt=""><figcaption></figcaption></figure>

#### **View Client ID**

Search for the client ID you want to view details, and click on the ![](https://content.gitbook.com/content/0choIC1BbdPOkKWOYGgk/blobs/afFViK8xjzlvTofzYCeG/7.png)icon to access the **Details** page.

<figure><img src="https://content.gitbook.com/content/0choIC1BbdPOkKWOYGgk/blobs/Do1nS8OmorPFPiuKlYZR/8.png" alt=""><figcaption></figcaption></figure>

![](https://content.gitbook.com/content/0choIC1BbdPOkKWOYGgk/blobs/pYoFjeWAOMsv1ZPOv6wq/9.png)

#### **Update Client ID**

1. Search for the client ID to modify, and click on the ![](https://content.gitbook.com/content/0choIC1BbdPOkKWOYGgk/blobs/owB6cBpdamJ4xxJICkPn/10.png) icon to access the update page.

![](https://content.gitbook.com/content/0choIC1BbdPOkKWOYGgk/blobs/xZLegVw46G8j42HYvrSH/11.png)

2. Modify the desired fields, and click **Update** to save and exit.

![](https://content.gitbook.com/content/0choIC1BbdPOkKWOYGgk/blobs/hLgnXECY0msZhEbpCG9A/12.png)

#### **Delete Client ID**

1. Select the client ID to delete, and click on the ![](https://content.gitbook.com/content/0choIC1BbdPOkKWOYGgk/blobs/kWI7I8TlXESiaATHJ5yN/13.png) icon to proceed.

![](https://content.gitbook.com/content/0choIC1BbdPOkKWOYGgk/blobs/ujGXU5XZt7SHbmeUkhqK/14.png)

2. A warning prompt displaying the message “**Confirm Delete?**” will pop up. Click **Confirm** to delete this client ID and exit.

<div align="left"><img src="https://content.gitbook.com/content/0choIC1BbdPOkKWOYGgk/blobs/x2V2RIzkhuCE5YxlEHDY/15.png" alt="" width="488"></div>


---

# 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.tpi.dev/guide/client-management/gtw-ldap-idp.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.
