Login
    Contents x
    Test LDAP Connection
      • Print
      • Dark
        Light
      • PDF
      Contents

      Test LDAP Connection

        • Print
        • Dark
          Light
        • PDF
        Article summary

        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. 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
        Was this article helpful?
        What's Next
        Rocket.Chat versions receive support for six months after release.
        Change password!
        Changing your password will log you out immediately. Use the new password to log back in.
        Change profile
        Success!
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.
        Logout