Connects to the LDAP server with the given settings and binds with the bind DN. This is Test connection in the console. Nothing is saved.

Method and path	POST /plugin/datafor-ldap/api/application/verifyConfig
Permission	Administrator user type; the LDAP plugin must be installed
Content type	application/json

Parameters

The body takes the same fields as Save LDAP config. The test uses url, initial, authtype, dn and secret.

Example

curl -u admin:password -X POST \
  "http://localhost:28080/datafor/plugin/datafor-ldap/api/application/verifyConfig" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "ldap://ldap.example.com:389",
    "initial": "com.sun.jndi.ldap.LdapCtxFactory",
    "authtype": "simple",
    "dn": "cn=admin,dc=example,dc=com",
    "secret": "bind-password"
  }'

{ "success": true }

When the server cannot be reached or the bind fails, the response has success: false and the reason in msg.

Related: LDAP Integration Configuration