OAuth 2.0を使用した設定
OAuth 2.0を使用した設定
カスタムアプリは、クライアント側のOAuth 2.0認証を使用するよう設定できます。
OAuth 2.0認証のしくみを確認する
前提条件
OAuth 2.0認証を使用してカスタムアプリを設定するには、Box Enterpriseアカウントから開発者コンソールにアクセスできることを確認する必要があります。または、Developerアカウントにサインアップすることもできます。
アプリの作成手順
開発者コンソールへの移動
Boxにログインし、開発者コンソールに移動して、[Platformアプリの作成] を選択します。
アプリケーションの種類の選択
アプリケーションの種類のリストから [カスタムアプリ] を選択します。次の手順を促すウィンドウが表示されます。
アプリケーションの基本情報の指定
アプリを説明するために、アプリの名前と説明を指定します。アプリの目的を選択するには、ドロップダウンリストを使用します。選択したオプションに応じて、さらに詳細を指定することが必要になる場合があります。
目的 | 詳細 |
---|---|
[自動化]、[カスタムポータル] | アプリの作成者 (お客様またはパートナー) を指定します。 |
[統合] | 統合のカテゴリ、外部システム名のほか、アプリの作成者 (お客様またはパートナー) を指定します。 |
[その他] | アプリの目的と、アプリの作成者 (お客様またはパートナー) を指定します。 |
アプリケーションの認証の選択
[ユーザー認証 (OAuth 2.0)] を選択し、[アプリの作成] で確定します。
基本的な構成
アプリケーションを使用するには、事前にいくつかの追加構成が必要になります。
リダイレクトURI
OAuth 2.0フローの間、ユーザーは、認証のためにブラウザにリダイレクトされた後、アプリケーションが自分の代わりにアクションを実行することを承認します。
Boxでは、ユーザーをリダイレクトする前に、承認URLに渡されたredirect_uri
パラメータが、アプリケーションに構成されたリダイレクトURIのいずれかと一致することを確認します。完全に一致しているかどうかがチェックされるため、URIはまったく同じである必要があります。localhostおよびループバックアドレスのリダイレクトURIは、どのポートへのリダイレクトも許可されますが、スキーム、ドメイン、パス、およびクエリパラメータは、構成されているURIのいずれかと一致する必要があります。
これらのURIは、開発者コンソールの [構成] ページにある [OAuth 2.0リダイレクトURI] セクションで設定できます。有効なHTTPS URIまたは安全性の低いHTTP URI (localhostまたはループバックアドレスの場合) である必要があります。重複するURIの保存は許可されていません。
アプリケーションスコープ
スコープを使用して、アプリケーションがデータにアクセスするために必要な権限を定義します。各オプションの詳細については、スコープのガイドを参照してください。
CORSドメイン
アプリケーションがJavaScriptでフロントエンドのブラウザコードからAPIコールを実行する場合は、クロスオリジンリソース共有 (CORS) のために、これらの呼び出しの実行元となるドメインを許可リストに追加する必要があります。すべてのリクエストがサーバー側のコードから発行される場合は、このセクションをスキップできます。
許可リストにすべてのURIを追加するには、開発者コンソールの [構成] タブの下部にある [CORSドメイン] セクションに移動します。