Test LDAP Connection

Prev Next
Post
/api/v1/ldap.testConnection

Test if Rocket.Chat can connect to the specified LDAP server using the port and host provided in the Rocket.Chat settings. Make sure LDAP is enabled in Settings > LDAP > Enable before using this endpoint.

Permission required: test-admin-options

Header parameters
X-Auth-Token
stringRequired

The authenticated user token.

ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired

The authenticated user ID.

ExamplerbAXPnMktTFbNpwtJ
Responses
200

OK

Success Example
{
  "message": "Connection_success",
  "success": true
}
object
message
string
success
boolean
401

Unauthorized

Authorization Error
{
  "status": "error",
  "message": "You must be logged in to do this."
}
object
status
string
message
string