Migrer vers les requêtes paginées des points de terminaison de Management API v2

Décrit comment utiliser les paramètres de pagination pour les requêtes de points de terminaison spécifiques de Management API v2.

Après le 26 janvier 2021 (ou la version 2202 de Private Cloud), les requêtes envoyées aux points de terminaison v2 de Management API renverront un maximum de 50 éléments pour les tenants du Public Cloud. Pour en récupérer davantage, vous devez inclure les paramètres page et per_page. À compter du 21 juillet 2020 (ou de la version 2108 de Private Cloud), Auth0 affichera les journaux du tenant ainsi qu’un commutateur de migration pour vous aider à vous préparer à ce changement.

Les tenants touchés sont ceux qui répondent aux critères suivants :

• Tenants Public Cloud créés avant le 21 juillet 2020 ou déploiements Private Cloud en version 2108
• Effectuent activement des appels aux points de terminaison touchés sans transmettre le paramètre per_page pour des requêtes pouvant renvoyer plus d’un résultat.

Les tenants suivants adopteront par défaut le nouveau comportement de pagination et continueront de fonctionner comme aujourd’hui après le 26 janvier 2021 :

• Tenants Public Cloud créés le 21 juillet 2020 ou après ou déploiements Private Cloud en version 2108 ou ultérieure
• N’utilisent aucun des points de terminaison touchés
• Utilisent les points de terminaison touchés et transmettent le paramètre per_page, ou effectuent des requêtes qui renverront toujours un seul résultat.

​

Points de terminaison concernés

Les appels aux points de terminaison suivants de la Management API v2 sont concernés :

• 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

Des avis de dépréciation seront consignés dans les journaux de votre tenant pour toutes les requêtes sans option de pagination qui renvoient actuellement plus d’un élément, à raison d’une fois par heure pour chaque combinaison distincte de client et de point de terminaison.

​

Actions

1. Remplacez tous les appels aux points de terminaison concernés en fournissant les paramètres page et per_page.

Paramètre	Type	Description
page	Entier	Indice de page des résultats à renvoyer. La première page est 0.
per_page	Entier	Nombre de résultats par page. La pagination est désactivée si le paramètre n’est pas envoyé.

2. Confirmez que vous ne voyez plus d’avis de dépréciation dans les journaux de votre tenant. Vérifiez si une requête a renvoyé plus de 50 éléments. Consultez le champ details.size_exceeded et vérifiez s’il est défini à true.

   1. Utilisez la requête de journal suivante pour renvoyer tous les appels sans options de pagination comportant plus d’un résultat : type:depnote AND description:*Unpaginated*
   2. Utilisez la requête de journal suivante pour renvoyer tous les appels sans options de pagination comportant plus de 50 résultats : type:depnote AND description:*Unpaginated* AND details.size_exceeded:true

   Pour identifier l’application qui effectue la requête, les journaux incluront le client_id utilisé pour l’effectuer. Vous pouvez aussi trouver le point de terminaison utilisé dans le champ details.path des journaux.

3. Désactivez les requêtes non paginées de la Management API pour votre tenant. Accédez à Dashboard > Tenant Settings > Advanced > Migration. Cela simulera le comportement attendu une fois la fenêtre de migration fermée, de sorte que les appels aux points de terminaison concernés renverront jusqu’à 50 résultats. Vous pourrez réactiver les requêtes non paginées à tout moment avant cette date.

​

Mettre à jour les extensions

Vous devrez peut-être mettre à jour les versions antérieures de Auth0 Extensions et des extensions personnalisées vers les versions les plus récentes afin de vous assurer qu’elles n’effectuent que des requêtes paginées.

1. Consultez les journaux de votre tenant pour repérer les avis de dépréciation concernant les clients dont l’ID correspond à une URL d’extension. Cela signifie que vous devrez mettre cette extension à jour.
2. Accédez à Dashboard > Extensions, sélectionnez Installed Extensions, puis cliquez sur le lien Update de l’extension, s’il est affiché.

​

Mettre à jour l’outil Deploy CLI

Si vous utilisez l’outil auth0-deploy-cli, vous devez passer à la version 5.3.0 ou plus récente. Pour en savoir plus, consultez l’outil Deploy CLI.