Test LDAP User Search

Prev Next
Post
/api/v1/ldap.testSearch

Test if a given username can be found in the LDAP server using the authentication and filter settings provided to Rocket.Chat. 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
Body parameters
Example 1
{
  "username": "bob"
}
object
username
string Required

The username that you want to search.

Examplebob
Responses
200

OK

Success Example
{
  "message": "LDAP_User_Found",
  "success": true
}
object
message
string
success
boolean
400

Bad Request

Example 1
{
  "success": false,
  "error": "Match error: Missing key 'username'"
}
object
success
boolean
error
string
401

Unauthorized

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