- 0 minutes to read

Testing the Nodinite LDAP Web API

Validate your Nodinite LDAP Web API installation quickly and confidently using the built-in Swagger UI.

  • ✅ Verify LDAP Web API connectivity with built-in Swagger UI
  • ✅ Test Active Directory operations using JSON and XML payloads
  • ✅ Confirm your connectionId and settings are correct
  • ✅ Validate the GetDomainControllers response before going to production

This guide assumes you have completed the Install and Configuration steps.

Before You Begin

Ensure you have completed these prerequisite steps before testing:

  • Install — The Nodinite LDAP Web API is running in IIS or Azure App Services
  • Configuration — You have configured at least one connection in settings.json with a valid connectionId

Step 1: Open Swagger UI

Navigate to the built-in Swagger UI to explore and test all available API endpoints.

For IIS, use:

http://localhost/LDAPAdapter/swagger/

Replace LDAPAdapter with the virtual directory name you configured during installation. For HTTPS (recommended), use:

https://YOURSERVER/swagger/

Swagger
Screenshot: The built-in Swagger UI for the Nodinite LDAP Web API.

Step 2: Set the connectionId

Before executing any LDAP operations, set the connectionId to the GUID you configured in settings.json.

The connectionId identifies which LDAP server and credentials to use for the operation.

Step 3: Test Active Directory Connectivity

Use the GetDomainControllers operation to verify Active Directory connectivity. This operation typically does not require administrative rights and uses the default port (389).

Set the content type header to match your payload format:

  • JSON — Set content type to application/json
  • XML — Set content type to text/xml or application/xml

JSON Payload 

{
  "RequestId": "b7a211d7-20f3-44bc-b078-7f1b6e1c047f",
  "Batches": [
    {
      "continueOnError": false,
      "guid": "2b25b9e6-4af2-4094-9ae7-e1e4c99b6c8d",
      "AD": {
        "Operations": {
          "GetDomainControllers": {}
        }
      }
    }
  ]
}

XML Payload 

<ns0:LDAP xmlns:ns0="http://integrationsoftware.se/BizTalk/Adapters/LDAP/Request/1.0">
  <Batches guid="2B25B9E6-4AF2-4094-9AE7-E1E4C99B6C8D" returnResponseMessageOnExceptions="true">
    <Batch guid="3B25B9E6-4AF2-4094-9AE7-E1E4C99B6C8E">
      <AD>
        <Operations>
          <GetDomainControllers/>
        </Operations>
      </AD>
    </Batch>
  </Batches>
</ns0:LDAP>

GetDomainControllers
Screenshot: Example result from the GetDomainControllers test in Swagger.

Step 4: Verify the Response

A successful response confirms that the Nodinite LDAP Web API can communicate with your Active Directory server. Review the response and verify it lists the expected domain controllers for your environment.

If the response is empty or returns an error, review your Configuration settings:

  • DSAServer — DNS name or IP address of your domain controller
  • DSAServerPort — Default is 389 (or 636 for encrypted LDAP)
  • UserName and Password — Verify credentials and domain prefix

Frequently Asked Questions

You will find additional solutions to common problems and the FAQ for the Nodinite LDAP Web API in the Troubleshooting user guide.

Next Step

Develop