【Box】Box Cliをセットアップする詳細な手順をまとめてみた

Box

本投稿ではBox CliをWindows10にインストールし、
Box Cliが利用できるようになるまでの手順をまとめてみました。
Box CliをインストールすることでBox内の情報を一括取得することはもちろん、
グループ、フォルダやコラボの管理など管理コンソール上から実施するには
億劫になる作業もスムーズに実行できるようになります。

本投稿ではBox Cli 2.7.0 をインストールします。

Box Cliのインストール

Box Cliのインストーラーは以下からダウンロードします。

Releases · box/boxcli
A command line interface for interacting with the Box API. - box/boxcli

ダウンロードしたEXEファイルを実行し、[Next >]をクリックします。

Box Cli セットアップ

[Install]をクリックします。

Box Cli セットアップ Install

[Close]をクリックします。

Box Cli セットアップ Close

Boxアプリケーションのセットアップ

Box Developers Consoleに入り、[アプリの新規作成]をクリックします。

Box Developers Console

[カスタムアプリ]をクリックします。

Box Developers Console
マイアプリ>アプリの新規作成

[サーバー認証(JWT使用)のラジオボタンが選択された状態で任意の「アプリ名」を入力し、[アプリの作成]をクリックします。

Box Developers Console
カスタムアプリ

[公開/秘密キーペアを生成]をクリックします。

Box Developers Console
カスタムアプリ
公開キーの追加と管理

[Settings]をクリックします。

Box Developers Console
カスタムアプリ
公開キーの追加と管理
Settings

[▫アカウントを保護するために2段階認証を要求する]にチェックする。

[携帯電話番号]を入力し、[続行]をクリックします。

カスタムアプリ
ログイン認証を有効にする

携帯電話で受信したBox認証コードを[確認コード]に入力し、[続行]をクリックします。

[変更を保存]をクリックします。

カスタムアプリ
変更を保存

作成したアプリの[構成]に戻り、[公開/秘密キーペアを生成]をクリックします。

Box Developers Console
カスタムアプリ
公開キーの追加と管理
公開/秘密キーペアを生成

[OK]をクリックします。
(JSONファイルがダウンロードされます。)

JSONファイルのダウンロード

ダウンロードしたJSONファイルを任意のフォルダに格納します。
例:C:\boxdev

JSONファイルの格納

アプリの承認

作成したアプリ内の「一般設定」>「アプリの承認」[確認して送信]をクリックします。

「一般設定」>「アプリの承認」[確認して送信]

[アプリの説明]に任意入力し、[送信]をクリックします。

アプリ承認の送信内容の確認

Box管理者の方に承認してもらいます。

Box Cliのセットアップ(JSONファイルの適用)

以下のようにJSON構成ファイルを指定してBox Cliのセットアップを実施します。

box configure:environments:add C:\boxdev\XXXXXX_XXXXXXX_config.json

もし、以下エラーが発生した場合はJWT認証が正常にできていないように思われるため
Boxアプリケーションのセットアップを再度実施してください。

Config object missing key boxAppSettings.appAuth.publicKeyID

手順が多いため、抜けがあるかもしれません。
うまくいかない場合は以下公式サイトの手順を参考にしてください。

Box CLIのインストール - Box開発者向けドキュメントポータル
ここではアプリの開発に使用できるBoxのAPIやSDK、 APIドキュメント、開発者向けサポートリソースを探したり、 Box開発者コンソールにアクセスしたりすることができます

コメント

タイトルとURLをコピーしました