OAuth2 セキュリティー・スキームの定義
OAuth2 セキュリティスキームは、 OAuth 認可標準を通じてAPI操作へのアクセスを制御するための設定を定義します。
開始前に
OAuth2 セキュリティー・スキームを作成する前に、以下を行う必要があります。
- OAuth プロバイダーを作成します。
- Cloud Manager を使用するには、 「ネイティブの OAuth プロバイダーの設定」 または 「サードパーティの OAuth プロバイダーの設定」 を参照してください。
- API Manager を使用するには、 「ネイティブ OAuth プロバイダーの設定」 または 「サードパーティ製 OAuth プロバイダーの設定」 を参照してください。
- OAuth プロバイダーをカタログに追加します。 カタログを作成していない場合は、サンドボックス・カタログを使用します。 「カタログの作成と設定」 の 「 OAuth 」手順を参照してください。
このタスクについて
注: このタスクは、 OpenAPI 2.0 API 定義の構成に関連しています。 OpenAPI 3.0 API 定義の構成方法について詳しくは、 OpenAPI 3.0 API 定義の編集を参照してください。
このタスクは、 API Designer UI アプリケーションを使用するか、ブラウザー・ベースの API Manager UI を使用して実行できます。
OAuth2 セキュリティー・スキームを利用するには、API 定義内の他の場所からそのセキュリティー・スキームを参照する必要があります。 詳細については、 「API に対するセキュリティ要件の適用」 および 「操作に対するセキュリティ要件の適用」 を参照してください。
「ソース 」アイコンをクリックすると、いつでも直接、基盤となる OpenAPI
のYAMLソースに切り替えることができます。 デザインフォームに戻るには、 フォームアイコンをクリックしてください 
。
手順
- 「 OAuth2 」セキュリティスキームを作成するには、 「セキュリティスキーム」 の横にある
追加アイコンをクリックし、「 oauth2 」を選択します。 既存の OAuth2 セキュリティー・スキームを編集するには、ナビゲーション・ペインでセキュリティー・スキーム名をクリックします。 - 以下の情報を指定します。
- セキュリティー・スキーム名: ユーザーが選択した識別名。
- OAuth プロバイダー : 使用する OAuth プロバイダーを選択してください。
- フロー: 以下のいずれかのオプションを選択します。
- 暗黙
- リソース所有者 - パスワード
- アプリケーション
- アクセス・コード
注記: 選択可能なフローオプションは、選択した OAuth プロバイダーがサポートするオプションによって異なります。OAuth プロバイダーを作成する際にサポートするグラントタイプとして「 リソース所有者 - JWT」 を選択した場合、このセキュリティスキームのフロー として 「リソース所有者 - パスワード」 を選択する必要があります。
- 説明 (オプション): OAuth2 セキュリティー・スキームの説明。 リッチテキストの表現には、 CommonMark 構文を使用できます。
- URL エンドポイント (フロー・タイプに応じて該当するエンドポイント):
- 許可 URL
- トークンURL
注： ここで提供されている URL エンドポイント値は、参考情報としてのみ維持されており、 API ConnectAI Gateway によってそれらに検証やその他のアクションは適用されません。 適用される OAuth セキュリティーは、指定された OAuth プロバイダーによって異なります。 - スコープ (既存の OAuth2 セキュリティー・スキームを編集する場合に使用可能):
- 新規スコープを追加するには、 「追加」をクリックします。 既存のスコープを編集するには、対象のスコープの横にある
オプションアイコンをクリックし、次に 「編集」 をクリックします。 - 以下の情報を指定します。
- スコープ: スコープ ID。
- 説明 (オプション): スコープの説明。 リッチテキストの表現には、 CommonMark 構文を使用できます。
- 新規スコープを作成する場合は、 「作成」をクリックします。
- 新規スコープを追加するには、 「追加」をクリックします。 既存のスコープを編集するには、対象のスコープの横にある