Box 開発者プラットフォーム

Auth Types and Scopes

Box は 2 種類の認証を提供しています。 Box REST API を使用するには、どちらかの認証を選択する必要があります。正しい選択は、構築しているアプリケーションの種類によって決まります。

OAuth 2

OAuth 2 では、ユーザーが Box にログインして、ファイルおよびフォルダへのアクセス権限をアプリケーションに与える必要があります。 OAuth 2 標準は、3 段階の認証プロセスを定義しており、Box はこのプロセスに従っています。

OAuth 2 の Box 実装は、管理対象のユーザーおよび外部ユーザー向けに使用します。 外部ユーザーは、Box ユーザー本人が独自に使用するために作成したアカウントです。

管理対象のユーザーは、別のユーザーが使用するために管理者が作成したアカウントです。 管理対象のユーザーの一般的な例としては、ユーザーが担当している会社、またはユーザーが属している会社によって、そのユーザー用に作成されたアカウントが挙げられます。 管理対象のユーザーアカウントは特定ユーザーのアカウントですが、このアカウントに適用されるポリシーおよび権限は管理者によって管理されます。

OAuth 2 と JSON Web Token

OAuth 2 と JSON Web Token では、アプリケーションを Box に直接接続して、ユーザーにログインを要求せずに、ファイルおよびフォルダへのアクセス承認を取得できます。 OAuth 2 と JSON Web Token を使用すると、ユーザーに Box の存在を意識させることなく、アプリケーションは Box の機能を提供できます。

アプリケーションは、ユーザーに Box へのログインを要求せずに、RSA キーペアにより確認された JSON Web Token(JWT)を生成します。 この認証が成功すると、アプリケーションは、Box ファイルとフォルダでの操作が承認されるアクセストークンを取得します。

このマシン対マシンの認証は、OAuth 2 によって定義された 3 段階認証プロセスの最初の段階を代替するもので、アプリケーションユーザーは、Box のログイン要求を見ることもなく、Box コンテンツを操作できます。

OAuth 2 with JSON Web Tokens is designed to be used with Box Platform. You can use OAuth 2 with JWT with both Service Accounts and App Users.


認証タイプの選択

Box 統合を構築
Box Platform で構築

説明

これによりユーザーは、電子署名やプロジェクト管理サービスなどのサードパーティ製のアプリ内で Box のコンテンツにアクセスして、編集、保存できるようになります。

ファイルの管理とレンダリングや、エンドユーザーコラボレーションを可能にする Box のコンテンツサービスを使用して、スタンドアロンアプリを構築します。

認証メカニズム

OAuth 2.0(3 レッグ)

OAuth 2.0 と JSON Web Token

ユーザー

管理対象ユーザー

Service Accounts, App Users


OAuth 2 スコープ

スコープ
説明

すべてのファイルとフォルダの読み取りと書き込み

Scope name: root_readwrite

アプリケーションでファイルバージョンのアップロード、表示、ダウンロード、および現在のファイルバージョンの更新を行えます。

アプリケーションでコラボレーション、タグ、タスク、コメント、@メンション、タスク割り当て、通知、収集の作成、編集、削除を行えます。

アプリケーションでエンタープライズプロファイルを表示できます。

エンタープライズを管理

Scope name: manage_enterprise

ユーザー、コンテンツ、コラボレーション、グループ、レポート、管理設定を表示、作成、編集、削除する権限など、エンタープライズ管理で使用できるスコープの完全なセット。

エンタープライズの管理対象ユーザーの管理

Scope name: manage_managed_users

「エンタープライズの管理」スコープのサブセット

アプリケーションで Standard Box Users の追加、表示、編集、削除、有効化、無効化を行えます。

アプリケーションでプライマリログインの変更、パスワードのリセット、管理対象ユーザーのロール変更、およびエンタープライズコンテンツの管理を行えます。

エンタープライズのグループの管理

Scope name: manage_groups

「エンタープライズの管理」スコープのサブセット

アプリケーションでグループとグループメンバーシップの表示、作成、編集、削除を行えます。

エンタープライズのプロパティの管理

Scope name: manage_enterprise_properties

「エンタープライズの管理」スコープのサブセット

アプリケーションでエンタープライズ属性とレポートの表示と編集、デバイスピンナーの編集と削除を行えます。

エンタープライズの保持ポリシーの管理

Scope name: manage_data_retention

アプリケーションで Box Governance を使用してコンテンツ保持ポリシーの表示と作成を行えます。 詳細については、こちらをご覧ください。

App Users の作成と管理

Scope name: manage_app_users

アプリケーションで App Auth 機能を使用して、自身の App Users のプロビジョニングと管理を行えます。 詳細については、こちらをご覧ください。

Webhook を管理

Scope name: manage_webhook

APIを使用してプログラム的に Webhook を作成することができます。詳細については、こちらを参照してください。

Changing Scopes After App Authorization

If you change your application's scopes after the Admin has authorized your application in their Box enterprise, these new scopes will not be reflected in that Box enterprise until the Admin reauthorizes your application in the Admin console.

高度な機能

警告:

高度な機能は、JSON Web Tokens を使用したサーバー側の開発にのみ使用できます。

スコープ
説明

ユーザーとしてアクションを実行

As-User ヘッダーを使用して、アプリケーションがユーザーに代わって API 呼び出しを行うことができます。

ユーザーアクセストークンを生成

ユーザー指定の資格情報ではなく JWT グラントを使用して、アプリケーションがユーザーの OAuth 2.0 アクセストークンを生成できます。

Questions
If you have any questions, please visit our developer forum.

Auth Types and Scopes