Management API を使用したリフレッシュトークンの管理

Auth0 Management API を使用してリフレッシュトークンを管理する方法を説明します。

Auth0 Management API のリフレッシュトークン エンドポイントは現在、Enterprise プランのお客様のみが利用できます。詳しくは、Pricingを参照してください。

Management API エンドポイント

Auth0 の Management API には、リフレッシュトークンを個別またはコレクション単位で管理するためのエンドポイントがあります。

これらのエンドポイントは、拡張プロパティと一括失効操作を提供することで device-credentials リソースのエンドポイントに代わるものであり、その他のリフレッシュトークン失効方法 を補完します。

リフレッシュトークンリソース

特定のリフレッシュトークンを表示または失効させるには、次のエンドポイントを使用します。

名前	URL	必要なスコープ
IDでリフレッシュトークン情報を表示	GET /api/v2/refresh-tokens/{tokenId}	read:refresh_tokens
IDでリフレッシュトークンを失効	DELETE /api/v2/refresh-tokens/{tokenId}	delete:refresh_tokens

ユーザーリソース

次のエンドポイントを使用すると、指定したユーザーのすべてのリフレッシュトークンを一覧表示したり、失効させたりできます。

名前	URL	必要なスコープ
ユーザーのすべてのリフレッシュトークンを一覧表示する	GET /api/v2/users/{userId}/refresh-tokens	read:refresh_tokens
ユーザーのすべてのリフレッシュトークンを失効させる	DELETE /api/v2/users/{userId}/refresh-tokens	delete:refresh_tokens

リフレッシュトークンのプロパティ

リフレッシュトークンエンドポイントは、トークンとその履歴に関する関連情報を返します。

フィールド	説明
リフレッシュトークン ID	API におけるリフレッシュトークンの一意なテナント固有識別子です。トークンエンドポイントで交換に使用するシークレットであるトークン自体ではありません。 リフレッシュトークンはセッションより長く存続する場合があります。リフレッシュトークンには、セッションのライフサイクルにかかわらずこの情報が保持されます。
セッション ID	セッション ID は、Auth0 テナント内のセッションを表す永続的な識別子です。セッション ID は、IDトークンおよびログアウトトークンにすでに含まれている sid クレームに対応しており、これらを相互参照するために使用できます。 リフレッシュトークンには、トークンの作成時に使用されたセッションへの参照が含まれます。セッション ID を使用すると、Management API の ID による特定のセッションのイントロスペクト エンドポイントで追加情報を取得できます。
関連する時刻	リフレッシュトークンの作成時刻と有効期限に関する情報。
クライアントおよびリソースサーバーの情報	リフレッシュトークンに関連付けられたアプリケーションおよび API の概要情報。

制限事項

• リフレッシュトークンの失効 (DELETE) 操作は非同期で実行され、結果整合性となります。
• 2023-09-21 以降 (US-3 リージョンのテナントでは 2024-02-22 以降) に発行されたリフレッシュトークンには、適切な値を持つセッション ID (session_id) プロパティが含まれます。この日付より前に発行されたリフレッシュトークンでは、このプロパティの値は null です。

詳細情報

• リフレッシュトークン
• リフレッシュトークンの失効
• リフレッシュトークンの使用