---
updatedAt: 2025-07-15T09:33:15.000Z
agentTools:
  projectIndex: https://docs.appery.io/llms.txt
---

# LDAP Component

Using the LDAP component to invoke a REST API.

The **LDAP** component allows you to invoke an **LDAP API**.

## Lightweight Directory Access Protocol

LDAP stands for Lightweight Directory Access Protocol. It is an application software protocol for enabling anyone to locate organizations, individuals, and other resources such as files and devices in a network, whether on the public Internet or on a corporate intranet.

If you or your organization has an LDAP server used to enable user login via custom security, you can use this **LDAP** component.

## LDAP Service

In the **LDAP Service** section, you can set:

* Provider type
* Host
* Port
* User DN
* Username
* Password
* Base DN
* Object classes
* User login name field

In case of successful invoking of LDAP, the response of the **LDAP** component is

```json Successful response
{"status": "success", "user": {} }
```

In case of failed invoking of the **LDAP** component, the response is

```json Failed response
{"status": "failed", "message": "Detailed information about error" }
```

## LDAPS

Appery.io also supports LDAP over SSL (or LDAPS) protocol.

LDAPS URLs use SSL connections instead of plain (i.e., unprotected) connections. They have a syntax similar to LDAP URLs except the schemes are different, and the default port for LDAPS URLs is 636 instead of 389.