Skip to main content
リフレッシュトークンのメタデータを使用すると、Auth0のリフレッシュトークンに、カスタマイズ可能なキーと値 (各最大255文字) を保存できます。 リフレッシュトークンのメタデータのユースケースには、次のようなものがあります。
  • デバイス名やログイン場所などのデバイス情報を追跡する
  • user_accepted_terms や session_type などのトークンレベルのフラグを保存する
  • 同じフロー内の複数のActions間で状態を共有する
  • トークンの発行や失効に関する条件分岐ロジックを実行する
  • ユーザーコンテキストデータを把握する必要がある監査および分析パイプライン
Auth0のActionsとManagement APIを使用すると、リフレッシュトークンのライフサイクル全体を通じて、リフレッシュトークンのメタデータへのアクセスや変更を行えます。 詳細については、リフレッシュトークンのメタデータを設定するを参照してください。
リフレッシュトークンのメタデータは安全なデータストアではありません。シークレット、クレジットカード番号、社会保障番号、その他の高リスクPIIなどの機密情報の保存には使用しないでください。詳細については、Auth0 General Data Protection Regulation Complianceを参照してください。

​
サポートされているフロー

次の OAuth 2.0 フローでは、Post-Login Actions を使用してリフレッシュトークンのメタデータを設定できます。
  • Authorization Code Flow
  • Resource Owner Password Grant
  • Device Authorization Grant
  • Federated Connection Flows
  • Client-Initiated Backchannel Authentication (CIBA)
  • Native Passkeys
  • リフレッシュトークン交換
上記のサポート対象フローでは、どのフローでもリフレッシュトークンのメタデータを設定できます。ただし、既存のメタデータを 読み取れる のは、event.refresh_token が存在する リフレッシュトークン交換 の場合に、event.refresh_token.metadata オブジェクト経由のみです。初回ログイン時には event.refresh_token が存在しないため、メタデータは設定のみ可能で、読み取ることはできません。リフレッシュトークン交換時には、既存のメタデータを読み取ることも、新しい値を設定することもできます。
リフレッシュトークン交換の実行時、Actions で設定したメタデータが適用されるのは、MFA チャレンジなどの中間ステップではなく、リフレッシュトークンの発行時です。

​
制限事項

  • リフレッシュトークンのメタデータは最大25件までです
  • 各キーと値は255文字以内である必要があります
  • メタデータのキーには、英字、数字、アンダースコア、ハイフンのみ使用できます

​
詳細はこちら