Migración a consultas paginadas de endpoints de Management API v2

Describe cómo usar los parámetros de paginación para consultas en endpoints específicos de Management API v2.

Después del 26 de enero de 2021 (o de la versión 2202 de Private Cloud), las solicitudes a los endpoints de Management API v2 devolverán un máximo de 50 elementos en los inquilinos de Public Cloud. Para obtener más elementos, debe incluir los parámetros page y per_page. A partir del 21 de julio de 2020 (o de la versión 2108 de Private Cloud), Auth0 mostrará registros del inquilino y un interruptor de migración para ayudarle a prepararse para este cambio.

Los inquilinos afectados son aquellos que cumplen los siguientes criterios:

• Inquilinos de Public Cloud creados antes del 21 de julio de 2020 o implementaciones de Private Cloud con la versión 2108
• Realizan activamente llamadas a los endpoints afectados sin pasar el parámetro per_page en consultas que pueden devolver más de 1 resultado.

Los siguientes inquilinos adoptarán de forma predeterminada el nuevo comportamiento de paginación y seguirán funcionando como hasta ahora después del 26 de enero de 2021:

• Inquilinos de Public Cloud creados el 21 de julio de 2020 o después o implementaciones de Private Cloud con la versión 2108 o superior
• No usan ninguno de los endpoints afectados
• Usan los endpoints afectados y pasan el parámetro per_page, o realizan consultas que siempre devolverán un único resultado.

​

Endpoints afectados

Las llamadas a los siguientes endpoints de Management API v2 están afectadas:

• 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

Los avisos de deprecación se registrarán en los registros del inquilino para todas las solicitudes sin opciones de paginación que actualmente devuelven más de 1 elemento, una vez por hora, por cada cliente y endpoint diferentes.

​

Actions

1. Reemplace todas las llamadas a los endpoints afectados e incluya los parámetros page y per_page.

Parámetro	Tipo	Descripción
page	Entero	Índice de página de los resultados que se devolverán. La primera página es 0.
per_page	Entero	Número de resultados por página. La paginación se desactiva si no se envía el parámetro.

2. Confirme que ya no aparezcan avisos de deprecación en los registros del inquilino. Verifique si alguna solicitud devolvió más de 50 elementos. Revise el campo details.size_exceeded y compruebe si es true.

   1. Use la siguiente consulta de logs para devolver todas las llamadas sin opciones de paginación con más de 1 resultado: type:depnote AND description:*Unpaginated*
   2. Use la siguiente consulta de logs para devolver todas las llamadas sin opciones de paginación con más de 50 resultados: type:depnote AND description:*Unpaginated* AND details.size_exceeded:true

   Para identificar la aplicación que realiza la solicitud, los logs incluirán el client_id utilizado para realizarla. También puede encontrar el endpoint que se está usando en el campo details.path de los logs.

3. Deshabilite las solicitudes sin paginación de Management API para su inquilino. Vaya a Dashboard > Configuración del Tenant > Advanced > Migration. Esto simulará el comportamiento esperado una vez que se cierre la ventana de migración, por lo que las llamadas a los endpoints afectados devolverán hasta 50 resultados. Podrá volver a habilitar las solicitudes sin paginación en cualquier momento antes de esa fecha.

​

Actualizar extensiones

Es posible que debas actualizar Auth0 Extensions y las extensiones personalizadas desde versiones anteriores a las más recientes para asegurarte de que solo realicen consultas paginadas.

1. Revisa los registros del inquilino para ver avisos de deprecación de clientes con un ID que coincida con la URL de una extensión. Esto significa que tendrás que actualizar esa extensión.
2. Ve a Dashboard > Extensiones, selecciona Extensiones instaladas y haz clic en el enlace Actualizar de la extensión, si está disponible.

​

Actualice la herramienta Deploy CLI

Si utiliza la herramienta auth0-deploy-cli, debe actualizarla a la versión 5.3.0 o posterior. Para obtener más información, consulte Deploy CLI Tool.