All Collections
Active Directory Integration
Active Directory Integration

Can I automatically sync employee contact records using a service such as AD or LDAP?

Updated over a week ago


To sync your Active Directory with our system, you'll want to start with the PowerShell template we provide. It can be easily configured and/or modified to connect to your Active Directory, export users to a CSV file, and upload the CSV to our servers for processing. To use this template, you will need to be familiar with the following:

  1. PowerShell (version 3 or above)

  2. The names of the Organization Unit(s) in Active Directory to be synced with our system

  3. Scheduling jobs with the PowerShell script

Getting Started

Navigate to the Active Directory Integration page on the web portal to find our PowerShell template. This page provides detailed instructions for using the script and the script itself. You can cross-reference the column titles for the CSV conversion here

If you have multiple locations, each Organizational Unit in Active Directory containing contacts needs to be paired with the corresponding location. Verify that the location is spelled exactly as it is on your account under Locations > edit > identifier (no capitals or spaces). To make a contact available for multiple locations, put the contact's Active Directory User Profile into the multiple corresponding Organizational Units. That way, when the script is run, it will export that contact for each Organizational Unit and import them into each corresponding location. If your configuration is global, contacts will automatically be added to All Locations.

What about LDAP?

If your organization uses vanilla LDAP instead of Active Directory, the PowerShell template should give you a good idea of what a script must do to sync with our system. If you have an account with us, the Contact Import Integration page is another resource that outlines the details of the CSV file that you will need to create, and how that file will need to be transmitted to us.

Please note: Our PaaS no longer supports TLS 1.1 and 1.0 connections as of July 31st, 2021. Unfortunately, PowerShell will use these older versions of TLS by default. In order to correct this, you should add the following command just before the Invoke-RestMethod line in your script to force TLS 1.2 to be used:

[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12

Did this answer your question?