APIアクセススコープを作成する
スコープは、APIエンドポイントに対して実行できる高レベルの操作を表します。アプリケーションは認可サーバーからこれらのスコープを要求します。サーバーアクセスポリシーは、権限を付与するスコープと拒否するスコープを決定します。
すべての認可サーバーは複数の予約済みスコープを保有しています。必要に応じてアプリケーションごとに別のスコープを追加できます。
-
Admin Consoleで、に移動します。
- 認可サーバーの名前をクリックし、スコープ(Scopes)を選択します。
- スコープを追加(Add Scope)をクリックします。
- 名前と説明を入力します。
- ユーザーの同意(User Consent)オプションを選択します。
- 暗黙(Implicit):デフォルト設定。ユーザーは、情報へのアクセス権をアプリに付与するように求められません。このスコープについてユーザーの同意が暗に示されます。
- 任意([Optional):ユーザーはSign-In Widget に同意の画面が表示される場合、このスコープの承認をスキップできます。
- 必須(Required):このスコープについてユーザーの同意が必要であり、ユーザーは同意のオプションを変更しない可能性があります。
- 任意。ユーザーの同意(User Consent)(Optional)に任意(Optional)(Required)または必須(Required)(User Consent)オプションを選択する場合、サービスがこのスコープを要求するのをブロックする(Block services from requesting this scope)チェックボックスをオフにします。
-
許可リクエストでスコープを指定していないアプリにOktaが認可リクエストを付与できるようにするには、デフォルトスコープとして設定(Set as a default scope)を選択します。
クライアントが認可リクエストでスコープパラメーターを省略した場合、Oktaはアクセスポリシールールで許可されているすべてのデフォルトスコープをアクセストークンで返します。
- 公開メタデータにこのスコープを含めるには、公開メタデータに含める(Include in public metadata)を選択します。
-
保存(Save)をクリックします。
これらのスコープは、クレーム(Claims)によって参照されます。
注:
OAuth 2.0とOpenID Connectフローのユーザーの同意機能を使用するアプリを作成する場合は、スコープに関するユーザーの同意(User Consent)オプションを暗黙(Implicit)または必須(Required)に設定します。