ネイティブ OAuth プロバイダーのトークンの構成

アクセス・トークンおよびリフレッシュ・トークンの存続時間を設定し、すべてのトークンに対して同意の最大の期間を設定します。

このタスクについて

アクセス・トークンは、クライアント・アプリケーションがアプリケーション・ユーザーに代わってリソースにアクセスできるようにするためにアプリケーションに付与されます。 リフレッシュ・トークンは、現行のアクセス・トークンが無効または期限切れになったときに新規アクセス・トークンを取得するため、または同じスコープあるいはより狭いスコープの追加アクセス・トークンを取得するために、クライアントに対して発行されます。 また、任意のアクセス量とリフレッシュトークンの組み合わせによって与えられた同意が有効である期間を指定することもできます。

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

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

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

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

手順

  1. サイドバー・メニューの 「トークン」 をクリックします。
  2. トークンを構成するための設定を定義します。
    フィールド 説明
    アクセス・トークンの存続時間 アクセス・トークンの有効期限を秒単位で入力します。
    DataPower API Gateway のみ1回限りのアクセストークン アクセストークンのワンタイムユースを有効にする場合は、チェックボックスをクリックします。 アクセストークンはデフォルトで複数使用可能で、複数のリクエストに使用できます。 ワンタイムユースが有効な場合、アクセストークンは1回の使用で消費されます。 別のアクセストークンを取得するには、OAuthフローを繰り返す必要がある。
    注: このオプションを選択する場合は、トークン管理も有効にする必要があります。使用しているユーザー・インターフェースに応じて、以下のいずれかのトピックを参照してください。
    リフレッシュ・トークン 「リフレッシュ・トークン」を有効にするには、このチェック・ボックスをクリックします。 「カウント」を設定して、リフレッシュ・トークンを発行できる回数を制限します。 「リフレッシュ・トークンの存続期間」値を設定して、リフレッシュ・トークンごとに存続時間または有効期限を秒単位で決定します。
    ワンタイム使用のリフレッシュ・トークン リフレッシュ・トークンの1回限りの使用を無効にするには、チェックボックスをオフにします。 リフレッシュ・トークンはデフォルトで1回限りの使用となっており、アクセストークンと新しいリフレッシュ・トークンを生成するために1回だけ使用することができます。 リフレッシュ・トークンのワンタイム・ユースを無効にすると、リフレッシュ・トークンの数は1つに制限され、新しいアクセストークンを生成するためにリフレッシュ・トークンを複数回使用することができます。
    注: このオプションを選択する場合は、トークン管理も有効にする必要があります。使用しているユーザー・インターフェースに応じて、以下のいずれかのトピックを参照してください。
    同意の最大 「同意の最大」を有効にするにはこのチェック・ボックスをクリックし、「同意の最大の存続時間」値を秒単位で入力します。 これは、すべてのトークン (アクセス・トークンとリフレッシュ・トークンの両方) の存続時間または有効期限です。
    DataPower API Gateway のみトークン秘密鍵 チェックボックスをクリックして、ゲートウェイ用に設定された共有シークレットを選択します。 ゲートウェイ構成で共有シークレットが入力されていない場合は、トークン・シークレットとして使用するキー名とキー値を入力します。
    DataPower API Gateway のみコード交換のための証明キー

    Proof Key for Code Exchange (PKCE) は、 OAuth 2.0 公開クライアントが許可コードの権限付与要求を使用するときに、許可コードのインターセプト攻撃から保護する方法です。 DataPower® API Gatewayを使用してデプロイするときに、この拡張機能を有効にすることができます。

    詳しくは、 RFC 7636を参照してください。

    OAuth プロバイダーのオプションを選択します。
    • Proof Key for Code Exchange を有効にする

      これを選択した場合は、許可コード権限付与要求で送信するときに PKCE を適用します。

    • 常に必須

      これを選択した場合は、すべての許可コード権限付与要求で PKCE が必要です。

    • プレーンを許可

      許可コード権限付与要求でプレーン・チャレンジ・メソッドを許可するには、このチェック・ボックスを選択します。

  3. 完了したら、 「保存」 をクリックします。

結果

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