Box®コネクターを使用すると、コマンドを使用して、以下のような形でBoxドライブと対話することができます:
- ファイルの検索と管理
- フォルダの作成と削除
- ファイルやフォルダのURL取得
メモ: このコネクターはWorkivaによって構築され、サードパーティのシステムに接続する。Workivaサポートチームは、お客様のワークスペース内でこのコネクターの構成をヘルプすることはできますが、Workivaプラットフォーム外で発生した問題のトラブルシューティングやその他のサポートを行うことはできません。
前提条件
コネクターの設定には、以下のものが必要だ:
- サービスアカウント統合用のカスタムBoxアプリ
- カスタム・アプリのエンタープライズID、クライアントIDとシークレット、秘密キー
Boxでサービスアカウント統合を作成する
Boxコネクターを設定する前に、サービスアカウント統合用のカスタムBoxアプリを作成します。 アプリの公開キー/秘密キーのペアを構成するには、以下のものが必要です:
- OpenSSL
- Windowsメモ帳などのプレーンテキスト編集者
- Boxで二要素認証(2FA)を有効にする
ステップ1:カスタムBoxアプリケーションの作成
- Dev Console in Boxから、Create New Appをクリックします。
-
Custom App を選択し、Next をクリックする。
-
認証方法 で、OAuth 2.0 with JWT を選択し、次へ をクリックする。
- Workiva Box App など、アプリの識別に役立つ一意の名称を入力し、Create Appをクリックし、View Your App をクリックします。
ステップ2:アプリのRSAキー・ペアの作成
接続を保護するために、BoxコネクターはカスタムアプリのRSA(Rivest-Shamir-Adleman)公開キー/秘密キーペアを使用して認証します。このキー・ペアをOpenSSL で作成するには、以下のコマンドを入力する:
openssl genrsa -out private.pem 2048
openssl rsa -in private.pem -outform PEM -pubout -out public.pem
これらのコマンドは2つのファイルを生成する:
-
private.pem、コネクターがBoxとの認証に使用するクライアント・キーを含む。 - カスタムアプリの構成に必要な
public.pem
ステップ3:カスタムアプリの構成
- Dev Console in Boxから、カスタムアプリ向けにConfigurationを選択します。
-
Authentication Method で、OAuth 2.0 with JWTが選択されていることを確認する。
-
Application Access で、Enterprise を選択し、 Save Changes をクリックします。
- プレーンテキストの編集者で、
public.pemファイルを開き、ヘッダー行-----BEGIN PUBLIC KEY-----、フッター行-----End PUBLIC KEY-----、および末尾の空白を含むコンテンツ全体をコピーします。 - BoxのDev Console から、カスタムアプリのConfiguration を選択し、Add and Manage Public KeysのAdd a Public Keyをクリックする。
-
public.pemファイルのコンテンツ全体を貼り付け、Verify and Save をクリックする。 - プロンプトが表示されたら、Boxアカウントの2FAコードを入力し、Submitをクリックします。
-
OAuth 2.0 Credentials の下に、カスタムアプリのクライアントIDをコピーします。
ステップ4:Boxでカスタムアプリの作成者を認証
- Admin Console in Box から、Apps をクリックします。
- Custom Apps タブで、Authorize New App をクリックする。
- カスタムアプリのクライアントIDを貼り付け、次へ をクリックする。
- App Authorization で、アプリが「All Users(すべてのユーザー)」に認証されていることを確認し、Authorize をクリックします。
ステップ5:Boxフォルダの共同作業者としてサービスアカウントIDを追加する
- Dev Console in Boxから、カスタムアプリ向けにConfigurationを選択します。
- サービスアカウントIDをコピーします。
- 共有するBoxフォルダに移動します。共有」で「コラボレーション/共同作業者」セクションを探し、「Invite People 」をクリックしてサービスアカウントIDを追加します。
ボックスコネクターの設定
注: 組織のチェーンでコネクターを使用できるようにするには、まず最初に組織のセキュリティ管理者が構成から コネクターを有効にする必要があります。
- チェーンビルダー から接続 をクリックし、右上の作成 をクリックします。
-
コネクタ 接続 で、ボックス とデフォルト CloudRunner を選択します。
- [基本情報]で、接続の識別に役立つ一意の名前と説明を入力します。
- [プロパティ]で、接続の詳細を入力します。
プロパティ 詳細 クライアントID コネクターのサービスアカウント統合として使用するカスタムBoxアプリのクライアントIDを入力します。 メモ: Dev Console in Box から、クライアントIDはカスタムアプリのConfiguration タブのOAuth 2.0 Credentials の下に表示されます。
クライアントの秘密 カスタムアプリのクライアントシークレットを入力します。 メモ:Dev Console in Boxから、クライアントシークレットはカスタムアプリのConfiguration タブのOAuth 2.0 Credentials の下に表示されます。
クライアントキー ヘッダー行 -----BEGIN RSA PRIVATE KEY-----、フッター行------ RSA PRIVATE KEY-----、および末尾の空白を含む形で、カスタムアプリ用に作成されたprivate.pemファイルの全コンテンツを入力します。エンタープライズID カスタムアプリのエンタープライズIDを入力します。 注: Dev Console in Boxから、エンタープライズIDはカスタムアプリのGeneralタブのApp Infoの下に表示されます。
注:機密性の高い資格情報はすべて自動的に暗号化され、高度な暗号化標準(AES)-256暗号化で保存されます。
- 接続を使用する環境を選択して、保存をクリックします。
- 接続をテストするには、チェーン を作成し、コネクターのフォルダー情報を取得 コマンド で実行し、有効な出力を返すことを確認します。
トラブルシューティング
Boxへの接続に失敗した場合:
- カスタムアプリがBoxで認証されていることを確認します。
- コネクターに入力されたカスタム・アプリのクライアントIDとシークレットを確認します。BoxのDev Console から、カスタムアプリのConfiguration タブのOAuth 2.0 Credentials の下にクライアントIDとシークレットが表示されます。認証情報をリセットするには、Reset をクリックします。
- カスタム・アプリのpublic.pem および
private.pemファイルの全コンテンツが、アプリとコネクターの構成にそれぞれ入力されていることを確認します。ヘッダー線、フッター線、末尾の間隔を含みます。必要に応じて、OpenSSLで新規公開キー/秘密キー・ペアを作成し、アプリとコネクターの構成にそのコンテンツを入力します。 - コネクターに入力されたカスタム・アプリのエンタープライズIDを確認します。Dev Console in Boxから、エンタープライズIDはカスタムアプリのGeneral タブのApp Info の下に表示されます。
- 共有されるフォルダにサービスアカウントIDが共同作業者として追加されていることを確認します: