Directory Connector Desktop App

The Directory Connector desktop app is a standalone desktop application that can be used to sync users, groups, and group associations from a selection of directory services.

Directory Connector is also available as a CLI tool. The desktop app and CLI share a database and configurations, so simultaneous use on a single machine is not recommended. The recommended path is to complete configuration and testing using the desktop app, and subsequently using the CLI to schedule automatic syncing to your production organization.

To get started using the Directory Connector desktop app:

1. Download the latest version of the app from our GitHub releases page or by using one of the following official links:

   •  Windows Installer (.exe)

   •  Windows Portable (.exe)

   •  macOS (.dmg)

   •  Linux (.AppImage)

2. Set the server URL used by Directory Connector before logging in. This is required if you are self-hosting Bitwarden or using the EU server:

   1. On the Login screen, select Settings.

   2. In the Server URL field, enter the domain name for Bitwarden instance with https://. For example, https://vault.bitwarden.eu or https://your.domain.bitwarden.com.

   3. Select Save.

3. Log in to Directory Connector using your organization API key. If you don't have the API key, reach out to an organization owner.

4. On the  Settings tab, connect to your directory and configure sync options. This procedure will vary based on the directory in use, so refer to one of the following articles for instruction:

   • Sync with Active Directory or LDAP

   • Sync with Azure Active Directory

   • Sync with G Suite (Google)

   • Sync with Okta

   • Sync with OneLogin

   tip

   If you are re-configuring sync options, rather than setting them for the first time, navigate to the More tab and select the Clear Sync Cache button to prevent potential conflicts with prior sync operations (learn more).

5. On the  Settings tab, select your organization from the organization dropdown.

6. Perform a Test Sync. To check that your directory connection and sync options are successfully configured and working as expected:

   1. Open the  Dashboard tab.

   2. Select the Test Now button.

Sync testing will query the directory server and print the results to the dashboard. Results will include:

• A list of users that will be synced from the directory.

• A list of groups that will be synced from the directory.

• A list of users that will be disabled based on their status in the directory.

• A list of users that will be deleted from your organization based on their status in the directory.

If the printed results match your expectations, you're ready to start syncing.

Directory Connector can be used to run a one-time manual sync or automatic sync polling:

To run a one-time manual sync from your directory to your Bitwarden organization, open the  Dashboard tab and select the  Sync Now button.

Synced users will be invited to your organization, and groups will be immediately created.

Automatic syncing will poll your directory based on the Interval specified in your sync options as long as the application is open. If you exit or close the application, automatic sync polling will stop.

To start automatic sync polling with Directory Connector, open the  Dashboard tab and select the  Start Sync button.