v13

latestOpenAPI 3.0.0zlibraw.githubusercontent.com2026-08-01265409652.5 KB
ldap

Test LDAP connectivity

Test LDAP connectivity using LDAP details Access policy: administrator

post/ldap/check

Request body

Example request

{
  "LDAPSettings": {
    "AnonymousMode": true,
    "AutoCreateUsers": true,
    "GroupSearchSettings": [
      {
        "GroupAttribute": "member",
        "GroupBaseDN": "dc=ldap,dc=domain,dc=tld",
        "GroupFilter": "(objectClass=account"
      }
    ],
    "Password": "readonly-password",
    "ReaderDN": "cn=readonly-account,dc=ldap,dc=domain,dc=tld",
    "SearchSettings": [
      {
        "BaseDN": "dc=ldap,dc=domain,dc=tld",
        "Filter": "(objectClass=account)",
        "UserNameAttribute": "uid"
      }
    ],
    "StartTLS": true,
    "TLSConfig": {
      "TLS": true,
      "TLSCACert": "/data/tls/ca.pem",
      "TLSCert": "/data/tls/cert.pem",
      "TLSKey": "/data/tls/key.pem"
    },
    "URL": "myldap.domain.tld:389"
  }
}

Response

Success