ディレクトリコネクタCLI
ディレクトリコネクタCLIは、デスクトップGUIが利用できない環境や、オペレーティングシステムが提供するツール(cron job、スケジュールタスクなど)を使用してディレクトリの同期操作をプログラム的にスクリプト化したい場合に適しています。ディレクトリコネクタCLIは、Windows、macOS、Linuxディストリビューションでクロスプラットフォームで使用することができます。
チップ
デスクトップアプリとCLIはデータベースと設定を共有していますので、一台のマシンでの同時使用はお勧めしません。推奨される方法は、デスクトップアプリを使用して設定とテストを完了し、その後、CLIを使用して、製品版の組織に自動同期をスケジュールすることです。
Bitwarden Directory Connector CLIを使用するための開始方法:
次のリンクのいずれかからCLIをダウンロードしてください:
.zip
を解凍し、その内容(bwdc
とkeytar.node
)を/usr/local/bin
またはあなた の$PATH
内の別のディレクトリに移動してください。メモしてください、keytar.node
は、主要なbwdc実行可能ファイルと同じディレクトリになければなりません
。Linuxのみ:まだインストールされていない場合は、選択したパッケージ管理で
libsecret
をインストールしてください:Bashapt-get install libsecret-1-0 brew install libsecret
Windowsのみ: Windowsユーザーは、現在のユーザーのPATHにbwdc.exeを追加できます。
以下のコマンドを実行して、ターミナルで
bwdc
コマンドが動作することを確認してください。Bashbwdc --help
ディレクトリコネクタをあなたのディレクトリに
bwdc config
コマンドを使用して接続します(ここを参照)。あなたの
data.json
ファイルを編集して同期オプションを設定します(詳細については、ディレクトリコネクターファイルストレージを参照してください)。あなたのデータ.json
ファイルの絶対パスを取得するために、bwdc データ-ファイル
コマンドを使用してください。利用中のディレクトリタイプによって利用可能な同期オプションが異なるため、以下の記事のいずれかを参照して、ご利用いただけるオプションのリストをご覧ください:
bwdc テスト
コマンドを実行して、設定が期待される結果を同期するかどうかを確認します。あなたのディレクトリと同期オプションが適切に設定され、
bwdc test
が期待通りの結果をもたらしたら、bwdc 同期
コマンドを実行してライブ同期操作を開始します。
ログイン
コマンドを使用して、あなたの組甽APIキーでDirectory Connectorにログインします。APIキーがない場合は、組織の所有者に連絡してください。ログイン
コマンドを使用する方法はいくつかあります:
それ自体で:
Bashbwdc login
bwdc ログイン
を単独で渡すと、その後でclient_id
とclient_secret
を入力するように求められます。パラメーターで:
Bashbwdc login organization.b5351047-89b6-820f-ad21016b6222 yUMB4trbqV1bavhEHGqbuGpz4AlHm9
保存された環境変数を使用して:
BashBW_CLIENTID="organization.b5351047-89b6-820f-ad21016b6222" BW_CLIENTSECRET="yUMB4trbqV1bavhEHGqbuGpz4AlHm9" bwdc login
環境変数
BW_CLIENTID
とBW_CLIENTSECRET
を保存することで、bwdc ログイン
だけを使用してDirectory Connectorにログインできます。これは、それらの変数をチェックし、存在する場合はそれらを使用します。これらの環境変数が存在しない場合、あなたの
client_id
とclient_secret
を入力するように求められます。
ディレクトリコネクタCLIからログアウトするには、logout
コマンドを使用してください。
Bashbwdc logout
Bitwarden Directory Connector CLIは、すべてのコマンドに対する--help
コンテンツと例で自己文書化されています。すべての利用可能なコマンドをグローバル--help
オプションを使用してリストします:
Bashbwdc --help
特定のコマンドについて詳しく知りたい場合は、そのコマンドに--help
オプションを使用してください。
Bashbwdc test --help bwdc config --help
「テスト
」コマンドは、あなたのディレクトリを問い合わせ、実際の同期操作を実行するたびにBitwarden組織に同期されるグループとユーザーのJSON形式の配列を出力します。
Bashbwdc test
最後の成功した同期以降の変更のみをテストするには、--last
オプションを使用してください。
Bashbwdc test --last
同期
コマンドはライブ同期操作を実行し、データをあなたのBitwarden組織にプッシュします。
Bashbwdc sync
同期されたユーザーとグループは、あなたのBitwarden組織で直ちに利用可能になります。新たに追加されたユーザーは、あなたの組織へのメールアドレスで招待を受け取ります。
備考
Teams Starter プランの場合、メンバーは10人に制限されます。10人以上のメンバーを同期しようとすると、Directory Connector はエラーを表示して同期を停止します。
last-sync
コマンドは、ユーザーまたはISO 8601タイムスタンプを返します。これは、最後に実行されたユーザーまたはグループの同期操作のためのものです。コマンドを実行するためのとして、
ユーザーまたはグループ
のいずれかを指定する必要があります。
Bashbwdc last-sync <object>
指定されたオブジェクトに対して同期が実行されていない場合、空の応答を返します。
「config
」コマンドを使用すると、ディレクトリの設定を指定できます。
Bashbwdc config <setting> <value>
利用可能なオプションは次のとおりです:
オプション | 説明 |
---|---|
| あなたの自己ホスト型インストールのURL(例: |
| 使用するディレクトリのタイプ。以下の表を参照して、列挙された値を確認してください。 |
| LDAPサーバーへの接続のためのパスワード。 |
| Azure AD 秘密鍵。 |
| Google Workspace/GSuite プライベートキー。 |
| Okta トークン。 |
| OneLogin クライアントシークレット。 |
ディレクトリタイプの
値
ソースディレクトリ | 値 |
---|---|
アクティブディレクトリー/LDAP | 0 |
アジュール アクティブ ディレクトリ | 1 |
Google ワークスペース/GSuite | 2 |
オクタ | 3 |
ワンログイン | 4 |
データファイル
コマンドは、Directory Connector CLIが使用するデータ.json
設定ファイルへの絶対パスを返します。
Bashbwdc data-file
ディレクトリコネクタCLIの一部の設定は、お気に入りのテキストエディタで直接data.json
設定ファイルを編集することで変更できますが、ldap.password
、azure.key
、gsuite.key
、okta.token
、およびonelogin.secret
は、CLIを使用してのみconfig#configから、またはデスクトップアプリから変更できます。
clear-cache
コマンドは、アプリケーションが同期操作を実行する際に保存するキャッシュデータをクリアすることができます。詳細については、同期キャッシュのクリアをご覧ください。
Bashbwdc clear-cache
更新
コマンドを使用すると、Directory Connector CLIが最新のものであるかどうかを確認できます:
Bashbwdc update
新しいバージョンが見つかった場合、コマンドは新しいバージョンをダウンロードするためのURLを返します。ディレクトリコネクタCLIは自動的に更新されません。このURLを使用して新しいバージョンを手動でダウンロードする必要があります。
注意
CLIとデスクトップアプリを一緒に使用している場合、使用するたびにバージョンが一致していることを確認することが重要です。2つの異なるバージョンを実行すると、予期しない問題が発生する可能性があります。
ディレクトリコネクタCLIのバージョンを--version
グローバルオプションを使用して確認してください。