これまで、Box CLI のクイックスタートガイドでは、JWT アプリケーションまたはサーバー認証アプリケーションの設定フローについて説明してきましたが、新しく OAuth 2.0 バージョンの Box CLI をリリースしたため、新機能の使用についてガイドを更新しました。当初の JWT の設定手順については、引き続きサーバー認証アプリケーションを使用したい方のために、こちらに移動しました。
JWT アプリケーションの設定
サーバー認証を使用した CLI を使用するには、まず、開発者コンソールで Box アプリケーションを作成します。CLI は API コールを実行する際にバックグラウンドでこのアプリケーションを使用できます。CLI を既存の JWT アプリケーションに関連付ける場合は、この手順を省略できます。ただし、少なくとも、以下のスコープがアプリケーションの [構成] タブで設定されていることを確認してください。
- Box に格納されているすべてのファイルとフォルダの読み取り
- Box に格納されているすべてのファイルとフォルダへの書き込み
-
[すべてのファイル] ページの左側にあるナビゲーションパネルから、開発者コンソールを開きます。今回 Box API を使用するのが初めてで、このオプションがまだ使用できない場合は、こちらをクリックするとこのオプションをアカウントに追加できます。
-
[Platform アプリの作成] > [Platform アプリ] > [サーバー認証 (JWT 使用)] の順にクリックし、アプリケーションに名前を付けて、[アプリの作成] をクリックします。
サーバー認証 (JWT 使用) は、使用する前に必ず管理者の承認が必要になります。
アプリケーションの構成
これにより、アプリケーションの設定ページが表示され、そこで、そのアクセスや権限を選択する必要があります。アプリケーションの認証タイプが原因で、管理者の承認が必要になることにもう一度注意してください。
少なくとも、以下のスコープが必要です。
- Box に格納されているすべてのファイルとフォルダの読み取り
- Box に格納されているすべてのファイルとフォルダへの書き込み
アプリケーションアクセスとして、[アプリアクセスのみ] または [アプリ + Enterprise アクセス] のいずれかを選択できます。
アプリケーションの承認
API コールを正常に実行する前に、サーバー認証を利用するすべてのアプリケーションを管理コンソールで承認する必要があります。これは、すべての JWT アプリケーションにはサービスアカウントがあるためです。サービスアカウントは、アプリケーションのスコープに基づいて管理者アクションを実行できます。
開発者と管理者向けの手順については、Box の承認ガイドを参照してください。
スコープ、アプリケーションアクセス、トークン、権限がどのように連携しているかの詳細については、Box のセキュリティメカニズムに関する記事を参照してください。
設定の変更がこのアプリケーションに対して行われた場合は、その変更を有効にするためにこのアプリケーションを再承認する必要があります。
必要なデータのダウンロード
CLI では、API コールを実行するために、ローカルに保存されている構成ファイルが必要です。
構成ファイルをダウンロードするには、開発者コンソールの [構成] タブにアクセスし、[公開/秘密キーペアを生成] をクリックします。これにより、アプリケーションの構成ファイルを自動的にダウンロードする前に 2 要素認証が行われます。詳細については、Box のガイドを参照してください。
セキュリティ上の理由により、公開/秘密キーペアを生成するには、Box アカウントで 2 要素認証を有効にする必要があります。
EnterpriseID_publicKeyID_config.jsonという形式のデフォルトの名前が付いているダウンロード済みファイルをコンピュータ上で探します。この名前をそのまま使用しても、変更してもかまいません。このガイドでは、ファイルの名前をconfig.jsonに変更することを想定しています。
誤って削除または移動されることがない場所にファイルを配置することが重要です。ファイルが削除または移動された場合は、手順 2 を繰り返して CLI を再構成する必要があります。
CLI のインストールと構成
Windows 用および macOS 用のインストーラが提供されていますが、その他の環境で CLI を構築する場合は Raw ソースコードを利用できます。
Windows 用および macOS 用インストーラ
お使いのマシンに最新の CLI をインストールするには、最新リリースに対応する最新の.exe (Windows の場合) または.pkg (macOS の場合) をダウンロードします。
Linux と Node のインストール
さらに、CLI は、任意のプラットフォーム (Linux など) に Node パッケージとしてインストールすることができます。このためには、Node JSをマシンにインストールしておく必要があります。
npm install --global @box/cli
ソースコード
CLI のソースコードは、GitHubで提供されています。
構成コマンドの実行
ここで、手順 1 でダウンロードした構成ファイルを指すよう、CLI を構成する必要があります。
ターミナルまたはコマンドラインを開き、box configure:environments:add PathToConfigFileHereコマンドを実行します。ここでは、PathToConfigHereをconfig.jsonファイルのパスに置き換えます。
例: box configure:environments:add /Users/ExampleUser/Documents/CLI/config.json
Finder/エクスプローラからターミナル/コマンドラインウィンドウに csv ファイルをドラッグすると、パスを自動で入力できます。
構成の確認
うまく構成されているか確認するには、コマンドbox users:getを使用します。
次のように、成功を示すレスポンスには、アクセストークンに関連付けられたサービスアカウントユーザーの詳細が示されます。
Type: user
ID: ''0123456789''
Name: Box CLI - Quickstart Example
Login: AutomationUser_123456_8jSo6[email protected]
Created At: '2020-01-01T09:45:01-07:00'
Modified At: '2021-03-01T09:30:05-07:00'
Language: en
Timezone: America/Los_Angeles
Space Amount: 999999999999999
Space Used: 6291500
Max Upload Size: 16106127360
Status: active
Job Title: ''
Phone: ''
Address: [email protected]
Avatar URL: ''
Notification Email: []
デフォルトでは、JWT アプリケーションはサービスアカウントのアクセストークンを自動的に取得します。デフォルトユーザーの変更は可能ですが、このガイドでは変更しないことを想定しています。
次の手順
