JWTを使用した設定

A Platform App can be set up to use server-side authentication with JWT.

前提条件

To set up a Platform App using server-side authentication, you will need to ensure you have access the Developer Console from your Box enterprise account. Alternatively, you may sign up for a developer account.

アプリの作成手順

開発者コンソールへの移動

Log into Box and go to the Developer Console. Select Create Platform App.

アプリケーションの種類の選択

Select Platform App from the list of application types. A modal will appear to prompt a selection for the next step.

アプリケーションの基本情報の指定

アプリを説明するために、アプリの名前と説明を指定します。アプリの目的を選択するには、ドロップダウンリストを使用します。選択したオプションに応じて、さらに詳細を指定することが必要になる場合があります。

アプリケーションの認証の選択

Select Server Authentication (with JWT) if you would like to verify application identity with a key pair and confirm with Create Platform App.

公開キーと秘密キーのペア

Once a Platform App is created leveraging Server Authentication with JWT, a key pair can be generated via the configuration tab within the Developer Console. Alternatively, you can generate your own and supply Box with the public key. Regardless of the method you select, your Box account will need to have 2FA enabled for security purposes.

キーペアの生成 (推奨)

Boxで生成されたキーペアを使用する場合は、開発者コンソールに移動し、そこで構成ファイルを生成できます。このファイルには、公開/秘密キーペアのほか、認証に必要なその他さまざまなアプリケーションの詳細が含まれています。

このファイルを生成するには、開発者コンソールの [構成] タブに移動し、[公開キーの追加と管理] セクションまで下にスクロールします。

[ 公開/秘密キーペアを生成] ボタンをクリックすると、Boxによってキーペアが生成されます。これにより、アプリケーションコードに移すことができるJSON構成ファイルのダウンロードが開始されます。

手動によるキーペアの追加

代わりに、独自のキーペアを生成し、その公開キーを開発者コンソールにアップロードすることもできます。

OpenSSLを使用してキーペアを作成するには、ターミナルウィンドウを開き、以下のコマンドを実行します。

openssl genrsa -des3 -out private.pem 2048
openssl rsa -in private.pem -outform PEM -pubout -out public.pem

その後、開発者コンソールでアプリケーションの [構成] タブに移動し、[公開キーの追加と管理] セクションまで下にスクロールします。

[公開キーを追加] ボタンをクリックし、上記の手順で生成された公開キーを入力して、[確認して保存] をクリックします。

アプリ承認

アプリケーションを使用するには、Box管理者がBox管理コンソールでそのアプリケーションを承認しておく必要があります。

開発者コンソールで、目的のアプリケーションの [承認] タブに移動します。

[確認して送信] をクリックして、承認を得るためにBox Enterprise管理者にメールを送信します。このプロセスの詳細については、アプリの承認に関するサポート記事を参照してください。

基本的な構成

アプリケーションアクセス

アプリケーションのアクセスレベルにより、アプリからアクセスできるユーザーおよびコンテンツが決まります。デフォルトでは、アプリケーションで問題なく操作できるのは、そのサービスアカウントとすべてのApp Userのコンテンツのみです。企業の既存の管理対象ユーザーや、アプリ自体が作成していないグループにアクセスするには、開発者コンソールの [構成] タブにある [アプリアクセスレベル] に移動し、[アプリ + Enterpriseアクセス] に設定します。そうしないと、このような管理対象ユーザーとグループへのアクセスはブロックされます。

アプリケーションスコープ

アプリケーションのスコープにより、アプリケーションが呼び出すことができるエンドポイントとリソースが決まります。各オプションの詳細については、スコープのガイドを参照してください。

CORSドメイン

アプリケーションがJavaScriptでフロントエンドのブラウザコードからAPIコールを実行する場合は、クロスオリジンリソース共有 (CORS) のために、これらの呼び出しの実行元となるドメインを許可リストに追加する必要があります。すべてのリクエストがサーバー側のコードから発行される場合は、このセクションをスキップできます。

許可リストに完全なURIを追加するには、開発者コンソールの [構成] タブの下部にある [CORSドメイン] セクションに移動します。