Skip to main content

概要

本記事ではスコープ属性について解説します。
本機能は Authlete 2.0 以降でのみ利用可能になります。

スコープ属性とは

スコープ属性とは、あるスコープに関連づけられる key-value 形式の任意の属性です。 それぞれのスコープに対して複数の属性を関連づけ、認可サーバーにおける認可決定やそ の他の処理に、それらの属性を活用できます。またいくつかの属性は Authlete があらか じめ定義しており、システム設定に用いられます。
設定方法

スコープの属性の設定は以下の手順で行います。
  1. サービス管理者コンソールにログインし、対象のサービスの編集画面を開きます。
  2. 「スコープを作成」ボタンを押下し、スコープの編集画面を開きます。
  3. 最下部の属性ボタンから属性を追加します。
  4. 属性の key と value の値を入力し、作成ボタンを押下します。各属性の key、value の値は文字列として扱われることにご注意ください。
スクリーンショット_2019-09-30_17 コンソール上でスコープの属性を作成
設定手順の動画: Scope attributes.mov 5.63 MB

定義済みのスコープ属性

以下にリストアップされた属性は、Authlete では特別な意味を持つものとして定義され ています。

利用方法

スコープの属性はさまざまな場面で活用可能です。以下の Java による認可サーバーのサ ンプルコードは、クライアントからの認可リクエストを Authlete の /auth/authorization API を 用いて解析し、そのリクエストに含まれるスコープに関連づけられている属性をもとに、 なんらかの処理を行う例です。