LDAP Documentation

This interface uses the LDAP protocol version 3 for communication.

Endpoint

ldaps://mail.zorgmail.nl:636

Authentication

HTTP Basic authentication is required, use your application or personal credentials.

Bind DN

Only the username is required in the uid.

For example: uid=012345678

Search base

ou=se,dc=zorgmail

Search filter syntax

Only search terms are used. Ldap search syntax is ignored. The reserved words "and" and "or" will not be used as term, but as operator (default operator is "and").

Search preferences

In addition to the search filter that user has provided, ldap server will also filter the result based on user's search preferences, if any.

Configure your ZorgMail account preferences at https://www.zorgmail.nl/account

Returns

The maximum entries to be returned is 100.

Also when more entries are found, result code will be 0.

Attributes to return
Name Type Description
uid string ZorgMail Mailbox id, also known as Customer number ('Klantnummer').
cn string Summary of the mailbox profile, the identity of the addressee.
displayName string Summary of the mailbox profile, the identity of the addressee.
mail string Default ZorgMail Secure e-mail address.
title string Role of person or practice.
employeeNumber string AGB-practitioner code: pratitioner type N02 + practitioner number N06. Leading zero's added to fixed length.
personalTitle string Represent the gender.
sn string Surname. For non-human equal to the department or organization.
givenName string The surname prefix is intentionally included in the givenname to sort on surname without prefix, which is expected in NL, givenName is not returned for non human.
ou string Department in organization.
departmentNumber string AGB-practice code: practice type N02 + practice number N06. Leading zero's added to fixed length.
o string Organization name.
street string Street, House number and additions.
postalAddress string Street, House number and additions.
postalCode string Postal code.
l string Locality or City.
co string Country name.
telephoneNumber string Telephone number of organization.
objectClass For best interoperability we return: top, person, initOrgPerson, extensibleObject.

* Empty value fields will not be returned.

Example request and response

Searching the 'Fysiotherapie' in 'Amsterdam' using ldapsearch command would use the following LDAP Request:
ldapsearch -H ldaps://mail.zorgmail.nl:636 -D uid=999999990 -W -b "ou=se,dc=zorgmail" "(&(cn=fysiotherapie)(cn=amsterdam))"
The returned results:
# extended LDIF
#
# LDAPv3
# base  with scope subtree
# filter: (&(cn=fysiotherapie)(cn=praktijk)(cn=and))
# requesting: ALL
#

# 999999990, se, zorgmail
dn: uid=999999990,ou=se,dc=zorgmail
postalCode: 1111 AA
personalTitle: M
title: Fysiotherapeut
uid: 999999990
employeeNumber: 00000000
givenName: T
ou: Fysiotherapie
organizationalUnitName: Fysiotherapie
objectClass: top
objectClass: person
objectClass: inetOrgPerson
objectClass: extensibleObject
cn: T. Test
sn: Test
co: NEDERLAND
telephoneNumber: 020-1111111
street: Rivium Westlaan
streetAddress: Rivium Westlaan
mail: t.test@zorgmail.nl
l: AMSTERDAM
o: Praktijk voor Fysiotherapie
organizationName: Praktijk voor Fysiotherapie
displayName: T. Test

# 999999999, se, zorgmail
dn: uid=999999999,ou=se,dc=zorgmail
postalCode: 1111 AB
personalTitle: F
title: Fysiotherapeut
uid: 999999999
departmentNumber: 00000000
objectClass: top
objectClass: person
objectClass: inetOrgPerson
objectClass: extensibleObject
cn: Fysiotherapie
sn: Fysiotherapie
co: NEDERLAND
telephoneNumber: 020-1111111
street: Rivium Westlaan
streetAddress: Rivium Westlaan
mail: fysiotherapieriviumwestlaan@zorgmail.nl
l: AMSTERDAM
o: Praktijk voor Fysiotherapie Rivium
organizationName: Praktijk voor Fysiotherapie Rivium
displayName: Praktijk voor Fysiotherapie Rivium

# search result
search: 2
result: 0 Success

# numResponses: 3
# numEntries: 2