OAuth 2.0を使用した設定

ガイド 認証 OAuth 2.0認証 OAuth 2.0を使用した設定

OAuth 2.0を使用した設定

カスタムアプリは、クライアント側のOAuth 2.0認証を使用するよう設定できます。

OAuth 2.0認証のしくみを確認する

前提条件

OAuth 2.0認証を使用してカスタムアプリを設定するには、Box Enterpriseアカウントから開発者コンソールにアクセスできることを確認する必要があります。または、Developerアカウントにサインアップすることもできます。

アプリの作成手順

1. 開発者コンソールに移動する

Boxにログインし、開発者コンソールに移動して、[アプリの新規作成] を選択します。

2. アプリケーションの種類を選択する

アプリケーションの種類のリストから [カスタムアプリ] を選択します。次の手順を促すモーダルが表示されます。

アプリケーションの選択画面

3. 認証の種類とアプリ名を選択する

[ユーザー認証 (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の保存は許可されていません。

日本時間2021年11月30日以降、OAuth 2.0を使用する新規のアプリケーションでは、開発者コンソールの [構成] タブで設定されたURIとリダイレクト時に使用されるURIが厳密に一致する必要があります。また、そのため新規のアプリケーションと既存のアプリケーションの両方で、複数のリダイレクトURIを追加できるようになります。

アプリケーション用にリダイレクトURIを複数設定した場合、承認URLには、開発者コンソールで設定したURIのいずれかと一致するredirect_uriパラメータを含める必要があります。このパラメータが指定されていない場合、ユーザーがアプリケーションにアクセス権限を付与すると、redirect_uri_missingエラーが表示され、アプリにリダイレクトされません。

既存のアプリケーションでは、サービスの中断を回避するために、日本時間2022年5月14日までにこのURLを変更する必要があります。

アプリ名のフォーム

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

スコープを使用して、アプリケーションがデータにアクセスするために必要な権限を定義します。各オプションの詳細については、スコープのガイドを参照してください。

アプリ名のフォーム

CORSドメイン

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

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

アプリ名のフォーム