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

2021年1月26日（またはプライベートクラウドのバージョン2202）の後、Management API v2エンドポイントへの要求は、パブリッククラウドのテナントに対して最大50個のアイテムを返します。より多くのアイテムを取得するには、pageおよびper_pageパラメーターを含める必要があります。2020年7月21日（またはプライベートクラウドのバージョン2108）から、 Auth0は、この変更に備えて、テナントログおよび移行トグルを表示します。

以下の基準に当てはまるテナントが影響を受けます。

• 2020年7月21日より前に作成されたパブリッククラウドテナントまたはバージョン2108で導入のプライベートクラウド。

• 複数の結果を返す可能性のあるクエリに対してper_pageパラメーターを渡すことなく、影響を受けるエンドポイントを積極的に呼び出す

以下のテナントは、デフォルトで新しいページネーション動作が有効になっており、2021年1月26日より後も現在と同じように動作します。

• 2020年7月21日以後に作成されたパブリッククラウドテナントまたはバージョン2108以降で導入のプライベートクラウド。

• 影響を受けるエンドポイントを使用していない。

• 影響を受けるエンドポイントを使用しており、かつ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

廃止通知は、異なるクライアントおよびエンドポイントについて、現在複数アイテムを返すページネーションオプションなしの要求すべてに対して、１時間に１回、テナントログに記録されます。

1. pageおよびper_pageパラメーターを提供して、影響を受けるエンドポイントへの呼び出しすべてを置き換えます。

   パラメーター	タイプ	説明
   page	整数	返される結果のページインデックス。最初のページは0になります。
   per_page	整数	1ページあたりの結果件数。このパラメーターが送信されない場合、ページ分割は無効になります。

2. テナントログに廃止通知が表示されないことを確認します。要求が50個より多くのアイテムを返しているかどうか確認します。details.size_exceededフィールドを見て、trueになっているか確認します。

   1. 以下のログクエリを使用して、複数の結果でページネーションオプションなしで呼び出しすべてを返します。 type:depnote AND description:*Unpaginated*

   2. 以下のログクエリを使用して、複数の結果でページネーションオプションなしで呼び出しすべてを返します。 type:depnote AND description:*Unpaginated* AND details.size_exceeded:true

   要求を行うアプリケーションを特定するために、要求を行うために使用されるclient_idがログに含まれます。また、ログのdetails.pathフィールドで使用されるエンドポイントを見つけることもできます。

3. テナントに対するManagement APIの非ページネーション要求を無効にする［Dashboard］>［Tenant Settings（テナント設定）］>［Advanced（詳細設定）］>［Migration（移行）］に移動します。これにより、移行ウィンドウが閉じた後に期待される動作をシミュレートして、影響を受けるエンドポイントを呼び出し、最大50個の結果を返します。その日までいつでも、非ページネーションの要求を最び有効化できます。

旧バージョンのAuth0拡張機能およびカスタムの拡張機能を、ページネーションクエリのみ実行するようにするために、最新バージョンに更新する必要があるかもしれません。

1. 拡張機能URLに一致するIDのクライアントについて、廃止通知があるかテナントログを確認してください。その場合、その拡張機能を更新する必要があります。

2. ［Dashboard］ > ［Extensions（拡張機能）］に移動し、［Installed Extensions（インストール済みの拡張機能）］を選択して、拡張機能の［Update（更新）］リンクがあれば、それをクリックしてください。

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