- デバイス名やログイン場所などのデバイス情報を追跡する
- たとえば
user_accepted_termsやsession_typeなどのトークンレベルのフラグを保存する - 同じフロー内の複数のActions間で状態を共有する
- トークンの発行または失効に条件付きロジックを適用する
- ユーザーコンテキストデータを認識する必要がある監査および分析パイプラインで使用する
サポートされているフロー
- Authorization Code Flow
- リソースオーナーパスワードグラント
- デバイス認可グラント
- フェデレーテッド接続フロー
- クライアント起点バックチャネル認証 (CIBA)
- ネイティブパスキー
- リフレッシュトークン交換
上記のサポート対象フローでは、いずれもリフレッシュトークンのメタデータを設定できます。ただし、既存のメタデータを 読み取れる のは、
event.refresh_token が存在する リフレッシュトークン交換 のシナリオで、event.refresh_token.metadata オブジェクトを介する場合に限られます。初回ログイン時には event.refresh_token は存在しないため、メタデータは設定のみ可能で、読み取ることはできません。リフレッシュトークン交換中は、既存のメタデータの読み取りと新しい値の設定の両方が可能です。制限事項
- リフレッシュトークンのメタデータは最大 25 件までです
- 各キーと値は 255 文字以下である必要があります
- メタデータのキーに使用できるのは、英字、数字、アンダースコア、ハイフンのみです