test-ldap-connection.md

Test LDAP Connection

Test if Rocket.Chat can connect to the specified LDAP server using the port and host provided in the Rocket.Chat settings.

HTTP Method	URL	Requires Auth
POST	/api/v1/ldap.testConnection	yes

{% hint style="info" %}

• Permission required: test-admin-options
• Make sure that LDAP is enabled on your workspace. {% endhint %}

Example Call

curl --location --request POST 'http://localhost:3000/api/v1/ldap.testConnection' \
--header 'X-Auth-Token: x65a7F7aZZtW_H2hTgKEsp_RGNqvoyF' \
--header 'X-User-Id: CkCPNcvfmWLqC'

Example Response

{
    "message": "Connection_success",
    "success": true
}

{
    "message": "Connection_failed",
    "success": false
}