# Directory Connector CLI The Directory Connector CLI is suited toward work in environments where a desktop GUI is unavailable, or if you want to programmatically script directory sync operations using tools provided by the operating system (cron job, scheduled task, and more). The Directory Connector CLI can be used cross-platform on Windows, macOS, and Linux distributions. ## Getting started > [!TIP] Using BWDC GUI to Get Started > The desktop app and CLI [share a database and configurations](https://bitwarden.com/it-it/help/directory-sync-shared/), so **simultaneous** use on a single machine is not recommended. The recommended path is to complete configuration and testing using the [desktop app](https://bitwarden.com/it-it/help/directory-sync-desktop/), and subsequently using the [CLI](https://bitwarden.com/it-it/help/directory-sync-cli/) to [schedule automatic syncing](https://bitwarden.com/it-it/help/schedule-directory-sync/) to your production organization. To get started using the Bitwarden Directory Connector CLI: 1. Download the CLI from one of the following links: - 🪟 [Windows CLI](https://bitwarden.com/download/?app=connector&platform=windows&variant=cli-zip) - 🍎 [macOS CLI](https://bitwarden.com/download/?app=connector&platform=macos&variant=cli-zip) - 🐧 [Linux CLI](https://bitwarden.com/download/?app=connector&platform=linux&variant=cli-zip) 2. Extract the `.zip` and move the contents (`bwdc` and `keytar.node`) to `/usr/local/bin` or another directory in your `$PATH`. Please note, `keytar.node` **must** be in the same directory as the primary `bwdc` executable. **Linux only:** If not already installed, install `libsecret` with your package manager of choice. Note that the package is titled `libsecret-1-0` for Ubuntu and Debian specifically, users should find the equivalent title for their particular distribution: ``` apt-get install libsecret-1-0 brew install libsecret ``` **Windows only:** Windows users can add `bwdc.exe` [to the current user's PATH](https://www.howtogeek.com/118594/how-to-edit-your-system-path-for-easy-command-line-access/). 3. Verify that the `bwdc` command works in your terminal by running the following: ``` bwdc --help ``` 4. Connect Directory Connector to your directory using the `bwdc config ` command (see [here](https://bitwarden.com/it-it/help/directory-sync-cli/#config/)). 5. Configure sync options by editing your `data.json` file (to learn more, see [Directory Connector File Storage](https://bitwarden.com/it-it/help/directory-sync-shared/)). Use the `bwdc data-file` command to obtain the absolute path of your `data.json` file. Available **sync options** depend on the directory type in use, so refer to one of the following articles for a list of options available to you: - [Sync with Active Directory or LDAP](https://bitwarden.com/it-it/help/ldap-directory/) - [Sync with Microsoft Entra ID](https://bitwarden.com/it-it/help/microsoft-entra-id/) - [Sync with G Suite (Google)](https://bitwarden.com/it-it/help/workspace-directory/) - [Sync with Okta](https://bitwarden.com/it-it/help/okta-directory/) - [Sync with OneLogin](https://bitwarden.com/it-it/help/onelogin-directory/) 6. Run the `bwdc test` command to check whether your configuration would sync the expected results. 7. Once your directory and sync options are properly configured, and `bwdc test` yields the expected results, run the `bwdc sync` command to start a live sync operation. > [!NOTE] --pretty in bwdc > The `--pretty` flag can be included in bdwc commands to modify the output for readability. ## Commands reference ### login Use the `login` command to log in to Directory Connector with your [organization API key](https://bitwarden.com/it-it/help/public-api/#authentication/). If you don't have the API key, reach out to an [organization owner](https://bitwarden.com/it-it/help/user-types-access-control/). There are a few ways to use the `login` command: - By itself: ``` bwdc login ``` Passing `bwdc login` by itself will prompt you to subsequently enter `client_id` and `client_secret`. - With parameters: ``` bwdc login organization.b5351047-89b6-820f-ad21016b6222 yUMB4trbqV1bavhEHGqbuGpz4AlHm9 ``` - With saved environment variables: ``` BW_CLIENTID="organization.b5351047-89b6-820f-ad21016b6222" BW_CLIENTSECRET="yUMB4trbqV1bavhEHGqbuGpz4AlHm9" bwdc login ``` Saving the environment variables `BW_CLIENTID` and `BW_CLIENTSECRET` allows you to login to Directory Connector using only `bwdc login`, which will check for those variables and use them if present. If these environment variables aren't present, you will be prompted to enter your `client_id` and `client_secret`. ### logout Use the `logout` command to logout of the Directory Connector CLI. ``` bwdc logout ``` ### help The Bitwarden Directory Connector CLI is self-documented with `--help` content and examples for every command. List all available commands using the global `--help` option: ``` bwdc --help ``` Use the `--help` option on any specific command to learn more about that command: ``` bwdc test --help bwdc config --help ``` ### test The `test` command queries your directory and prints a JSON formatted array of groups and users that would be synced to your Bitwarden organization whenever you run a real sync operation. ``` bwdc test ``` Use the `--last` option to test only the changes since the last successful sync. ``` bwdc test --last ``` ### sync The `sync` command runs a live sync operation and pushes data to your Bitwarden organization. ``` bwdc sync ``` Synced users and groups will be immediately available in your Bitwarden organization. Newly added users will receive an email invite to your organization. > [!NOTE] Teams Starter + BWDC > If you're on the Teams Starter plan, you are limited to 10 members. Directory Connector will display an error and stop syncing if you try to sync more than 10 members. > > **This plan is no longer available for purchase**. This error does not apply to Teams plans. ### last-sync The `last-sync` command returns an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp for the last sync operation that was performed for users or groups. You must specify either `users` or `groups` as an `` to run the command against: ``` bwdc last-sync ``` Returns an empty response if no sync has been performed for the given object. ### config The `config` command allows you to specify your directory settings: ``` bwdc config ``` Available options are: | **Option** | **Description** | |------|------| | `server ` | URL of your self-hosted installation (e.g. `https://business.bitwarden.com`) or EU server (`https://vault.bitwarden.eu`). | | `directory ` | Type of directory to use. See the following table for enumerated values. | | `ldap.password ` | Password for connection to the LDAP server. | | `entra.key ` | Entra ID secret key. | | `gsuite.key ` | Google Workspace/GSuite private key. | | `okta.token ` | Okta token. | | `onelogin.secret ` | OneLogin client secret. | #### `directory-type` values | **Source directory** | **Value** | |------|------| | Active Directory/LDAP | 0 | | Entra ID | 1 | | Google Workspace/GSuite | 2 | | Okta | 3 | | OneLogin | 4 | ### data-file The `data-file` command returns an absolute path to the `data.json` configuration file used by the Directory Connector CLI: ``` bwdc data-file ``` Some configuration settings can be modified for the Directory Connector CLI by editing the `data.json` configuration file directly in your favorite text editor, however `ldap.password`, entra`.key`, `gsuite.key`, `okta.token`, and `onelogin.secret` can **only** be modified from the CLI using [`config`](https://bitwarden.com/it-it/help/directory-sync-cli/#config/)#config, or from the [desktop app](https://bitwarden.com/it-it/help/directory-sync-desktop/). ### clear-cache The `clear-cache` command allows you to clear cached data that the application stores while performing sync operations. For more information, see [Clear Sync Cache](https://bitwarden.com/it-it/help/clear-sync-cache/). ``` bwdc clear-cache ``` ### update The `update` command allows you to check if your Directory Connector CLI is up-to-date: ``` bwdc update ``` If a newer version is found, the command will return a URL to download a new version. **The Directory Connector CLI will not automatically update.** You will need to use this URL download the new version manually. > [!NOTE] BWDC desktop and CLI > If you using the CLI and desktop app together, it is important to ensure their versions match whenever in use. Running two different versions may cause unexpected issues. > > Check the version of the Directory Connector CLI using the `--version` global option. ## Troubleshooting ### libsecret missing If you receive an error message referring to the libsecret shared object `Error: libsecret-1.so.0: cannot open shared object file: No such file or directory`, you may need to install libsecret which is required to store things securely on the host. ### dbus Errors If you receive an error message referring to the dbus when using `bwdc config`, for example `Failed to execute child process "dbus-launch" (No such file or directory)` or `Cannot autolaunch D-Bus without X11`, assign the following environment variable to allow plaintext storage of secrets in `data.json`: ``` export BITWARDENCLI_CONNECTOR_PLAINTEXT_SECRETS=true ``` ### Debug The debug environment variable can be added for troubleshooting information. ```plain text export BITWARDENCLI_CONNECTOR_DEBUG=true ``` ### Unable to get local issuer certificate If you receive an error message that states `unable to get local issuer certificate`, set the `NODE_EXTRA_CA_CERTS` variable to your `root.pem`, for example: ``` export NODE_EXTRA_CA_CERTS="absolute/path/to/your/certificates.pem" ``` If you're using the desktop app, this may also manifest as the following error: `Warning: Setting the NODE_TLS_REJECT_UNAUTHORIZED environment variable to '0' makes TLS connections and HTTPS requests insecure by disabling certificate verification.` ### Failing to set private key If you are receiving error `Object does not exist at path "/org/freedesktop/secrets/collection/login" `while configuring your private key, see the following steps to correct the issue. The Bitwarden Directory Connector uses Linux's keyring, check that the following dependancies have been installed: ```bash sudo apt install dbus-x11 gnome-keyring ``` Next, run the following commands to start the daemon: ```bash export $(dbus-launch) dbus-launch gnome-keyring-daemon --start --daemonize --components=secrets echo '' | gnome-keyring-daemon -r -d --unlock ``` Following these commands, try to run the key again, for example: ```bash bwdc config gsuite.key /path/to/key/ ```