mirror of
https://github.com/bitwarden/help
synced 2025-12-06 00:03:30 +00:00
uppercase Bitwarden
This commit is contained in:
Kyle Spearrin
@@ -8,13 +8,13 @@ hidden: false
|
||||
tags: []
|
||||
---
|
||||
|
||||
This article will cover how to connect the bitwarden Directory Connector tool to your Azure Active Directory.
|
||||
This article will cover how to connect the Bitwarden Directory Connector tool to your Azure Active Directory.
|
||||
|
||||
## Requirements
|
||||
|
||||
- Read through the following article: [Syncing users and groups with a directory]({% link _articles/directory-connector/directory-sync.md %})
|
||||
- Install bitwarden Directory Connector
|
||||
- Using Directory Connector, log into your bitwarden account and select your enterprise organization
|
||||
- Install Bitwarden Directory Connector
|
||||
- Using Directory Connector, log into your Bitwarden account and select your enterprise organization
|
||||
|
||||
## Table of Contents
|
||||
|
||||
@@ -33,7 +33,7 @@ This article will cover how to connect the bitwarden Directory Connector tool to
|
||||
2. Select the **Azure Active Directory** resource
|
||||
3. Navigate to **App registrations** and select **New application registration**
|
||||
{% image directory-connector/azure/new-application.png %}
|
||||
4. **Name** your application "bitwarden"
|
||||
4. **Name** your application "Bitwarden"
|
||||
5. Set the **Application type** to "Web app / API"
|
||||
6. Set the **Sign-on URL** to any website value, such as "https://company.com". This URL is not used in this setup process so it can be anything.
|
||||
7. Click the **Create** button to create the application.
|
||||
@@ -41,7 +41,7 @@ This article will cover how to connect the bitwarden Directory Connector tool to
|
||||
|
||||
## Grant Application Permissions
|
||||
|
||||
1. Select the **bitwarden** application you created in the previous section.
|
||||
1. Select the **Bitwarden** application you created in the previous section.
|
||||
2. Navigate to **Settings** and select **Required Permissions**.
|
||||
3. Select the existing **Windows Azure Active Directory** API.
|
||||
4. Check **all** Application and Delegated permissions and click **Save**.
|
||||
@@ -63,7 +63,7 @@ This article will cover how to connect the bitwarden Directory Connector tool to
|
||||
|
||||
## Create Application Secret Key
|
||||
|
||||
1. Go back to the **bitwarden** application that you created.
|
||||
1. Go back to the **Bitwarden** application that you created.
|
||||
2. Navigate to **Settings** and select **Keys**.
|
||||
3. Add a new **Password** key by entering a **Name** and **Duration**. We recommend selecting "Never Expires" for the duration.
|
||||
4. Click **Save** to create a new secret key.
|
||||
@@ -72,7 +72,7 @@ This article will cover how to connect the bitwarden Directory Connector tool to
|
||||
|
||||
## Get Your Application ID
|
||||
|
||||
1. Go back to the **bitwarden** application that you created.
|
||||
1. Go back to the **Bitwarden** application that you created.
|
||||
2. Copy the **Application ID** to a safe place. We will need to reference it later.
|
||||
{% image directory-connector/azure/application-id.png %}
|
||||
|
||||
@@ -91,7 +91,7 @@ This article will cover how to connect the bitwarden Directory Connector tool to
|
||||
7. Enter the **Application ID** that you copied from the steps above.
|
||||
8. Enter the Application **Secret** Key that you copied from the steps above.
|
||||
|
||||
Congrats! You are done configuring Azure Active Directory with the bitwarden Directory Connector.
|
||||
Congrats! You are done configuring Azure Active Directory with the Bitwarden Directory Connector.
|
||||
|
||||
## Testing
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ popular: false
|
||||
tags: []
|
||||
---
|
||||
|
||||
bitwarden supports syncing users and/or groups from outside directories through the use of the **bitwarden Directory Connector** tool.
|
||||
Bitwarden supports syncing users and/or groups from outside directories through the use of the **Bitwarden Directory Connector** tool.
|
||||
|
||||
The following directories are supported:
|
||||
|
||||
@@ -20,9 +20,9 @@ The following directories are supported:
|
||||
Directory sync is only available to enterprise organizations.
|
||||
{% endnote %}
|
||||
|
||||
## bitwarden Directory Connector Tool
|
||||
## Bitwarden Directory Connector Tool
|
||||
|
||||
The bitwarden Directory Connector is a windows-based console application (CLI) 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 through the use of the included windows service. The tool provides a console-based UI in addition to a full array of command line arguments.
|
||||
The Bitwarden Directory Connector is a windows-based console application (CLI) 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 through the use of the included windows service. The tool provides a console-based UI in addition to a full array of command line arguments.
|
||||
|
||||
You can install and run Directory Connector on the server that hosts your directory, an administrator's machine, or any other windows-based device than can access the directory.
|
||||
|
||||
@@ -31,7 +31,7 @@ You can install and run Directory Connector on the server that hosts your direct
|
||||
### Table of Contents
|
||||
|
||||
- [Install](#install)
|
||||
- [Log in to your bitwarden organization account](#log-in-to-your-bitwarden-organization-account)
|
||||
- [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)
|
||||
- [Manually simulate a sync](#manually-simulate-a-sync)
|
||||
@@ -49,14 +49,14 @@ You can install and run Directory Connector on the server that hosts your direct
|
||||
[{% icon fa-download %} Download Directory Connector Installer](https://github.com/bitwarden/directory-connector/releases){:target="_blank"}
|
||||
2. Launch the setup wizard by running (double-clicking) the downloaded `.msi` installer.
|
||||
3. Step through the wizard and complete the installation.
|
||||
4. After the setup wizard has successfully completed, you should find a shortcut on your desktop for **Directory Connector** with the bitwarden logo {% icon fa-shield %}. The full path to the application can be found at `{install_folder}/Console.exe`.
|
||||
4. After the setup wizard has successfully completed, you should find a shortcut on your desktop for **Directory Connector** with the Bitwarden logo {% icon fa-shield %}. The full path to the application can be found at `{install_folder}/Console.exe`.
|
||||
|
||||
### Log in to your bitwarden organization account
|
||||
### Log in to your Bitwarden organization account
|
||||
|
||||
1. Launch the Directory Connector console by double clicking the shortcut.
|
||||
2. Select option 1 (Log in to bitwarden) from the main menu.
|
||||
3. Enter your bitwarden login credentials.
|
||||
4. If your bitwarden account belongs to more than one organization you will be prompted to select an organization.
|
||||
2. Select option 1 (Log in to Bitwarden) from the main menu.
|
||||
3. Enter your Bitwarden login credentials.
|
||||
4. If your Bitwarden account belongs to more than one organization you will be prompted to select an organization.
|
||||
|
||||
Optionally, from the command line:
|
||||
|
||||
@@ -203,7 +203,7 @@ The syntax for user and group filters is different for each type of directory. L
|
||||
|
||||
### Manually simulate a sync
|
||||
|
||||
You can simulate a directory sync in order to check that all of your configuration settings are setup and working as expected. A sync simulation 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 invoked.
|
||||
You can simulate a directory sync in order to check that all of your configuration settings are setup and working as expected. A sync simulation 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 invoked.
|
||||
|
||||
1. Launch the Directory Connector console by double clicking the shortcut.
|
||||
2. Select option 5 (Simulate directory sync) from the main menu.
|
||||
@@ -276,12 +276,12 @@ Alternatively, you can also manage the background service from the windows servi
|
||||
- If you do not find the "Services" application by searching, you can also open it from the "Run" window by typing `services.msc`.
|
||||
|
||||
{% tip %}
|
||||
You can configure the bitwarden Directory Connector to run automatically each time the machine starts. Use the windows service manager to set the bitwarden Directory Connector service to "Startup type: Automatic".
|
||||
You can configure the Bitwarden Directory Connector to run automatically each time the machine starts. Use the windows service manager to set the Bitwarden Directory Connector service to "Startup type: Automatic".
|
||||
{% endtip %}
|
||||
|
||||
### Configure environment
|
||||
|
||||
By default the Directory Connector communicates with the bitwarden public cloud servers. 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.
|
||||
By default the Directory Connector communicates with the Bitwarden public cloud servers. 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.
|
||||
|
||||
1. Launch the Directory Connector console by double clicking the shortcut.
|
||||
2. Select option 8 (Configure environment) from the main menu.
|
||||
@@ -300,7 +300,7 @@ Console.exe env [-api] [-id]
|
||||
|
||||
### Clear sync cache
|
||||
|
||||
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 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 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 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.
|
||||
|
||||
1. Launch the Directory Connector console by double clicking the shortcut.
|
||||
2. Select option 9 (Clear sync cache) from the main menu.
|
||||
@@ -317,7 +317,7 @@ You can also perform a "forced" sync by using the `-f` command as described in t
|
||||
|
||||
### Changing configurations manually
|
||||
|
||||
All configuration data is saved to a `.json` configuration file stored on the local computer. No configuration data in synced to bitwarden servers. You can find the configuration file in it's default location at `C:/ProgramData/bitwarden/Directory Connector/settings.json`. Any changes that you make directory to the configuration file will require you to restart the application (if it is currently running).
|
||||
All configuration data is saved to a `.json` configuration file stored on the local computer. No configuration data in synced to Bitwarden servers. You can find the configuration file in it's default location at `C:/ProgramData/bitwarden/Directory Connector/settings.json`. Any changes that you make directory to the configuration file will require you to restart the application (if it is currently running).
|
||||
|
||||
{% note %}
|
||||
Some configuration data that is stored in the settings file, such as LDAP server credentials, is encrypted. Therefore, you cannot edit these values directly in this file. Any encrypted data must be edited through the application normally.
|
||||
@@ -325,4 +325,4 @@ Some configuration data that is stored in the settings file, such as LDAP server
|
||||
|
||||
### Source code
|
||||
|
||||
As with everything here at bitwarden, the Directory Connector is open source and hosted on GitHub at <https://github.com/bitwarden/directory-connector>.
|
||||
As with everything here at Bitwarden, the Directory Connector is open source and hosted on GitHub at <https://github.com/bitwarden/directory-connector>.
|
||||
|
||||
@@ -8,13 +8,13 @@ hidden: false
|
||||
tags: []
|
||||
---
|
||||
|
||||
This article will cover how to connect the bitwarden Directory Connector tool to your G Suite directory.
|
||||
This article will cover how to connect the Bitwarden Directory Connector tool to your G Suite directory.
|
||||
|
||||
## Requirements
|
||||
|
||||
- Read through the following article: [Syncing users and groups with a directory]({% link _articles/directory-connector/directory-sync.md %})
|
||||
- Install bitwarden Directory Connector
|
||||
- Using Directory Connector, log into your bitwarden account and select your enterprise organization
|
||||
- Install Bitwarden Directory Connector
|
||||
- Using Directory Connector, log into your Bitwarden account and select your enterprise organization
|
||||
|
||||
## Table of Contents
|
||||
|
||||
@@ -58,7 +58,7 @@ If you already have a Google Cloud project available, you can skip this step and
|
||||
4. Click the **Create credentials** button and select **Service account key**.
|
||||
{% image directory-connector/gsuite/create-credentials.png %}
|
||||
5. Select **New service account**.
|
||||
6. Name the service account **bitwarden Directory Connector**. For the role, select **Project** and then **Owner**. Ensure that **JSON** is the selected **Key type**. Upon clicking **Create**, a JSON file will be downloaded; this is important for later so keep a note of where you have downloaded it.
|
||||
6. Name the service account **Bitwarden Directory Connector**. For the role, select **Project** and then **Owner**. Ensure that **JSON** is the selected **Key type**. Upon clicking **Create**, a JSON file will be downloaded; this is important for later so keep a note of where you have downloaded it.
|
||||
{% image directory-connector/gsuite/create-service-account.png %}
|
||||
7. You should now see your newly created service account listed. Click on **Manage service accounts** (on the right-hand side).
|
||||
{% image directory-connector/gsuite/click-manage-service-accounts.png %}
|
||||
@@ -88,7 +88,7 @@ If you already have a Google Cloud project available, you can skip this step and
|
||||
## Configure Directory Connector
|
||||
|
||||
1. Locate the secret key JSON file that was downloaded whenever you created your service account in the steps above.
|
||||
2. Copy this file to the bitwarden Directory Connector program data folder at `C:/ProgramData/bitwarden/Directory Connector`.
|
||||
2. Copy this file to the Bitwarden Directory Connector program data folder at `C:/ProgramData/bitwarden/Directory Connector`.
|
||||
- Optionally rename the JSON file to something that is easier to remember, such as `client_secret.json`
|
||||
3. Launch the Directory Connector console by double clicking the shortcut.
|
||||
4. Select option 3 (Configure directory connection) from the main menu.
|
||||
@@ -97,7 +97,7 @@ If you already have a Google Cloud project available, you can skip this step and
|
||||
7. Enter the domain of your G Suite account.
|
||||
8. Enter the email address of an admin user that has full access to the G Suite directory (such as your own).
|
||||
|
||||
Congrats! You are done configuring G Suite with the bitwarden Directory Connector.
|
||||
Congrats! You are done configuring G Suite with the Bitwarden Directory Connector.
|
||||
|
||||
## Testing
|
||||
|
||||
|
||||
@@ -24,8 +24,8 @@ We provide built-in connectors for the most popular LDAP directory servers, such
|
||||
## Requirements
|
||||
|
||||
- Read through the following article: [Syncing users and groups with a directory]({% link _articles/directory-connector/directory-sync.md %})
|
||||
- Install bitwarden Directory Connector
|
||||
- Using Directory Connector, log into your bitwarden account and select your enterprise organization
|
||||
- Install Bitwarden Directory Connector
|
||||
- Using Directory Connector, log into your Bitwarden account and select your enterprise organization
|
||||
|
||||
## Connecting to the LDAP Server
|
||||
|
||||
@@ -63,7 +63,7 @@ The following options can be set:
|
||||
| Sync Interval | When using the background service, the interval, in minutes, that you wish to automatically sync. | 5 |
|
||||
| User Filter | A filter for limiting the users that are synced. Read more at [Configuring user and group sync filters]({% link _articles/directory-connector/user-group-filters.md %}). | (&(objectClass=user)) |
|
||||
| Group Filter | A filter for limiting the groups that are synced. Read more at [Configuring user and group sync filters]({% link _articles/directory-connector/user-group-filters.md %}). | (&(objectClass=group)) |
|
||||
| Remove Disabled | When a user is disabled in the directory, should they also be removed from your bitwarden organization? | |
|
||||
| Remove Disabled | When a user is disabled in the directory, should they also be removed from your Bitwarden organization? | |
|
||||
| Group Object Class | The name of the class used for the LDAP group object. | group |
|
||||
| User Object Class | The name of the class used for the LDAP user object. | user |
|
||||
| Group Path | This value is used in addition to the root path when searching and loading groups. If no value is supplied, the subtree search will start from the root path. | ou=Groups |
|
||||
@@ -71,7 +71,7 @@ The following options can be set:
|
||||
| Group Name Attribute | The attribute field to use when loading the group name. | name |
|
||||
| User Email Attribute | The attribute field to use when loading the user email address. | mail |
|
||||
| Member Attribute | The attribute field to use when loading the group's members. | member |
|
||||
| Use Email Prefix/Suffix | Email addresses are required by bitwarden. If your directory users do not have email addresses they will be skipped. Alternatively, you can specify that users without an email address use a prefix attribute concatenated with a suffix to attempt to form a valid email address. | |
|
||||
| Use Email Prefix/Suffix | Email addresses are required by Bitwarden. If your directory users do not have email addresses they will be skipped. Alternatively, you can specify that users without an email address use a prefix attribute concatenated with a suffix to attempt to form a valid email address. | |
|
||||
| Email Prefix Attribute | The attribute field to use when forming a user's email address from the prefix/suffix setting. | sAMAccountName |
|
||||
| Email Suffix | The specified suffix to use when forming a user's email address from the prefix/suffix setting. | @company.com |
|
||||
| Creation Date Attribute | The attribute field that specifies when an entry was created. | whenCreated |
|
||||
|
||||
@@ -8,7 +8,7 @@ hidden: false
|
||||
tags: []
|
||||
---
|
||||
|
||||
You can configure the bitwarden Directory Connector to use filters to limit the users and/or groups that are processed for syncing to your bitwarden organization.
|
||||
You can configure the Bitwarden Directory Connector to use filters to limit the users and/or groups that are processed for syncing to your bitwarden organization.
|
||||
|
||||
The syntax for filtering is different for each directory server type and is covered in detail below.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user