help/directory-sync.md at 5e11a4ac9b58906caf7f6822d2224044b0423396

mirror of https://github.com/bitwarden/help synced 2025-12-10 21:33:18 +00:00

Files

fred_the_tech_writer 5e11a4ac9b Meta-Descriptions (#778 )

* initial commit

* 2nd batch

* last batch

2021-10-27 10:38:41 -04:00

5.1 KiB

Raw Blame History

layout, title, categories, featured, popular, tags, order, description

layout

title

What is Directory Connector?

The Bitwarden Directory Connector application syncs users and groups to a Bitwarden Organization from a selection of directory services. Directory Connector will automatically provision and de-provision users, groups, and group associations from the source directory.

Directory Connector will issue invitations to synced users, however it will not automatically construct Bitwarden credentials based on any credentials stored in the source directory. Invited users will be required to follow the normal Organization onboarding procedure and log in with the created Bitwarden Master Password.

{% callout info %} Directory Connector functionality is available to Teams and Enterprise Organizations. To use Directory Connector, you must have access to your Organization API Key which can only be retrieved by an Organization Owner and securely shared using Bitwarden Send. {% endcallout %}

{% image directory-connector/dc-diagram.png %}

A Directory Connector sync operation can be run on-demand or automatically on a configured interval. Directory Connector applications can be installed as an agent on the server that hosts your directory, an administrator's workstation, or any other desktop device that can access the source directory.

Directory Connector supports sync from the following sources:

Active Directory
Any LDAP-based directory
[Azure Active Directory]({% link _articles/directory-connector/azure-active-directory.md %})
[G Suite]({% link _articles/directory-connector/gsuite-directory.md %})
[Okta]({% link _articles/directory-connector/okta-directory.md %})
[OneLogin]({% link _articles/directory-connector/onelogin-directory.md %})

Directory Connector Applications

Directory Connector is available as a cross-platform Desktop Application and as a Command Line Interface (CLI). The Desktop App and CLI share a database and configurations, so you may choose to use both, however simultaneous use is not recommended.

{% image directory-connector/app.png Directory Connector Desktop App %}

Download Directory Connector

Use the following links to download Directory Connector:

Desktop App
CLI

{% capture desktop %}

Download Desktop App

Download the latest version of the Directory Connector Desktop App from our GitHub releases page{:target="_blank"} or by using one of the following official links:

{% endcapture %} {{ desktop | markdownify }}

{% capture commandline %}

Download CLI Tool

Download the latest version of the Directory Connector CLI from one of the following links:

{% endcapture %} {{ commandline | markdownify }}

Source code

As with everything at Bitwarden, the Directory Connector is open source and hosted on GitHub at github.com/bitwarden/directory-connector.

5.1 KiB Raw Blame History