Werk #19825: REST API: test LDAP connections and trigger user synchronization
| Component | REST API | ||
| Title | REST API: test LDAP connections and trigger user synchronization | ||
| Date | Jun 11, 2026 | ||
| Level | Prominent Change | ||
| Class | New Feature | ||
| Compatibility | Compatible - no manual interaction needed | ||
| Checkmk versions & editions |
|
You can now test a configured LDAP connection and trigger a user synchronization via the REST API. Both endpoints are available in the unstable API version.
Test an LDAP connection
POST /objects/ldap_connection/{ldap_connection_id}/actions/test/invoke
This runs the same diagnostics as the "Save & test" button on the LDAP connection configuration page — connecting to each configured server, looking up the user and group base DNs, counting users and groups and checking the groups-to-roles sync plug-in — and returns the results in a structured format, grouped by server. The configuration is not modified.
Trigger a user synchronization
POST /domain-types/user_config/actions/sync/invoke
This starts the user synchronization background job, the same one that is triggered by the "Synchronize users" button on the users page. It synchronizes the users of all active user connections (for example LDAP). The endpoint responds with a redirect to the background job status endpoint, which you can poll to follow the progress of the synchronization.