Skip to content

LDAP

The LDAP check:

  • Binds using the provided username and password to the LDAP host. It supports LDAP/LDAPS protocols.
  • Searches an object type in the provided bindDN.
apiVersion: canaries.flanksource.com/v1
kind: Canary
metadata:
  name: ldap-check
spec:
  interval: 30
  ldap:
    - name: ldap-org
      host: ldap://apacheds.ldap.svc:10389
      username:
        # value: uid=admin,ou=system
        valueFrom:
          secretKeyRef:
            name: ldap-credentials
            key: USERNAME
      password:
        valueFrom:
          secretKeyRef:
            name: ldap-credentials
            key: PASSWORD
      bindDN: ou=users,dc=example,dc=com
      userSearch: "(&(objectClass=organizationalPerson))"
Field Description Scheme Required
name Name of the check string Yes
bindDN BindDN to use in query string Yes
userSearch UserSearch to use in query string Yes
* All other common fields Common
Connection
connection Path of existing connection e.g. connection://alertmanager/instance/ Mutually exclusive with username, password, host Connection
host Host endpoint mutually exclusive with connection string
username Mutually exclusive with connection EnvVar
password Mutually exclusive with connection EnvVar
skipTLSVerify Skip check of LDAP server TLS certificates bool