bitwarden/help
1
0
Fork 0
mirror of https://github.com/bitwarden/help synced 2025-12-12 14:23:15 +00:00
Code Issues Releases Wiki Activity
Files
b51a351dcb1de396ec7839c8d707f65260ae18f6
help/_articles/directory-connector/directory-sync-desktop.md
fred_the_tech_writer 9be8c67fa8 Release Documentation (#653) 
* Stage (#636)

* Initial Draft. To do: "How it Works" + Event Logs, User Types, Plans & Pricing, Release Notes.

* whoops, missed one

* Merge latest into working (#616)

* Update proof-of-concept.md (#607)

The "Download Bitwarden" link was going to the Apple Store (https://get.bitwarden.com/) rather than the "Downloads" page (https://bitwarden.com/download/).

* Update proof-of-concept.md (#610)

* Create enterprise-feature-list.md (#611)

* Azure SSO HiFi Documentation (#584)

* azure HiFi documentation

* finalize azure

* typo fixes

* Google Workspace HiFi SSO Documentation (#605)

* Duo HiFi documentation (#598)

* Buncha Stuff (#612)

* clarification on where to find legacy mac .dmg

* tip for update email address

* code vetting security faq

* /managing-items/ refactor

* two-step login 'remember me' duration

* small updates, including denoting purpose of the globe icon

* additional tip for deleting users in a self-host org!

* uri component pieces

* encryption key edit

* importing cleanup

* notes re: importing on file attachements

* Removes custom Safari shortcut docs (#499)

Bitwarden 1.25.0 on MacOS with Safari seems to use the standard MacOS shortcut for autofill (`Cmd + Shift + L`) and the custom Safari shortcuts no longer work (`Cmd + \ or Cmd + 8 or Cmd + Shift + P`).

* Update Microsoft Store Installation path (#614)

* Correct path for Microsoft Store app (#615)

Co-authored-by: Andrea Lebron <78605241+alebr-on@users.noreply.github.com>
Co-authored-by: baylorrandolph <70168800+baylorrandolph@users.noreply.github.com>
Co-authored-by: Charles Renwick <crenwick@users.noreply.github.com>
Co-authored-by: Alex <abanay@bitwarden.com>

* mpwr event logging

* mpwr user permissions

* admin pw reset 2nd draft

* final(ish) draft

* password reprompt

* initial bwdc updates (to do: update cli login procedure)

* update personal api key article to better distingush from org api key

* refactors bwdc desktop app article

* clearer instructions for getting api key

* bwdc cli login scheme

* Bulk Org User Actions

* export event logs

* cli get notes

* send cli --maxAccessCount

* autofill on page load enhancements

* onpageload TOTP copy

* release notes & typo

Co-authored-by: Andrea Lebron <78605241+alebr-on@users.noreply.github.com>
Co-authored-by: baylorrandolph <70168800+baylorrandolph@users.noreply.github.com>
Co-authored-by: Charles Renwick <crenwick@users.noreply.github.com>
Co-authored-by: Alex <abanay@bitwarden.com>

* typo fix

* fix

* fix

* fix

* mpwr final

* mpw reprompt - better gif

* finalize event logs

* fixes to autofill o.p.l. & better screenshot

* directory connector large sync

* reorder rn

* edits from cscharf

* fix date

* mp re-prompt warning

* mobile re-prompt notes

* downcase it

* semi-vague timeline tweak

Co-authored-by: Andrea Lebron <78605241+alebr-on@users.noreply.github.com>
Co-authored-by: baylorrandolph <70168800+baylorrandolph@users.noreply.github.com>
Co-authored-by: Charles Renwick <crenwick@users.noreply.github.com>
Co-authored-by: Alex <abanay@bitwarden.com>
2021-06-28 13:39:33 -04:00

4.5 KiB
Raw Blame History

layout, title, categories, featured, popular, tags, order
layout title categories featured popular tags order
article Directory Connector Desktop App
directory-connector
true false
02

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.

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

Directory Connector is also available as a CLI Tool. The Desktop App and CLI [share a database and configurations]({% link _articles/directory-connector/directory-sync-shared.md %}), so you may choose to use both, however simultaneous use is not recommended.

Getting Started

To get started using the Directory Connector Desktop App:

  1. Download the latest version of the app from our GitHub releases page{:target="_blank"} or by using one of the following official links:

  2. If you're using a self-hosted version of Bitwarden, change the Server URL used by Directory Connector before logging in:

    1. On the Login screen, select Settings.
    2. In the Server URL field, enter the domain name for your self-hosted instance with https://. For example, 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 {% icon fa-cogs %} 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]({% link _articles/directory-connector/ldap-directory.md %})
    • [Sync with Azure Active Directory]({% link _articles/directory-connector/azure-active-directory.md %})
    • [Sync with G Suite (Google)]({% link _articles/directory-connector/gsuite-directory.md %})
    • [Sync with Okta]({% link _articles/directory-connector/okta-directory.md %})
    • [Sync with OneLogin]({% link _articles/directory-connector/onelogin-directory.md %})

    {% callout success %}If you're 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).{% endcallout %}

  5. On the {% icon fa-cogs %} Settings tab, select you 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 {% icon fa-dashboard %} Dashboard tab.
    2. Select the Test Now button.

Sync testing will query the directory server and print the results to the dashboard. If the printed results match your expectations, you're ready to start syncing.

Sync with Directory Connector

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

Manual Sync

To run a one-time manual sync from your directory to your Bitwarden Organization, open the {% icon fa-dashboard %} Dashboard tab and select the {% icon fa-refresh %} Sync Now button.

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

Automatic Sync

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 {% icon fa-dashboard %} Dashboard tab and select the {% icon fa-play %} Start Sync button.