Test LDAP User Search
- Print
- DarkLight
- PDF
Test LDAP User Search
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
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. 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
401
Unauthorized
Authorization Error
{
"status": "error",
"message": "You must be logged in to do this."
}object
status
string
message
string
Was this article helpful?