資格情報交換

Machine to Machine フローの一環として Access Token が発行される際に実行される Credentials Exchange Actions について説明します。これらを使用して交換を拒否したり、アクセストークン にカスタムクレームを追加したりできます。

credentials-exchange トリガーは、クライアント認証情報フロー を介して Access Token が発行される際に、アクセストークン が返される前に実行されます。

このフローの Actions はブロッキング (同期) で、トリガーの処理の一部として実行されます。Action が完了するまで、Auth0 パイプラインの残りの処理は実行されません。

​

リファレンス

• イベントオブジェクト: クライアント資格情報交換リクエストに関するコンテキスト情報を提供します。
• API object: フローの動作を変更するためのメソッドを提供します。

​

一般的なユースケース

​

アクセス制御

credentials-exchange Action を使用すると、カスタムロジックに基づいて アクセストークン の発行を拒否できます。

/**
 * @param {Event} event - クライアントクレデンシャルグラントのリクエストに関する詳細。
 * @param {CredentialsExchangeAPI} api - クライアントクレデンシャルグラントの動作を変更するメソッドを提供するインターフェース。
 */
exports.onExecuteCredentialsExchange = async (event, api) => {
  if (event.request.geoip.continentCode === "NA") {
    api.access.deny('invalid_request', "北米からのアクセスは許可されていません。");
  }
};

​

アクセストークンにカスタムクレームを追加する

credentials-exchange Action を使用すると、アクセストークンにカスタムクレームを追加できます。

/**
 * @param {Event} event - クライアントクレデンシャルグラントリクエストの詳細。
 * @param {CredentialsExchangeAPI} api - クライアントクレデンシャルグラントの動作を変更するためのメソッドを提供するインターフェース。
 */
exports.onExecuteCredentialsExchange = async (event, api) => {
  api.accessToken.setCustomClaim("https://my-api.exampleco.com/request-ip", event.request.ip);
};

URI形式の名前空間付きカスタムクレームを使用することを強くお勧めします。名前空間付きおよび非名前空間のカスタムクレームについて詳しくは、Create Custom Claimsを参照してください。