メインコンテンツへスキップ
リフレッシュトークンのメタデータは現在、Enterpriseのお客様のみを対象とした早期アクセス機能です。この機能を使用すると、OktaのMaster Subscription Agreementに定められた該当するFree Trial条件に同意したものとみなされます。Auth0の製品リリースサイクルの詳細については、Product Release Stagesを参照してください。
リフレッシュトークンのメタデータを使用すると、Auth0のリフレッシュトークンに、カスタマイズ可能なキーと値 (各最大255文字) を保存できます。 リフレッシュトークンのメタデータのユースケースには、次のようなものがあります。
  • デバイス名やログイン場所などのデバイス情報を追跡する
  • たとえば user_accepted_termssession_type などのトークンレベルのフラグを保存する
  • 同じフロー内の複数のActions間で状態を共有する
  • トークンの発行または失効に条件付きロジックを適用する
  • ユーザーコンテキストデータを認識する必要がある監査および分析パイプラインで使用する
Auth0のActionsManagement APIを使用すると、リフレッシュトークンのライフサイクル全体を通じて、リフレッシュトークンのメタデータにアクセスして変更できます。 詳細については、Configure Refresh Token Metadataを参照してください。

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

次の OAuth 2.0 フローでは、Post-Login Actions を使用してリフレッシュトークンのメタデータを設定できます。
  • Authorization Code Flow
  • リソースオーナーパスワードグラント
  • デバイス認可グラント
  • フェデレーテッド接続フロー
  • クライアント起点バックチャネル認証 (CIBA)
  • ネイティブパスキー
  • リフレッシュトークン交換
上記のサポート対象フローでは、いずれもリフレッシュトークンのメタデータを設定できます。ただし、既存のメタデータを 読み取れる のは、event.refresh_token が存在する リフレッシュトークン交換 のシナリオで、event.refresh_token.metadata オブジェクトを介する場合に限られます。初回ログイン時には event.refresh_token は存在しないため、メタデータは設定のみ可能で、読み取ることはできません。リフレッシュトークン交換中は、既存のメタデータの読み取りと新しい値の設定の両方が可能です。
リフレッシュトークン交換の実行時に Actions で設定したメタデータが適用されるのは、MFA チャレンジなどの中間ステップではなく、リフレッシュトークンの発行時です。

制限事項

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

詳細情報