# Enabling Directory Sync (SCIM)

Directory sync in Hummingbird allows you to use your existing Identity Provider (IdP), like Okta, to create and manage user accounts and badges automatically. Once directory sync is enabled, Hummingbird will no longer allow direct management of accounts and badges through the Hummingbird UI. You’ll manage accounts and badge assignments directly within your IdP.

If you're interested in setting up Directory Sync (SCIM) for your organization, please reach out to your Customer Success Manager to start the process.

## Set up your Identity Provider (IdP)

Your Hummingbird support representative will share a setup link from our SCIM provider, [WorkOS](https://workos.com/). This will take you to WorkOS’s self-service portal, which is customized to guide you through configuring directory sync with your IdP. The setup portal will provide a step-by-step checklist for your IT administrator to follow.

Note: You can also [enable Single Sign-On (SSO)](/account-and-access-management/do-you-support-single-sign-on.md) for Hummingbird at the same time if you wish. Just ask your Client Success Manager for the relevant instructions.

## Assign Badges to Directory Groups

Once directory sync is set up, you can assign specific Hummingbird badges to user groups within your IdP. Here’s how:

1. Create groups in your IdP: Set up any user groups that you’d like to use to manage badge assignments in Hummingbird. For example, groups such as “Hummingbird Admins” or “Hummingbird Analysts” may be helpful. Each group in the IdP will get mapped to a set of badges in Hummingbird (for example, "Hummingbird Admins" could be mapped to the Admin badge).
2. Map groups to Hummingbird badges: Navigate to the “Directory Sync” settings page in Hummingbird, where you’ll see an option to enable directory sync:

<figure><img src="/files/zUvyeejKeovcrY7Sxi7H" alt=""><figcaption><p>The directory sync settings page</p></figcaption></figure>

Click “Enable Directory Sync.” A modal will pop up allowing you to assign badges to each group:

<figure><img src="/files/tC3xTFdgN4MCAHKxlyxQ" alt=""><figcaption><p>Assigning badges to IdP groups</p></figcaption></figure>

Note: make sure to assign the Admin badge to at least one group to retain management access.

Click “Assign” once your group mappings are complete.

## Review and Enable Directory Sync<br>

After setting up your badge assignments, you’ll see a summary of the changes directory sync will make:

<figure><img src="/files/oI0jUuR4riQmeHqfraDs" alt=""><figcaption><p>Directory sync confirmation summary</p></figcaption></figure>

Carefully review this preview to confirm all assignments are accurate and that all necessary Admin badges are assigned. When satisfied, click “Enable” to activate directory sync. Changes will take effect within five minutes, and future changes to users and groups in the IdP will be automatically synced to Hummingbird.

**Important**: Once directory sync is enabled, we cannot revert back to the pre-directory-sync state. If directory sync is disabled later, any changes made while it was active will remain and need to be updated manually in Hummingbird if adjustments are needed. Therefore, it’s crucial to review all settings carefully before finalizing the setup.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://help.hummingbird.co/account-and-access-management/enabling-directory-sync-scim.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.