AdministratörskonsolAnvändarhanteringDirectory Connector

Directory Connector CLI

Directory Connector CLI är lämpad för arbete i miljöer där ett skrivbordsgränssnitt inte är tillgängligt, eller om du vill programmera skript för katalogsynkroniseringsoperationer med hjälp av verktyg som tillhandahålls av operativsystemet (cron-jobb, schemalagd uppgift och mer). Directory Connector CLI kan användas plattformsoberoende på Windows-, macOS- och Linux-distributioner.

Komma igång

tip

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.

För att komma igång med Bitwarden Directory Connector CLI:

  1. Ladda ner CLI från en av följande länkar:

  2. Extrahera .zip och flytta innehållet (bwdc och keytar.node) till /usr/local/bin eller en annan katalog i din $PATH. Observera att keytar.node måste finnas i samma katalog som den primära körbara bwdc-filen.

    Endast Linux: Om det inte redan är installerat, installera libsecret med din valda pakethanterare. Observera att paketet heter libsecret-1-0 för Ubuntu och Debian specifikt, användare bör hitta motsvarande titel för sin speciella distribution:

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

    Endast Windows: Windows-användare kan lägga till .

  3. Kontrollera att bwdc-kommandot fungerar i din terminal genom att köra följande:

    Bash
    bwdc --help

  4. Anslut Directory Connector till din katalog med bwdc config<setting><value> kommando (se här).

  5. Konfigurera synkroniseringsalternativ genom att redigera din data.json-fil (för mer information, se Directory Connector File Storage). Använd kommandot bwdc data-file för att få den absoluta sökvägen till din data.json-fil.

    Tillgängliga synkroniseringsalternativ beror på vilken katalogtyp som används, så se någon av följande artiklar för en lista över tillgängliga alternativ:

  6. Kör kommandot bwdc test för att kontrollera om din konfiguration skulle synkronisera de förväntade resultaten.

  7. När din katalog och synkroniseringsalternativ är korrekt konfigurerade och bwdc-testet ger de förväntade resultaten, kör kommandot bwdc sync för att starta en livesynkroniseringsoperation.

note

The --pretty flag can be included in bdwc commands to modify the output for readability.

Kommandoreferens

inloggning

Använd login-kommandot för att logga in på Directory Connector med din organisations API-nyckel. Om du inte har API-nyckeln kontaktar du en organisationsägare. Det finns några sätt att använda login-kommandot:

  • Av sig själv:

    Bash
    bwdc login

    Om du godkänner bwdc-inloggningen av sig själv kommer du att uppmanas att därefter ange client_id och client_secret.

  • Med parametrar:

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

  • Med sparade miljövariabler:

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

bwdc login

    Genom att spara miljövariablerna BW_CLIENTID och BW_CLIENTSECRET kan du logga in på Directory Connector med endast bwdc-inloggning, som kommer att leta efter dessa variabler och använda dem om de finns.

    Om dessa miljövariabler inte finns kommer du att bli ombedd att ange ditt client_id och client_secret.

utloggning

Använd kommandot logout för att logga ut från Directory Connector CLI.

Bash
bwdc logout

hjälp

Bitwarden Directory Connector CLI är självdokumenterad med --help-innehåll och exempel för varje kommando. Lista alla tillgängliga kommandon med det globala --help-alternativet:

Bash
bwdc --help

Använd alternativet --help på ett specifikt kommando för att lära dig mer om det kommandot:

Bash
bwdc test --help
bwdc config --help

testa

Testkommandot frågar din katalog och skriver ut en JSON-formaterad uppsättning grupper och användare som skulle synkroniseras med din Bitwarden-organisation när du kör en riktig synkroniseringsoperation.

Bash
bwdc test

Använd alternativet --last för att endast testa ändringarna sedan den senaste lyckade synkroniseringen.

Bash
bwdc test --last

synkronisera

Synkroniseringskommandot kör en livesynkroniseringsoperation och skickar data till din Bitwarden-organisation.

Bash
bwdc sync

Synkroniserade användare och grupper blir omedelbart tillgängliga i din Bitwarden-organisation. Nyligen tillagda användare kommer att få en e-postinbjudan till din organisation.

note

Om du har Teams Starter-plan är du begränsad till 10 medlemmar. Directory Connector visar ett felmeddelande och slutar synkronisera om du försöker synkronisera fler än 10 medlemmar.

Den här planen går inte längre att köpa. Det här felet gäller inte för Teams planer.

senaste synkronisering

Last-sync-kommandot returnerar en ISO 8601-tidsstämpel för den senaste synkroniseringsåtgärden som utfördes för användare eller grupper. Du måste ange antingen användare eller grupper som en<object> för att köra kommandot mot:

Bash
bwdc last-sync <object>

Returnerar ett tomt svar om ingen synkronisering har utförts för det givna objektet.

config

Kommandot config låter dig ange dina kataloginställningar:

Bash
bwdc config <setting> <value>

Tillgängliga alternativ är:

Alternativ

Beskrivning

server<server-url>

Webbadressen till din egen värdinstallation (t.ex. https://business.bitwarden.com) eller EU-server (https://vault.bitwarden.eu).

katalog<directory-type>

Typ av katalog att använda. Se följande tabell för uppräknade värden.

ldap.lösenord<password>

Lösenord för anslutning till LDAP-servern.

azurblå.nyckel<key>

Azure AD hemlig nyckel.

gsuite.key<key>

Privat nyckel för Google Workspace/GSuite.

okta.token<token>

Okta token.

onelogin.secret<secret>

OneLogin-klienthemlighet.

katalogtyp värden

Källkatalog

Värde

Active Directory/LDAP

0

Azure Active Directory

1

Google Workspace/GSuite

2

Okta

3

OneLogin

4

datafil

Kommandot data-file returnerar en absolut sökväg till data.json-konfigurationsfilen som används av Directory Connector CLI:

Bash
bwdc data-file

Vissa konfigurationsinställningar kan ändras för Directory Connector CLI genom att redigera data.json-konfigurationsfilen direkt i din favorittextredigerare, men ldap.password, azure.key, gsuite.key, okta.token och onelogin.secret kan bara ändras från CLI med config eller från skrivbordsappen.

rensa cache

Kommandot clear-cache låter dig rensa cachad data som applikationen lagrar medan du utför synkroniseringsåtgärder. Mer information finns i Rensa synkroniseringscache.

Bash
bwdc clear-cache

uppdatera

Uppdateringskommandot låter dig kontrollera om din Directory Connector CLI är uppdaterad:

Bash
bwdc update

Om en nyare version hittas kommer kommandot att returnera en URL för att ladda ner en ny version. Directory Connector CLI uppdateras inte automatiskt. Du måste använda den här webbadressen och ladda ner den nya versionen manuellt.

warning

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.

Felsökning

libsecret saknas

Om du får ett felmeddelande som hänvisar till det delade objektet libsecret Fel: libsecret-1.so.0: kan inte öppna filen med delat objekt: Ingen sådan fil eller katalog, du kan behöva installera libsecret som krävs för att lagra saker säkert på värden.

dbus-fel

Om du får ett felmeddelande som hänvisar till dbus när du använder bwdc config, till exempel Misslyckades med att köra underordnad process "dbus-launch" (Ingen sådan fil eller katalog) eller Kan inte autostarta D-Bus utan X11, tilldela följande miljövariabel för att tillåta klartextlagring av hemligheter i data.json:

Bash
export BITWARDENCLI_CONNECTOR_PLAINTEXT_SECRETS=true

Felsök

Felsökningsmiljövariabeln kan läggas till för felsökningsinformation.

Plain Text
export BITWARDENCLI_CONNECTOR_DEBUG=true

Det gick inte att få lokalt utfärdarcertifikat

Om du får ett felmeddelande som säger att det inte går att få lokalt utfärdarcertifikat, ställ in variabeln NODE_EXTRA_CA_CERTS till din root.pem, till exempel:

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

Om du använder skrivbordsappen kan detta också visa sig som följande fel: Varning: Om du ställer in miljövariabeln NODE_TLS_REJECT_UNAUTHORIZED till '0' blir TLS-anslutningar och HTTPS-förfrågningar osäkra genom att inaktivera certifikatverifiering.

Det gick inte att ställa in privat nyckel

Om du får felmeddelandet Objekt finns inte på sökvägen "/org/freedesktop/secrets/collection/login" när du konfigurerar din privata nyckel, se följande steg för att åtgärda problemet.

Bitwarden Directory Connector använder Linuxs nyckelring, kontrollera att följande beroenden har installerats:

Bash
sudo apt install dbus-x11 gnome-keyring

Kör sedan följande kommandon för att starta demonen:

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

Följ dessa kommandon, försök att köra nyckeln igen, till exempel:

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