Admin ConsoleUser Management

Directory Connector File Storage

The desktop app and CLI share a database and configurations, so simultaneous use on a single machine is not recommended. The recommended path is to complete configuration and testing using the desktop app, and subsequently using the CLI to schedule automatic syncing to your production organization.

tip

We recommend using the desktop app or CLI prior to conditioning the Directory Connector configuration file, as it is not possible to setup the entirety of Directory Connector from this file. Authentication values, like keys or secrets, must be set from either the desktop app or CLI.

Config file

Contents

The Directory Connector configuration file (data.json) can contain the following properties which you may directly edit in order to set the connection to your directory and and sync options:

note

Please note:

  • Your data.json file will also contain properties that should not be manually edited in the file. Only manually edit the properties described in the following table.

  • Some properties, specifically authentication-related values, should not be manually edited in the file and must be set from either the desktop app or CLI.

Object

Description

global.environmentUrls.base:

global.environmentUrls.api:

global.environmentUrls.identity:

global.environmentUrls.webVault:

<org_identifier>.directoryConfiguration.????:

Download a sample configuration file

warning

Avoid opening or modifying data.json while the Directory Connector desktop app or CLI executable is running.

Location

The location of data.json depends on which platform is in use:

  • Windows : %AppData%\Bitwarden Directory Connector

    • Portable: .\bitwarden-connector-appdata

  • macOS: ~/Library/Application Support/Bitwarden Directory Connector

  • Linux: ~/.config/Bitwarden Directory Connector

tip

Using the Directory Connector CLI, run the data-file command to discover the absolute path to the data.json.

Secret storage

By default, the Directory Connector desktop app and CLI both use a secure method for persisting sensitive data (such as your directory account password, API keys, and so on).

On Linux systems this requires GNOME Keyring and X11, which are usually reserved for desktop environments. If you are using a headless Linux environment you may encounter errors such as:

Bash
Cannot autolaunch D-Bus without X11 $DISPLAY

Secret storage in headless environments

If a secure storage environment is not available, you can configure the Directory Connector CLI to use plaintext storage of secrets. To do so, set the following environment variable to override secure storage, for example by running sudo -H gedit /etc/environment:

Bash
BITWARDENCLI_CONNECTOR_PLAINTEXT_SECRETS=true

With plaintext storage enabled, you can then configure all settings directly, in plaintext, from the data.json configuration file.

note

Plaintext storage of secrets is not compatible with the Directory Connector desktop app. You should only use the Directory Connector CLI with plaintext storage of secrets.

Make a suggestion to this page

Contact Our Support Team

For technical, billing, and product questions.

Name*
Bitwarden account email*
Verify account email*
Product*
Are you self-hosting?*
Subject*
Message...*

Cloud Status

Check status

© 2024 Bitwarden, Inc.TermsPrivacySitemap
This site is available in English.
Go to EnglishStay Here