Management API v2 エンドポイントのページネーション付きクエリへの移行

特定の Management API v2 エンドポイントクエリでページネーションパラメーターを使用する方法について説明します。

2021年1月26日以降 (または Private Cloud バージョン 2202 以降) 、Management API v2 エンドポイントへのリクエストでは、Public Cloud のテナントに対して最大 50 件までしか項目が返されなくなります。さらに多くの項目を取得するには、page パラメーターと per_page パラメーターを指定する必要があります。2020年7月21日以降 (または Private Cloud バージョン 2108 以降) 、Auth0 はこの変更に備えられるよう、テナントログと移行トグルを表示します。

影響を受けるテナントは、次の条件を満たすものです。

• 2020年7月21日より前に作成された Public Cloud テナント、またはバージョン 2108 の Private Cloud デプロイメント
• 2 件以上の結果を返す可能性があるクエリで、per_page パラメーターを指定せずに、影響を受けるエンドポイントを継続的に呼び出していること。

次のテナントでは、新しいページネーション動作がデフォルトで適用され、2021年1月26日以降も現在と同様に動作し続けます。

• 2020年7月21日以降に作成された Public Cloud テナント、またはバージョン 2108 以降の Private Cloud デプロイメント
• 影響を受けるエンドポイントをいずれも使用していないこと
• 影響を受けるエンドポイントを使用する際に per_page パラメーターを指定している、または常に単一の結果のみを返すクエリを実行していること。

​

影響を受けるエンドポイント

以下の Management API v2 エンドポイントへの呼び出しが影響を受けます。

• GET /api/v2/clients
• GET /api/v2/client_grants
• GET /api/v2/grants
• GET /api/v2/connections
• GET /api/v2/device-credentials
• GET /api/v2/resource-servers
• GET /api/v2/rules

現在 2 件以上の項目を返している、ページネーション オプションを指定していないすべてのリクエストについては、クライアントとエンドポイントの組み合わせごとに 1 時間に 1 回、非推奨通知がテナントログに記録されます。

​

Actions

1. 影響を受けるエンドポイントへのすべての呼び出しで、page と per_page パラメーターを指定するようにします。

パラメーター	型	説明
page	Integer	返される結果のページインデックスです。最初のページは 0 です。
per_page	Integer	1 ページあたりの結果数です。このパラメーターを送信しない場合、ページネーションは無効になります。

2. テナントログに非推奨通知が表示されなくなったことを確認します。リクエストが 50 件を超える項目を返していないか確認してください。details.size_exceeded フィールドを確認し、値が true かどうかを確認します。

   1. 1 件を超える結果を返す、ページネーションオプションなしのすべての呼び出しを表示するには、次のログクエリを使用します。 type:depnote AND description:*Unpaginated*
   2. 50 件を超える結果を返す、ページネーションオプションなしのすべての呼び出しを表示するには、次のログクエリを使用します。 type:depnote AND description:*Unpaginated* AND details.size_exceeded:true

   リクエストを実行しているアプリケーションを特定するには、ログにそのリクエストで使用された client_id が含まれます。使用されているエンドポイントは、ログの details.path フィールドでも確認できます。

3. テナントの Management API に対するページネーションなしのリクエストを無効にします。Dashboard > Tenant Settings > Advanced > Migration に移動してください。これにより、移行期間の終了後に想定される動作がシミュレートされ、影響を受けるエンドポイントへの呼び出しは最大 50 件までの結果を返すようになります。その日付までは、いつでもページネーションなしのリクエストを再度有効にできます。

​

拡張機能を更新する

以前のバージョンの Auth0 Extensions やカスタム拡張機能を使用している場合は、それらがページネーションされたクエリのみを実行するよう、最新バージョンに更新する必要があることがあります。

1. テナントログで、ID が拡張機能の URL と一致するクライアントに関する非推奨のお知らせがないか確認します。見つかった場合は、その拡張機能を更新する必要があります。
2. Dashboard > Extensions に移動し、Installed Extensions を選択して、表示されていれば拡張機能の Update リンクをクリックします。

​

Deploy CLI ツールを更新する

auth0-deploy-cli ツールを使用している場合は、バージョン 5.3.0 以降 に更新する必要があります。詳しくは、Deploy CLI Tool を参照してください。