Skip to content
Dashboard
Theme
Theme

BambooHR HRIS directory sync

Set up directory sync from BambooHR

View Markdown

Connect BambooHR in this setup, and we read your employee directory every few minutes.

The values in braces, such as {acs_url}, are specific to your connection. The setup link from the application you are connecting shows them with a copy button. The same steps appear there.

  1. Connect as a BambooHR user who can see every employee you want to sync. The connection reads only the people that user can see, so a user with limited access syncs only part of the directory.

  2. Select Connect BambooHR and enter your company domain, the first part of your BambooHR address: for https://acme.bamboohr.com it is acme. A page from OhAuthCat names the organization this directory belongs to; check it, then select Continue. The connect link lasts 30 minutes; if it expires, select Connect BambooHR again. You come back to this setup when BambooHR is done.

    Fixes: directory_source_oauth_state_invalid, directory_source_oauth_expired, directory_source_oauth_confirm_required

  3. BambooHR asks “Share access with OhAuthCat Directory Sync?” and lists read-only access under OpenID Claims (User Email Address, Authenticate with BambooHR), Employee (Full Profile (Non-Sensitive), Contact Information, Job Information, Full Name, Employee Directory) and Miscellaneous (Persistent Access). Approve it. If a permission is missing, the connection is refused with a missing permission error; select Connect BambooHR again.

    Fixes: directory_source_scope_missing

  4. The first sync starts right away. After that we read BambooHR every 5 minutes; after a failure we wait longer between tries, up to an hour.

  5. We read the full employee list on every sync. People BambooHR no longer returns are removed from the directory, and changes to names, titles or departments are updated.

  6. We keep the connection alive on our own. If BambooHR access is revoked, syncs stop with an invalid credentials error; select Connect BambooHR again.

    Fixes: directory_source_credentials_invalid

  7. We no longer accept BambooHR API keys. A directory set up with an API key stops syncing until you select Connect BambooHR and approve access; the directory and its people stay as they are.

    Fixes: directory_source_method_unavailable