Management API を使用してリフレッシュトークンを管理する

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

Auth0 Management API のリフレッシュトークンエンドポイントは現在、Enterprise プランのお客様のみご利用いただけます。詳しくは、料金をご覧ください。

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

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

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

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

制限事項

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

詳しく見る

• リフレッシュトークン
• リフレッシュトークンを取り消す
• リフレッシュトークンを使用する