1PasswordでZendesk CLIを安全に認証する

1Passwordマニュアル｜Zendesk CLIシェルプラグインを活用し、1PasswordでZCLIの認証を安全かつ簡単に行う方法をご紹介します。

1PasswordでZendesk CLIを安全に認証する

Zapier CLIシェルプラグインを使うと、1Passwordを使ってZCLIを安全に認証できます。資格情報を平文でSaveするのではなく、フィンガープリント、Apple Watch、またはシステム認証を使ってSaveします。

指示に従ってデフォルトの資格情報を設定し、plugins.shファイルを取得すると、生体認証を使ってZCLIを認証するように求められます。

必要条件

1Passwordにサインアップしてください。
MacまたはLinux用の1Password 8をインストールしてサインインします。
1Password CLI 2.17.0以降をインストールします。1Password CLIを既にインストールしている場合は、最新版に更新する方法を確認してください。
1Password CLIを1Passwordアプリに接続します。
ZCLIをインストールします。

次のシェルがサポートされています。

Bash
Zsh
fish

ステップ 1：デフォルトの資格情報を設定する

Zendesk CLIシェルプラグインを使い始めるには次のように入力してください。

Zendesk CLIプラグインで使う 1Password アカウントにサインインします。 $ op signin
特定のディレクトリーでのみプラグインを設定したい場合は、そのディレクトリーに変更します。
プラグインを設定するには、次のコマンドを実行します。 $ op plugin init zcli

Zendesk CLIの資格情報をあなたの資格情報がSaveされている保存済みの1Passwordアイテムにインポートするよう求められます。そしてその後にいつその資格情報を使うべきかを設定するよう求められます。

ステップ 1.1：アイテムをインポートまたは選択する

新しいアイテムをインポートする場合

Zendesk CLIの認証情報を1PasswordにまだSaveしていない場合は、[Import into 1Password]を選択します。認証情報を入力し、新しい1Passwordアイテムの名前を選択して、Save先の保管庫を選択します。

1Passwordがローカル開発環境で資格情報を検出すると、自動的にインポートするように求められます。

保存済みのアイテムを選択する場合

Zendesk CLI の認証情報を1PasswordにSaveしている場合は、[Search in 1Password]を選択します。

関連するアイテムとそれらがSaveされている保管庫のリストが表示されます。資格情報が表示されない場合は、[Expand search]を選択して、アカウント内の全アイテムを参照します。

ステップ 1.2：デフォルトの資格情報のスコープを設定する

資格情報を選択またはインポートすると、その項目をZendesk CLIの認証に使うタイミングを設定するように求められます。

[Prompt me for each new terminal session]を選択すると、現在のターミナルセッションの期間中のみ資格情報が設定されます。ターミナルを終了すると、デフォルトは削除されます。
[Use automatically when in this directory or subdirectories]を選択すると、他のディレクトリー固有のデフォルトが設定されていない限り、現在のディレクトリーとその全てのサブディレクトリーで資格情報がデフォルトになります。ターミナルセッションのデフォルトは、ディレクトリー固有のデフォルトよりも優先されます。
[Use as global default on my system]を選択すると、資格情報が全ターミナルセッションとディレクトリーのデフォルトとして設定されます。ディレクトリー固有のデフォルトは、グローバルデフォルトよりも優先されます。

ステップ2：plugins.shファイルをsourceする

プラグインを使えるようにするには、plugins.shファイルをソースします。

例：

$ source ~/.config/op/plugins.sh

あなたの環境のopフォルダーのファイルパスは、設定ディレクトリーによって異なる場合があります。op plugin initコマンドで、正しいファイルパスを含むソースコマンドを出力します。

シェルプラグインを初めてインストールする場合は、現在のターミナルセッションを超えてプラグインを永続化するために、RCファイルまたはシェルプロファイルにsourceコマンドを追加する必要があります。例：

Bash

$ echo "source ~/.op/plugins.sh" >> ~/.bashrc && source ~/.bashrc

$ echo "source ~/.op/plugins.sh" >> ~/.zshrc && source ~/.zshrc

fish

$ echo "source ~/.op/plugins.sh" >> ~/.config/fish/config.fish && source ~/.config/fish/config.fish

ステップ3：CLIを利用する

次回Zendesk CLIでコマンドを入力するときに、生体認証またはシステム認証による認証を求めるメッセージが表示されます。

ステップ4：インポートした資格情報をディスクから削除する

Zendesk CLIの認証情報を1PasswordにSaveしたら、以前にディスクにSaveした全てのローカルコピーを削除できます。

次のステップ

1Password Shellプラグインは60を超えるサードパーティーのCLIをサポートしています。サポートされているCLIのリストを表示するには次のように入力してください。

$ op plugin list

別のプラグインを選択して開始するには次のように入力してください。

$ op plugin init

シームレスなコンテキスト切り替えのためにシェルプラグインを使うには、複数の環境または複数のアカウントでプラグインを構成する方法を学んでください。

ヘルプを取得する

設定を検査する

現在のZendesk CLI設定を検査するには次のように入力してください。

$ op plugin inspect zcli

1Password CLIは、 Zendesk CLIで使うために設定した資格情報とそのデフォルトのスコープのリスト、およびZapier CLI用に設定されたエイリアスのリストを返します。

資格情報を消去する

Zendesk CLIで使用される資格情報をリセットするには、次のように入力してください：

$ op plugin clear zcli

次の優先順位に従って、一度に 1 つの構成をクリアできます。

ターミナルセッションのデフォルト
ディレクトリーのデフォルト、現在のディレクトリーから$HOME
グローバルデフォルト

例えば、$HOME/projects/awesomeProjectディレクトリー内にいて、ターミナルセッションのデフォルト、ディレクトリーのデフォルトが$HOMEおよび$HOME/projects/awesomeProjectであり、さらにグローバルデフォルトの資格情報が設定されている場合、全てのデフォルトをクリアするにはop plugin clear zcliを4回実行する必要があります。

グローバルデフォルト資格情報、ターミナルセッションデフォルト、および現在のディレクトリーのデフォルトを同時にクリアするには、op plugin clear zcli --allを実行します。

参考情報

1Password は、プラグインコマンドに必要な資格情報を 1Passwordアカウントから直接環境変数に挿入することで、Zendesk CLIで認証します。

新しい項目をインポートするために使うのではなく、手動でZendesk CLI の資格情報を 1PasswordにSaveした場合は、フィールド名が以下の表と一致していることを確認してください。op plugin

アイテムに必要な名前のフィールドが含まれていない場合は、保存済みのフィールドのいずれかの名前を変更するように求められます。

1Passwordフィールド名

環境変数

サブドメイン

ZENDESK_SUBDOMAIN

メール

ZENDESK_EMAIL

トークン

ZENDESK_API_TOKEN

このプラグインを提供してくれた、@williamhparkに感謝します。独自のシェルプラグインを構築する方法を学びましょう。

さらに詳しく知るには

Previous1PasswordでZapier CLIを安全に認証する Nextシェルプラグインをテストする