Bitwarden supports syncing users and/or groups from outside directories through the use of the Bitwarden Directory Connector application. The application will automatically provision and deprovision users, groups, and group associations from your configured user directory.
The following directories are supported:
Directory sync is only available to enterprise organizations.
The Bitwarden Directory Connector is cross-platform desktop application that allows you to keep your Bitwarden organization and user directory in sync. Directory Connector can be run on-demand manually as well as automatically in the background on an configured interval. The Directory Connector application can be installed on Windows, macOS, and most Linux distributions.
You can install and run Directory Connector as an agent on the server that hosts your directory, an administrator’s workstation, or any other desktop device than can access the directory.
You can download the latest version of the Bitwarden Directory Connector application from our GitHub releases page or by using one of the official links below:
The application will prompt you for automatic updates whenever newer versions become available.
By default the Directory Connector communicates with the Bitwarden public cloud servers. If you are using the public cloud version of Bitwarden, you can skip this step. If you are using a self-hosted deployment of Bitwarden you will want to change the configured environment endpoints of the Directory Connector to your own on-premise installation.
The syntax for user and group filters is different for each type of directory. Learn more about how user and group filters work in the following article:
You can run a sync test in order to check that all of your configuration settings are setup and working as expected. A sync test will query the directory server and print the results to the screen. The results that you see printed to the screen will be what is uploaded and synced to your Bitwarden organization whenever a real sync is performed.
Your synced users and groups will be immediately available in your Bitwarden organization. Synced users will receive an email invite to your organization.
The application will begin polling your directory based on the interval you specified in your sync settings. Be sure not to exit/close the application or automatic syncing intervals will stop. You can minimize the application or hide it to the system tray (under the Window application menu).
You can click the Stop Sync button to end the automatic syncing intervals.
As the Directory Connector works at syncing changes up to your Bitwarden organization it keeps a local cache. This cache helps the Directory Connector only send the difference in directory changes (deltas) from the previous time that it performed a sync operation. If you encounter sync errors or a particular directory change is not correctly being synced, you may need to clear this cache. Clearing the cache will allow a full sync to occur during the next sync operation.
As with everything here at Bitwarden, the Directory Connector is open source and hosted on GitHub at https://github.com/bitwarden/directory-connector.
Rate this article:
Want to talk to a human?Send Us An Email