ネイティブ OAuth プロバイダーのメタデータの構成

認証 URL または外部 URL のパラメーターを使用して、リモート・サーバーからユーザー定義コンテンツを要求し、これをアクセス・トークンまたは応答ペイロード (これにはアクセス・トークンが含まれる) に組み込みます。

このタスクについて

トークンに組み込むためにカスタム・メタデータが収集される元の認証 URL または外部 URL を構成します。 このメタデータはアクセス・トークン内に格納されるか、アクセス・トークンとともにクライアント・アプリケーションに送信されます。メタデータの収集方法の詳細については、 OAuth外部 URL および認証 URL を参照してください。

アクセス・トークンに組み込むことができるメタデータの例は次のとおりです。

  • 認証済みのリソース所有者に関するメタデータ
  • トークンの取得に使用された権限付与タイプ
  • クライアント・アプリケーションに提供される確認コード

ネイティブ OAuth プロバイダーのメタデータ収集を構成するには、以下のいずれかのロールが必要です。

  • 組織管理者
  • 所有者
  • 「設定」 > 「管理」 権限を持つカスタム役割

ネイティブ OAuth プロバイダーの構成」で詳述されている作成操作の完了直後に、ネイティブ OAuth プロバイダーのメタデータ設定ページを選択することも、既存のネイティブ OAuth プロバイダーのメタデータ設定を更新することもできます。 既存のネイティブ OAuth プロバイダーのメタデータ設定を更新する場合は、このトピックで説明する手順に従う前に、以下のステップを実行してください。

  1. リソース・アイコン 「リソース」 > 「OAuth プロバイダー」をクリックします。
  2. 必要なネイティブ OAuth プロバイダーを選択します。

手順

  1. サイドバー・メニューで 「メタデータ」 をクリックします。
  2. メタデータ収集を有効にするには、 「メタデータの収集」 を選択します。
  3. 認証 URL ユーザー・レジストリーがデフォルトで選択されており、必須です。 認証に関する詳細情報については、 URL、 認証 URL ユーザーレジストリをご覧ください。
  4. 外部 URL からメタデータを収集するための外部 URL を選択します。 エンドポイントおよびオプションの TLS クライアント・プロファイルを入力します。
  5. DataPower API Gateway のみ必要に応じて、デフォルトの 「ヘッダー名トークン」 値をオーバーライドします。 このヘッダーの値は、OAuth エンドポイントからの応答で返された場合、応答ペイロードに配置され、 metadataとして示されます。
  6. DataPower API Gateway のみ必要に応じて、デフォルトの 「ヘッダー名ペイロード」 値をオーバーライドします。 このヘッダーの値は、OAuth エンドポイントからの応答で返された場合、アクセス・トークン内に配置され、 miscinfoとして示されます。
  7. OAuth プロバイダーを保存します。
  8. 完了したら、 「保存」 をクリックします。

結果

OAuth プロバイダーを使用して、カタログ内の API を保護できます。