Preview the changes a full LDAP sync would make

Uses the settings from the request body, which do not have to be saved yet. Read-only: nothing is imported, removed or persisted.

post

Authorizations

cookieapi_token

defguard_sessionstringRequired

Body

application/json

objectOptional

Responses

200

Dry run result.

application/json

objectOptional

400

Unable to connect to LDAP or to perform the dry run.

401

Session is missing or invalid.

application/json

403

Requires admin privileges and an active enterprise license.

application/json

500

Unable to perform LDAP dry run.

application/json

post/api/v1/ldap/dry_run

HTTPcURLJavaScriptPython

POST /api/v1/ldap/dry_run HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

{
  "defguard": [
    {
      "action": "add",
      "email": "[e-mail]",
      "first_name": "Jane",
      "last_name": "Doe",
      "username": "jane"
    }
  ],
  "ldap": [
    {
      "action": "remove",
      "email": "[e-mail]",
      "first_name": "John",
      "last_name": "Doe",
      "username": "john"
    }
  ]
}