Help Center

Connecteur de répertoire CLI

Le CLI du Directory Connector est adapté pour le travail dans des environnements où une interface graphique de bureau n'est pas disponible, ou si vous souhaitez programmer des opérations de synchronisation de répertoire de manière programmatique en utilisant les outils fournis par le système d'exploitation (tâche cron, tâche planifiée, et plus). Le CLI du Connecteur de Répertoire peut être utilisé sur plusieurs plateformes comme Windows, macOS et les distributions Linux.

Commencer

tip

L'application de bureau et le CLI partagent une base de données et des configurations, donc l'utilisation simultanée sur une seule machine n'est pas recommandée. Le chemin recommandé est de terminer la configuration et les tests en utilisant l'application de bureau, et par la suite en utilisant le CLI pour planifier la synchronisation automatique avec votre organisation de production.

Pour commencer à utiliser le CLI du Connecteur de Répertoire Bitwarden :

  1. Téléchargez le CLI à partir de l'un des liens suivants :

  2. Extrayez le .zip et déplacez le contenu (bwdc et keytar.node) vers /usr/local/bin ou un autre répertoire dans votre $PATH. Veuillez noter, keytar.node doit être dans le même répertoire que l'exécutable principal bwdc.

    Uniquement pour Linux: Si ce n'est pas déjà installé, installez libsecret avec le gestionnaire de paquets de votre choix:

    Bash
    apt-get install libsecret-1-0
brew install libsecret

    Uniquement pour Windows : Les utilisateurs de Windows peuvent ajouter bwdc.exe au PATH de l'utilisateur actuel.

  3. Vérifiez que la commande bwdc fonctionne dans votre terminal en exécutant ce qui suit :

    Bash
    bwdc --help

  4. Connectez le connecteur de répertoire à votre répertoire en utilisant la commande bwdc config (voir ici).

  5. Configurez les options de synchronisation en éditant votre fichier data.json (pour en savoir plus, consultez Stockage de fichiers du connecteur de répertoire). Utilisez la commande bwdc data-file pour obtenir le chemin absolu de votre fichier donnée.json.

    Les options de synchronisation disponibles dépendent du type de répertoire utilisé, alors référez-vous à l'un des articles suivants pour une liste des options qui vous sont disponibles :

  6. Exécutez la commande bwdc test pour vérifier si votre configuration synchroniserait les résultats attendus.

  7. Une fois que votre répertoire et vos options de synchronisation sont correctement configurés, et que bwdc test donne les résultats attendus, exécutez la commande bwdc synchroniser pour démarrer une opération de synchronisation en direct.

Référence des commandes

identifiant

Utilisez la commande identifiant pour vous connecter à Directory Connector avec votre clé API d'organisation. Si vous n'avez pas la clé API, contactez un propriétaire d'organisation. Il y a quelques façons d'utiliser la commande identifiant :

  • Par lui-même:

    Bash
    bwdc login

    Passer l'identifiant bwdc par lui-même vous invitera à entrer par la suite client_id et client_secret.

  • Avec des paramètres:

    Bash
    bwdc login organization.b5351047-89b6-820f-ad21016b6222 yUMB4trbqV1bavhEHGqbuGpz4AlHm9

  • Avec des variables d'environnement enregistrées:

    Bash
    BW_CLIENTID="organization.b5351047-89b6-820f-ad21016b6222"
BW_CLIENTSECRET="yUMB4trbqV1bavhEHGqbuGpz4AlHm9"

bwdc login

    Enregistrer les variables d'environnement BW_CLIENTID et BW_CLIENTSECRET vous permet de vous connecter à Directory Connector en utilisant uniquement bwdc identifiant, qui vérifiera la présence de ces variables et les utilisera si elles sont présentes.

    Si ces variables d'environnement ne sont pas présentes, on vous demandera de saisir votre client_id et client_secret.

déconnexion

Utilisez la commande logout pour vous déconnecter du CLI du Directory Connector.

Bash
bwdc logout

aide

Le CLI du connecteur de répertoire Bitwarden est auto-documenté avec du contenu --help et des exemples pour chaque commande. Listez toutes les commandes disponibles en utilisant l'option globale --help :

Bash
bwdc --help

Utilisez l'option --help sur n'importe quelle commande spécifique pour en savoir plus sur cette commande :

Bash
bwdc test --help
bwdc config --help

essai

La commande test interroge votre répertoire et imprime un tableau formaté en JSON de groupes et d'utilisateurs qui seraient synchronisés avec votre organisation Bitwarden chaque fois que vous exécutez une véritable opération de synchronisation.

Bash
bwdc test

Utilisez l'option --last pour tester uniquement les modifications depuis la dernière synchronisation réussie.

Bash
bwdc test --last

synchroniser

La commande synchroniser exécute une opération de synchronisation en direct et pousse les données vers votre organisation Bitwarden.

Bash
bwdc sync

Les utilisateurs et les groupes synchronisés seront immédiatement disponibles dans votre organisation Bitwarden. Les utilisateurs nouvellement ajoutés recevront une invitation par courriel à votre organisation.

note

Si vous êtes sur le plan Teams Starter, vous êtes limité à 10 membres. Directory Connector affichera une erreur et arrêtera de synchroniser si vous essayez de synchroniser plus de 10 membres.

dernière-synchronisation

La commande dernière-synchronisation renvoie un horodatage ISO 8601 pour la dernière opération de synchronisation qui a été effectuée pour les utilisateurs ou les groupes. Vous devez spécifier soit des utilisateurs soit des groupes comme un pour exécuter la commande contre :

Bash
bwdc last-sync <object>

Renvoie une réponse vide si aucune synchronisation n'a été effectuée pour l'objet donné.

configuration

La commande config vous permet de spécifier vos paramètres de répertoire :

Bash
bwdc config <setting> <value>

Les options disponibles sont :

Option

Description

serveur

URL de votre installation auto-hébergée (par exemple, https://business.bitwarden.com) ou serveur EU (https://vault.bitwarden.eu).

annuaire

Type de répertoire à utiliser. Voir le tableau suivant pour les valeurs énumérées.

ldap.motdepasse

Mot de passe pour la connexion au serveur LDAP.

azure.key

Clé secrète Azure AD.

gsuite.key

Clé privée de Google Workspace/GSuite.

okta.token

Jeton Okta.

onelogin.secret

Secret du client OneLogin.

valeurs de répertoire-saisir

Répertoire source

Valeur

Active Directory/LDAP

0

Azure Active Directory

1

Google Workspace/GSuite

2

Okta

3

OneLogin

4

fichier de données

La commande fichier-donnée renvoie un chemin absolu vers le fichier de configuration donnée.json utilisé par le CLI du connecteur de répertoire :

Bash
bwdc data-file

Certains paramètres de configuration peuvent être modifiés pour le CLI du Directory Connector en éditant directement le fichier de configuration data.json dans votre éditeur de texte favori, cependant ldap.password, azure.key, gsuite.key, okta.token, et onelogin.secret peuvent uniquement être modifiés depuis le CLI en utilisant config, ou depuis l'application de bureau.

vider le cache

La commande clear-cache vous permet de vider les données en cache que l'application stocke lors de l'exécution des opérations de synchronisation. Pour plus d'informations, voir Vider le cache de synchronisation.

Bash
bwdc clear-cache

mettre à jour

La commande mettre à jour vous permet de vérifier si votre CLI de Directory Connector est à jour :

Bash
bwdc update

Si une version plus récente est trouvée, la commande renverra une URL pour télécharger une nouvelle version. Le CLI du connecteur de répertoire ne se mettra pas à jour automatiquement. Vous devrez utiliser cette URL pour télécharger la nouvelle version manuellement.

warning

Si vous utilisez le CLI et l'application de bureau ensemble, il est important de s'assurer que leurs versions correspondent chaque fois qu'ils sont utilisés. L'exécution de deux versions différentes peut causer des problèmes inattendus.

Vérifiez la version du CLI du Connecteur de Répertoire en utilisant l'option globale --version.

Dépannage

libsecret manquant

Si vous recevez un message d'erreur faisant référence à l'objet partagé libsecret Erreur : libsecret-1.so.0 : impossible d'ouvrir le fichier d'objet partagé : aucun fichier ou répertoire de ce type, vous devrez peut-être installer libsecret qui est nécessaire pour stocker des choses en toute sécurité sur l'hôte.

Erreurs dbus

Si vous recevez un message d'erreur se référant au dbus lorsque vous utilisez bwdc config, par exemple Échec de l'exécution du processus enfant "dbus-launch" (Aucun fichier ou répertoire de ce type) ou Impossible de lancer automatiquement D-Bus sans X11, attribuez la variable d'environnement suivante pour permettre le stockage en clair des secrets dans data.json :

Bash
export BITWARDENCLI_CONNECTOR_PLAINTEXT_SECRETS=true

Impossible d'obtenir le certificat de l'émetteur local

Si vous recevez un message d'erreur indiquant impossible d'obtenir le certificat de l'émetteur local, définissez la variable NODE_EXTRA_CA_CERTS sur votre root.pem, par exemple :

Bash
export NODE_EXTRA_CA_CERTS="absolute/path/to/your/certificates.pem"

Si vous utilisez l'application de bureau, cela peut également se manifester par l'erreur suivante : Avertissement : La définition de la variable d'environnement NODE_TLS_REJECT_UNAUTHORIZED à '0' rend les connexions TLS et les requêtes HTTPS non sécurisées en désactivant la vérification des certificats.

Échec de la configuration de la clé privée

Si vous recevez l'erreur L'objet n'existe pas au chemin "/org/freedesktop/secrets/collection/identifiant" lors de la configuration de votre clé privée, suivez les étapes suivantes pour corriger le problème.

Le connecteur de répertoire Bitwarden utilise le trousseau de Linux, vérifiez que les dépendances suivantes ont été installées :

Bash
sudo apt install dbus-x11 gnome-keyring

Ensuite, exécutez les commandes suivantes pour démarrer le démon :

Bash
export $(dbus-launch)
dbus-launch
gnome-keyring-daemon --start --daemonize --components=secrets
echo '<RANDOM-PASSPHRASE>' | gnome-keyring-daemon -r -d --unlock

Suivant ces commandes, essayez de relancer la clé, par exemple :

Bash
bwdc config gsuite.key /path/to/key/