Werk #18500: REST-API: Site management: add authentication_connections

Component	REST API
Title	REST-API: Site management: add authentication_connections
Date	Aug 10, 2026
Level	Trivial Change
Class	New Feature
Compatibility	Incompatible - Manual interaction might be required
Checkmk versions & editions	3.0.0b1 Not yet released Checkmk Community, Checkmk Pro, Checkmk Ultimate, Checkmk Cloud, Checkmk Ultimate MT

With version 3.0.0 Checkmk gained new ways to authenticate users on remote sites. It's now possible to specify that a user can log in to a remote site using SAML.

The underlying data structures of Checkmk changed, and the previous schema of the site management endpoints was not able to represent the new structure. We therefore decided to change the REST-API in place instead of introducing new unstable endpoints.

authentication_connections is now a required key with no default.

Endpoints that gain the new key in their output: * GET /api/1.0/domain-types/site_connection/collections/all * GET /api/1.0/objects/site_connection/{site_id}

Endpoints that require the new key in their input: * POST /api/1.0/domain-types/site_connection/collections/all * PUT /api/1.0/objects/site_connection/{site_id}

Endpoints that do not change: * POST /api/1.0/objects/site_connection/{site_id}/actions/delete/invoke * POST /api/1.0/objects/site_connection/{site_id}/actions/login/invoke * POST /api/1.0/objects/site_connection/{site_id}/actions/logout/invoke

Example values of the new key (authentication_connections):

"authentication_connections": {
  "type": "disabled"
}

"authentication_connections": {
  "type": "all",
  "connection_types": [
    "ldap",
    "saml"
  ]
}

"authentication_connections": {
  "type": "list",
  "connections": [
    {
      "type": "ldap",
      "connection_id": "LDAP_1"
    },
    {
      "type": "saml",
      "connection_id": "saml_1"
    }
  ]
}

For more information, please take a look at the built-in REST-API documentation of Checkmk.

To the list of all Werks