Directory Sync

BambooHR Directory Sync

Learn about syncing your user list with BambooHR

This guide outlines how to synchronize your application's BambooHR directories.

To synchronize an Enterprise's users and groups provisioned for your application, you'll need the following information from the Enterprise:

  • The BambooHR subdomain.
  • A BambooHR API key to authenticate requests.

Step 1. Set up your directory sync connection.

Click "Add new connection".

Input your Enterprise's name and domain, and select "BambooHR" from the dropdown.

Then, click "Create directory".


Step 2. Retrieve the subdomain and API key from an Enterprise IT Admin.

To generate an API key, an IT Admin should log in and click their name in the upper right-hand corner of the BambooHR console.


Next, the IT Admin should click "Add New Key".


Step 3. Enter the subdomain and API key in the Directory's detail page.


Click "Update Directory".

Step 4. Assign users and groups to your application

Now, whenever your Enterprise customer assigns users or groups to your application, you'll receive Dashboard updates based on changes in their directory.