REST API 認証スコープの設定

OAuth エンティティを認証スコープにリンクすることで、認証スコープにリンクされている REST API にアクセスするためのトークンを管理します。

始める前に

次のプラグインをインストールします。

• OAuth 2.0
• REST API Provider
• Authentication scope
• REST API Auth Scope

注:

REST API Auth Scope プラグインは Tokyo リリースの一部として追加されます。

必要なロール：admin

手順

1. 次のように移動する。 All (すべて) > API 認証スコープ > REST API 認証スコープ.
   [REST API 認証スコープ] ページが表示されます。
2. 新しい REST API 認証スコープを設定するには、[新規] をクリックします。
3. フォームのフィールドに入力します。

   表 : 1. REST API 認証スコープ

   名前	REST API 認証スコープを識別する一意の名前。
   有効	チェックボックスをオンにすると、設定がアクティブになります。
   アプリケーション	読み込み専用のアプリケーションスコープ
   REST API	認証スコープが適用される REST API。たとえば、テーブル API などです。
   認証スコープ	検索アイコンから認証スコープを選択します。
   REST API パス	REST API の API パス。このフィールドは、選択した REST API に基づいて自動入力されます。例：now/table
   HTTP メソッド	API とのやり取りに使用されるメソッド。ドロップダウンリストからメソッドを選択します。 フォームの [この API のすべての HTTP メソッドに認証スコープを適用] フィールドを手動で無効にすると、メソッドを選択できます。
   REST API バージョン	API のバージョン。- 例：v1。このフィールドは、選択した REST API に基づいて自動入力されます。 フォームの [この API のすべてのバージョンに認証スコープを適用] フィールドを手動で無効にすると、バージョンを選択できます。
   リソース	REST API の子リソース。このフィールドは、選択した REST API に基づいて自動入力されます。例：/now/table フォームの [この API のすべてのリソースに認証スコープを適用] フィールドを手動で無効にすると、リソースを選択できます。
   この API のすべての HTTP メソッドに認証スコープを適用	これを有効にすると、API のすべての HTTP メソッドに認証スコープが適用されます。
   この API のすべてのバージョンに認証スコープを適用	これを有効にすると、API のすべてのバージョンに認証スコープが適用されます。
   この API のすべてのリソースに認証スコープを適用	これを有効にすると、API のすべてのリソースに認証スコープが適用されます。

4. [送信] をクリックします。
   選択された REST API と認証スコープに基づいて、API はスコープに固有の情報を取得します。

テーブル API に対して 3 つの REST API 認証スコープを作成することを検討してください。

1 つ目の認証スコープは、すべての HTTP メソッド、バージョン、およびリソースが有効な状態で [テーブル API] にマッピングされます。

2 つ目の認証スコープは、すべてのバージョンとリソースが有効な状態で [テーブル API] にマッピングされます。ただし、HTTP メソッド (この例では GET メソッド) は選択してください。

3 つ目の認証スコープは、HTTP メソッド、バージョン、およびリソースが有効でない状態で [テーブル API] にマッピングされます。ただし、HTTP メソッド、バージョン、およびリソースは手動で選択してください。この例では、HTTP メソッドは GET、REST API のバージョンは最新、リソースは /now/table/{tableName} です。

これらの認証スコープがすべて作成されると、3 つのスコープすべてで GET メソッドを使用できますが、POST、PUT、DELETE、または PATCH メソッドでは scope3 しか使用できません。