DKBSignDocs

API reference

POSTRequires Bearer token

Test LDAP connection

/api/contacts/ldap-connections/{connection_id}/test

Bind and return a small sample of entries (ok, sample_count, sample, error).

Path parameters

FieldTypeDescription
connection_id
Required
stringPath parameter connection_id.

Query parameters

This endpoint has no query parameters.

Request body

This endpoint does not accept a request body.

Responses

StatusMeaning
200Bind ok
401Missing or invalid Bearer token.

Request

curl
curl -X POST 'https://api.dkbsigns.com/api/contacts/ldap-connections/uuid_or_id/test' \
  -H 'Authorization: Bearer $DKBSIGN_TOKEN'

Response 200

json
{
  "ok": true,
  "sample_count": 5,
  "sample": [
    {
      "mail": "ada@acme.test"
    }
  ],
  "error": null
}