Directory Connector CLI
De Directory Connector CLI is geschikt om te werken in omgevingen waar een desktop GUI niet beschikbaar is, of als je directory synchronisatie operaties programmatisch wilt scripten met behulp van tools die door het besturingssysteem worden geleverd (cron job, geplande taak en meer). De Directory Connector CLI kan cross-platform worden gebruikt op Windows, macOS en Linux distributies.
tip
De desktop applicatie en CLI delen een database en configuraties, dus gelijktijdig gebruik op één machine wordt niet aangeraden. Het aanbevolen pad is om de configuratie en het testen te voltooien met behulp van de desktop app, en vervolgens de CLI te gebruiken om automatische synchronisatie met je productieorganisatie te plannen.
Om aan de slag te gaan met de Bitwarden Directory Connector CLI:
Download de CLI van een van de volgende links:
Pak de
.zipuit en verplaats de inhoud(bwdcenkeytar.node) naar/usr/local/binof een andere map in je$PATH. Let op:keytar.nodemoet in dezelfde map staan als de primairebwdcexecutable.Alleen Linux: Installeer
libsecretmet een pakketbeheerder naar keuze als deze nog niet is geïnstalleerd:Bashapt-get install libsecret-1-0 brew install libsecretAlleen voor Windows: Windows-gebruikers kunnen bwdc.exe toevoegen aan het PATH van de huidige gebruiker.
Controleer of het
bwdccommando werkt in je terminal door het volgende uit te voeren:Bashbwdc --helpVerbind Directory Connector met je map met het commando
bwdc config(zie hier).Configureer synchronisatieopties door je
data.jsonbestand te bewerken (voor meer informatie, zie Directory Connector Bestandsopslag). Gebruik het commandobwdc data-fileom het absolute pad van jedata.jsonbestand te verkrijgen.Beschikbare synchronisatieopties zijn afhankelijk van het gebruikte maptype, dus raadpleeg een van de volgende artikelen voor een lijst met beschikbare opties:
Voer het commando
bwdc testuit om te controleren of je configuratie de verwachte resultaten synchroniseert.Als je map en synchronisatieopties goed zijn geconfigureerd en
bwdc testde verwachte resultaten oplevert, voer dan het commandobwdc syncuit om een live synchronisatie te starten.
Gebruik het inlogcommando om in te loggen bij Directory Connector met de API-sleutel van je organisatie. Als je de API-sleutel niet hebt, neem dan contact op met de eigenaar van de organisatie. Er zijn een paar manieren om het inlogcommando te gebruiken:
Op zichzelf:
Bashbwdc loginAls je
bwdc loginop zichzelf doorgeeft, wordt er gevraagd om vervolgensclient_idenclient_secretin te voeren.Met parameters:
Bashbwdc login organization.b5351047-89b6-820f-ad21016b6222 yUMB4trbqV1bavhEHGqbuGpz4AlHm9Met opgeslagen omgevingsvariabelen:
BashBW_CLIENTID="organization.b5351047-89b6-820f-ad21016b6222" BW_CLIENTSECRET="yUMB4trbqV1bavhEHGqbuGpz4AlHm9" bwdc loginDoor de omgevingsvariabelen
BW_CLIENTIDenBW_CLIENTSECRETop te slaan, kun je inloggen op Directory Connector met alleenbwdc login, dat zal controleren op deze variabelen en ze gebruiken als ze aanwezig zijn.Als deze omgevingsvariabelen niet aanwezig zijn, wordt u gevraagd om uw
client_idenclient_secretin te voeren.
Gebruik het uitlogcommando om uit te loggen uit de Directory Connector CLI.
Bashbwdc logout
De Bitwarden Directory Connector CLI is zelf gedocumenteerd met --help inhoud en voorbeelden voor elk commando. Geef een overzicht van alle beschikbare commando's met de globale optie --help:
Bashbwdc --help
Gebruik de optie --help bij een specifiek commando om meer te weten te komen over dat commando:
Bashbwdc test --help bwdc config --help
De testopdracht bevraagt uw directory en drukt een JSON-geformatteerde matrix af van groepen en gebruikers die zouden worden gesynchroniseerd met uw Bitwarden-organisatie wanneer u een echte synchronisatie uitvoert.
Bashbwdc test
Gebruik de optie --last om alleen de wijzigingen sinds de laatste succesvolle synchronisatie te testen.
Bashbwdc test --last
Het synchronisatiecommando voert een live synchronisatie uit en pusht gegevens naar uw Bitwarden-organisatie.
Bashbwdc sync
Gesynchroniseerde gebruikers en groepen zijn direct beschikbaar in uw Bitwarden-organisatie. Nieuw toegevoegde gebruikers ontvangen een e-mailuitnodiging voor je organisatie.
note
Als u het Teams Starter-plan gebruikt, bent u beperkt tot 10 licenties. Directory Connector geeft een fout weer en stopt met synchroniseren als u meer dan 10 licenties probeert te synchroniseren.
Het last-sync commando retourneert een ISO 8601 tijdstempel voor de laatste synchronisatie die is uitgevoerd voor gebruikers of groepen. Je moet gebruikers of groepen opgeven als een om het commando tegen uit te voeren:
Bashbwdc last-sync <object>
Geeft een leeg antwoord als er geen synchronisatie is uitgevoerd voor het gegeven object.
Met het config commando kun je je mapinstellingen opgeven:
Bashbwdc config <setting> <value>
Beschikbare opties zijn:
Optie | Beschrijving |
|---|---|
| URL van je zelf gehoste installatie (bijv. https://business. |
| Type map dat moet worden gebruikt. Zie de volgende tabel voor opgesomde waarden. |
| Wachtwoord voor verbinding met de LDAP-server. |
| Azure AD geheime sleutel. |
| Google Workspace/GSuite privésleutel. |
| Okta token. |
| OneLogin-clientgeheim. |
waarden voor mappen
Bron map | Waarde |
|---|---|
Active Directory/LDAP | 0 |
Azure Active Directory | 1 |
Google Werkruimte/GSuite | 2 |
Okta | 3 |
OneLogin | 4 |
Het commando databestand retourneert een absoluut pad naar het configuratiebestand data.json dat wordt gebruikt door de Directory Connector CLI:
Bashbwdc data-file
Sommige configuratie-instellingen kunnen worden gewijzigd voor de Directory Connector CLI door het data.json-configuratiebestand rechtstreeks in uw favoriete teksteditor te bewerken, maar ldap.password, azure.key, gsuite.key, okta.token en onelogin.secret kunnen alleen worden gewijzigd vanuit de CLI met behulp van config, of vanuit de desktop app.
Met het commando clear-cache kun je gegevens uit de cache wissen die de applicatie opslaat tijdens het uitvoeren van synchronisatiebewerkingen. Zie Synchronisatiecache wissen voor meer informatie.
Bashbwdc clear-cache
Met het update commando kun je controleren of je Directory Connector CLI up-to-date is:
Bashbwdc update
Als er een nieuwere versie wordt gevonden, geeft het commando een URL terug om een nieuwe versie te downloaden. De Directory Connector CLI wordt niet automatisch bijgewerkt. Je moet deze URL gebruiken om de nieuwe versie handmatig te downloaden.
warning
Als je de CLI en desktop applicatie samen gebruikt, is het belangrijk om ervoor te zorgen dat hun versies overeenkomen wanneer je ze gebruikt. Het uitvoeren van twee verschillende versies kan onverwachte problemen veroorzaken.
Controleer de versie van de Directory Connector CLI met de globale optie --version.
Als je een foutmelding krijgt die verwijst naar het gedeelde object libsecret Error: libsecret-1.so.0: cannot open shared object file: No such file or directory, dan is het mogelijk dat libsecret geïnstalleerd moet worden. Dit is nodig om dingen veilig op te slaan op de host.
Als je een foutmelding krijgt die verwijst naar de dbus bij het gebruik van bwdc config, bijvoorbeeld Failed to execute child process "dbus-launch" (No such file or directory) of Cannot autolaunch D-Bus without X11, wijs dan de volgende omgevingsvariabele toe om plaintext opslag van geheimen in data.json toe te staan:
Bashexport BITWARDENCLI_CONNECTOR_PLAINTEXT_SECRETS=trueAls je een foutmelding krijgt waarin staat dat je geen lokaal issuer-certificaat kunt krijgen, stel dan de variabele NODE_EXTRA_CA_CERTS in op bijvoorbeeld je root.pem:
Bashexport NODE_EXTRA_CA_CERTS="absolute/path/to/your/certificates.pem"Als je de desktop-app gebruikt, kan dit zich ook manifesteren als de volgende fout: Waarschuwing: Het instellen van de NODE_TLS_REJECT_UNAUTHORIZED omgevingsvariabele op '0' maakt TLS-verbindingen en HTTPS-verzoeken onveilig door certificaatverificatie uit te schakelen.
Als u de foutmelding Object bestaat niet op het pad "/org/freedesktop/secrets/collection/login" krijgt tijdens het configureren van uw privésleutel, raadpleeg dan de volgende stappen om het probleem op te lossen.
De Bitwarden Directory Connector gebruikt Linux's keyring, controleer of de volgende afhankelijkheden zijn geïnstalleerd:
Bashsudo apt install dbus-x11 gnome-keyring
Voer vervolgens de volgende commando's uit om de daemon te starten:
Bashexport $(dbus-launch)
dbus-launch
gnome-keyring-daemon --start --daemonize --components=secrets
echo '<RANDOM-PASSPHRASE>' | gnome-keyring-daemon -r -d --unlockProbeer na deze commando's de sleutel opnieuw uit te voeren, bijvoorbeeld:
Bashbwdc config gsuite.key /path/to/key/