mirror of
https://github.com/bitwarden/help
synced 2025-12-06 00:03:30 +00:00
Staging (#294)
* jekyll redirect from * Organizations rev (#262) * Organizations revisions initial commit. * API doc updates * Fix absolute link causing build failure. * Add import to org article, and downstream order changes. * Bitwarden 101 videos: 1st steps toward proliferating these throughout /help. * Added 'Create Your Account' article, which references B101 Videos. * About SSO redirect & promote importing for orgs up the list * Create Org FAQs & trim Feature FAQs accordingly. * Image for Org FAQs * Move 'About the Business Portal' to Orgs category, and re-order accordingly. * Final edits. * Dchoi/bootstrap upgrade (#264) * bootstrap 4 upgrade and cleanup update gulp tasks * bootstrap package updates * renaming file convention * general outline of help outline * bitwarden help cleanup * article cleanup * article general styling complete * bootstrap help page upgrades * sidebar updates * Dchoi/bootstrap upgrade (#267) * bootstrap 4 upgrade and cleanup update gulp tasks * bootstrap package updates * renaming file convention * general outline of help outline * bitwarden help cleanup * article cleanup * article general styling complete * bootstrap help page upgrades * sidebar updates * toc dynamic and more updates * fix callout conditions * sidebar collapse functionality added * sidebar header toggle functionality * sidebar article fixes * Update sidebar.html Fix sidebar Release Notes link. * Update releasenotes.md Remove unnecessary category tag. * Delete release-notes.md Remove unnecessary category. * Update why-choose-bitwarden-for-your-team.md Test table image differentiation * Update why-choose-bitwarden-for-your-team.md Second image differentiation test * removed links from category breadcrumb and replaced with badges Co-authored-by: fred_the_tech_writer <69817454+fschillingeriv@users.noreply.github.com>
This commit is contained in:
David Choi
GitHub
@@ -16,17 +16,6 @@ This article will cover how to connect the Bitwarden Directory Connector applica
|
||||
- Install Bitwarden Directory Connector
|
||||
- Using Directory Connector, log into your Bitwarden account and select your enterprise organization
|
||||
|
||||
## Table of Contents
|
||||
|
||||
- [Create a New Application Registration](#create-a-new-application-registration)
|
||||
- [Grant Application Permissions](#grant-application-permissions)
|
||||
- [Create Application Secret Key](#create-application-secret-key)
|
||||
- [Get Your Application ID](#get-your-application-id)
|
||||
- [Get Your Tenant Hostname](#get-your-tenant-hostname)
|
||||
- [Configure Directory Connector](#configure-directory-connector)
|
||||
- [Testing](#testing)
|
||||
|
||||
|
||||
## Create a New Application Registration
|
||||
|
||||
1. Go to <https://portal.azure.com>
|
||||
@@ -90,8 +79,8 @@ Congrats! You are done configuring Azure Active Directory with the Bitwarden Dir
|
||||
|
||||
## Testing
|
||||
|
||||
{% note %}
|
||||
{% callout info %}
|
||||
It can take up to 15 minutes for the granted permissions for your application to properly propagate. You may receive "Insufficient privileges to complete the operation" errors in the meantime.
|
||||
{% endnote %}
|
||||
{% endcallout %}
|
||||
|
||||
Test your configuration by running a sync test. You should see your Azure Active Directory groups and/or users printed to the screen.
|
||||
|
||||
@@ -18,9 +18,9 @@ The following directories are supported:
|
||||
- Okta
|
||||
- OneLogin
|
||||
|
||||
{% note %}
|
||||
{% callout info %}
|
||||
Directory sync is only available to Teams and Enterprise organizations.
|
||||
{% endnote %}
|
||||
{% endcallout %}
|
||||
|
||||
## Bitwarden Directory Connector Application
|
||||
|
||||
@@ -30,34 +30,6 @@ You can install and run Directory Connector as an agent on the server that hosts
|
||||
|
||||
{% image directory-connector/app.png %}
|
||||
|
||||
## Table of Contents
|
||||
|
||||
- [Download and Install](#download-and-install)
|
||||
- [Configure environment](#configure-environment)
|
||||
- [Log in to your Bitwarden organization account](#log-in-to-your-bitwarden-organization-account)
|
||||
- [Configure the directory connection](#configure-the-directory-connection)
|
||||
- [Configure sync options](#configure-sync-options)
|
||||
- [Test a sync](#test-a-sync)
|
||||
- [Perform a manual sync](#perform-a-manual-sync)
|
||||
- [Sync automatically](#sync-automatically)
|
||||
- [Clear sync cache](#clear-sync-cache)
|
||||
- [Command-line Interface](#command-line-interface)
|
||||
* [Quick Start](#quick-start)
|
||||
* [Download and Install](#download-and-install-1)
|
||||
* [Shared Data](#shared-data)
|
||||
* [Secret Storage](#secret-storage)
|
||||
* [Explore the CLI](#explore-the-cli)
|
||||
* [Test Command](#test-command)
|
||||
* [Sync Command](#sync-command)
|
||||
* [Last Sync Command](#last-sync-command)
|
||||
* [Config Command](#config-command)
|
||||
* [Data File Command](#data-file-command)
|
||||
* [Clear Cache Command](#clear-cache-command)
|
||||
* [Update Command](#update-command)
|
||||
* [Version Option](#version-option)
|
||||
* [Enums](#enums)
|
||||
- [Source code](#source-code)
|
||||
|
||||
## Download and Install
|
||||
|
||||
You can download the latest version of the Bitwarden Directory Connector application from our [GitHub releases page](https://github.com/bitwarden/directory-connector/releases){:target="_blank"} or by using one of the official links below:
|
||||
@@ -108,11 +80,11 @@ By default the Directory Connector communicates with the Bitwarden public cloud
|
||||
2. Go to the **Settings** tab.
|
||||
3. Set each configuration setting from the **Sync** section. Some settings are dependent on the **Type** of directory you have configured.
|
||||
|
||||
{% note %}
|
||||
{% callout info %}
|
||||
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:
|
||||
|
||||
- [Configuring user and group sync filters]({% link _articles/directory-connector/user-group-filters.md %})
|
||||
{% endnote %}
|
||||
{% endcallout %}
|
||||
|
||||
## Test a sync
|
||||
|
||||
@@ -164,13 +136,13 @@ A command-line interface (CLI) tool is also available to connect to and sync you
|
||||
|
||||
See the [download and install](#download-and-install) section above for links to download the CLI executable for your platform.
|
||||
|
||||
{% note %}
|
||||
{% callout info %}
|
||||
When extracting the zip, make sure that the included `keytar.node` dependency remains in the same directory as the main `bwdc` executable.
|
||||
|
||||
Linux users must have `libsecret` installed, which is usually already available on most systems. Example:
|
||||
|
||||
apt-get install libsecret-1-0
|
||||
{% endnote %}
|
||||
{% endcallout %}
|
||||
|
||||
### Shared Data
|
||||
|
||||
@@ -199,9 +171,9 @@ If a secure storage environment is not available, you can configure the Director
|
||||
|
||||
With plaintext storage enabled, you can then configure all settings directly, in plaintext, from the `data.json` database file.
|
||||
|
||||
{% note %}
|
||||
{% callout info %}
|
||||
Plaintext storage of secrets is not compatible with the Directory Connector desktop application. You should only use the Directory Connector CLI with plaintext storage of secrets.
|
||||
{% endnote %}
|
||||
{% endcallout %}
|
||||
|
||||
### Explore the CLI
|
||||
|
||||
@@ -256,9 +228,9 @@ You can also use the `config` command to set parameters that require secure stor
|
||||
|
||||
Additional configuration settings can be modified in the Bitwarden Directory Connector desktop application or by editing the `data.json` database file directly in your favorite text editor. [Read more about shared data](#shared-data).
|
||||
|
||||
{% note %}
|
||||
{% callout info %}
|
||||
You should avoid opening or modifying the `data.json` database file while the Directory Connector desktop application or CLI executable is running.
|
||||
{% endnote %}
|
||||
{% endcallout %}
|
||||
|
||||
### Data File Command
|
||||
|
||||
@@ -282,9 +254,9 @@ The `update` command allows you to check if your Directory Connector CLI is up t
|
||||
|
||||
A URL to download a new version of the CLI executable will be returned to you.
|
||||
|
||||
{% note %}
|
||||
{% callout info %}
|
||||
If you are also using the Directory Connector desktop application, it is important that you keep them both up to date and that their versions match. Running two different versions of the Directory Connector desktop application and Directory Connector CLI may cause unexpected issues.
|
||||
{% endnote %}
|
||||
{% endcallout %}
|
||||
|
||||
### Version Option
|
||||
|
||||
@@ -308,9 +280,9 @@ If you receive an error message referring to the libsecret shared object `Error:
|
||||
| Email | 1 |
|
||||
| Yubikey | 3 |
|
||||
|
||||
{% note %}
|
||||
{% callout info %}
|
||||
Other two-step login methods such as FIDO U2F and Duo are not supported by the CLI.
|
||||
{% endnote %}
|
||||
{% endcallout %}
|
||||
|
||||
## Source code
|
||||
|
||||
|
||||
@@ -16,20 +16,11 @@ This article will cover how to connect the Bitwarden Directory Connector applica
|
||||
- Install Bitwarden Directory Connector
|
||||
- Using Directory Connector, log into your Bitwarden account and select your enterprise organization
|
||||
|
||||
## Table of Contents
|
||||
|
||||
- [Create a Google Cloud Project](#create-a-google-cloud-project)
|
||||
- [Enable the Admin SDK API for Your Project](#enable-the-admin-sdk-api-for-your-project)
|
||||
- [Create & Configure a Service Account](#create--configure-a-service-account)
|
||||
- [Configure G Suite Security](#configure-g-suite-security)
|
||||
- [Configure Directory Connector](#configure-directory-connector)
|
||||
- [Testing](#testing)
|
||||
|
||||
## Create a Google Cloud Project
|
||||
|
||||
{% note %}
|
||||
{% callout info %}
|
||||
If you already have a Google Cloud project available, you can skip this step and re-use it here.
|
||||
{% endnote %}
|
||||
{% endcallout %}
|
||||
|
||||
1. Go to <https://console.cloud.google.com/home>
|
||||
2. Click the **Create** project button
|
||||
@@ -63,7 +54,7 @@ If you already have a Google Cloud project available, you can skip this step and
|
||||
8. Select the options button next to your service account, and select **Edit**.
|
||||
{% image directory-connector/gsuite/edit-service-account.png %}
|
||||
9. Check the box "Enable G Suite Domain-wide Delegation", enter anything for "Product name for the consent screen" and click **Save**.
|
||||
{% note %}"Enable G Suite Domain-wide Delegation" is only required on some older G Suite accounts. Newer G Suite accounts will automatically have domain-wide delegation enabled for all service accounts. If you do not see the "Enable G Suite Domain-wide Delegation" checkbox option available for your service account, you can assume it is already enabled.{% endnote %}
|
||||
{% callout info %}"Enable G Suite Domain-wide Delegation" is only required on some older G Suite accounts. Newer G Suite accounts will automatically have domain-wide delegation enabled for all service accounts. If you do not see the "Enable G Suite Domain-wide Delegation" checkbox option available for your service account, you can assume it is already enabled.{% endcallout %}
|
||||
{% image directory-connector/gsuite/tick-gsuite.png %}
|
||||
1. Click **View Client ID** and you'll see the Client ID on screen. You will need the Client ID to configure security within G Suite. Highlight the Client ID and copy it to your clipboard.
|
||||
{% image directory-connector/gsuite/view-client-id.png %}
|
||||
|
||||
@@ -56,9 +56,9 @@ The following directory configuration options can be set:
|
||||
2. Go to the **Settings** tab.
|
||||
3. Configure the appropriate **Sync** settings for your Active Directory or LDAP server.
|
||||
|
||||
{% note %}
|
||||
{% callout info %}
|
||||
If you are using Active Directory, many of these settings are predetermined for you and are therefore are not shown.
|
||||
{% endnote %}
|
||||
{% endcallout %}
|
||||
|
||||
{% table %}
|
||||
|
||||
|
||||
@@ -16,12 +16,6 @@ This article will cover how to connect the Bitwarden Directory Connector applica
|
||||
- Install Bitwarden Directory Connector
|
||||
- Using Directory Connector, log into your Bitwarden account and select your enterprise organization
|
||||
|
||||
## Table of Contents
|
||||
|
||||
- [Create an API token](#create-an-api-token)
|
||||
- [Configure Directory Connector](#configure-directory-connector)
|
||||
- [Testing](#testing)
|
||||
|
||||
## Create an API token
|
||||
|
||||
1. Log into your Okta Developer Console
|
||||
|
||||
@@ -16,12 +16,6 @@ This article will cover how to connect the Bitwarden Directory Connector applica
|
||||
- Install Bitwarden Directory Connector
|
||||
- Using the Directory Connector, log into your Bitwarden account and select your enterprise organization
|
||||
|
||||
## Table of Contents
|
||||
|
||||
- [Creating API Credentials](#creating-api-credentials)
|
||||
- [Configure Directory Connector](#configure-directory-connector)
|
||||
- [Testing](#testing)
|
||||
|
||||
## Creating API credentials
|
||||
|
||||
1. Log into your OneLogin Adminsitration portal.
|
||||
@@ -42,7 +36,7 @@ This article will cover how to connect the Bitwarden Directory Connector applica
|
||||
4. Enter the **Client ID** and **Client Secret** copied from the previous steps.
|
||||
5. Select the correct Region.
|
||||
6. Configure sync options. It is recommended to use the **Overwrite existing organization users based on current sync settings** option with OneLogin.
|
||||
{% tip %}For minimal testing check "Sync users".{% endtip %}
|
||||
{% callout success %}For minimal testing check "Sync users".{% endcallout %}
|
||||
|
||||
Congrats! You are done configuring OneLogin with the Bitwarden Directory Connector.
|
||||
|
||||
|
||||
@@ -12,13 +12,6 @@ You can configure the Bitwarden Directory Connector application to use filters t
|
||||
|
||||
The syntax for filtering is different for each directory server type and is covered in detail below.
|
||||
|
||||
## Table of Contents
|
||||
|
||||
- [Active Directory and Other LDAP Directories](#active-directory-and-other-ldap-directories)
|
||||
- [Azure Active Directory](#azure-active-directory)
|
||||
- [G Suite](#g-suite)
|
||||
- [Okta](#okta)
|
||||
|
||||
## Active Directory and Other LDAP Directories
|
||||
|
||||
The group and user filters can be in the form of any LDAP compatible search filter. Additionally, Active Directory provides a few more advanced options as well as a few limitations when writing search filters as opposed to other more standard LDAP directories. You can read more about writing LDAP search filters here: <https://msdn.microsoft.com/en-us/library/windows/desktop/aa746475(v=vs.85).aspx>
|
||||
@@ -31,9 +24,9 @@ Search for all entries that have objectClass=user AND cn that contains the word
|
||||
(&(objectClass=user)(cn=*Marketing*))
|
||||
```
|
||||
|
||||
{% note %}
|
||||
{% callout info %}
|
||||
Active Directory does not implement extensible matching, the following examples won't work with it.
|
||||
{% endnote %}
|
||||
{% endcallout %}
|
||||
|
||||
Find entries with an OU component of their DN which is either 'Miami' or 'Orlando'.
|
||||
|
||||
@@ -47,9 +40,9 @@ To exclude entities which match an expression, use '!'. Find all Chicago entries
|
||||
(&(ou:dn:=Chicago)(!(ou:dn:=Wrigleyville)))
|
||||
```
|
||||
|
||||
{% note %}
|
||||
{% callout info %}
|
||||
The following examples are written for Active Directory. In order to use them for something such as OpenLDAP the attributes will need to be changed.
|
||||
{% endnote %}
|
||||
{% endcallout %}
|
||||
|
||||
Users in the 'Heroes' group
|
||||
|
||||
@@ -71,9 +64,9 @@ The Microsoft Graph API does not provide a way to filter groups and users direct
|
||||
|
||||
#### Groups
|
||||
|
||||
{% note %}
|
||||
{% callout info %}
|
||||
If you are filtering groups your user filter will only apply to users from the groups returned.
|
||||
{% endnote %}
|
||||
{% endcallout %}
|
||||
|
||||
```
|
||||
include:Group A,Sales People,My Other Group
|
||||
@@ -111,9 +104,9 @@ excludeGroup:97b9ff2a-7d4f-463d-a925-efb1677fd40d
|
||||
|
||||
The G Suite APIs do not provide a way to filter groups directly, however, you can use our custom filtering syntax that allows you to exclude or include a comma separated list of group names.
|
||||
|
||||
{% note %}
|
||||
{% callout info %}
|
||||
If you are filtering groups your user filter will only apply to users from the groups returned.
|
||||
{% endnote %}
|
||||
{% endcallout %}
|
||||
|
||||
#### Examples
|
||||
|
||||
|
||||
Reference in New Issue
Block a user