Skip to main content

Instrucciones para convertir de OAuth1 a OAuth2

A partir de la versión 22.1, eliminamos los puntos de conexión de la API de OAuth1 públicos heredados porque requieren hash SHA1 no compatible con FIPS. Esta eliminación incluye los puntos de conexión de WCF (Windows Communication Framework) heredados, Swagger para estos puntos de conexión heredados y middleware de OAuth1. Para reemplazar los puntos de conexión OAuth1, puedes utilizar las versiones de OAuth2 de las API heredadas publicadas en 21.4 que son compatibles con FIPS. Con las API de OAuth2, experimentarás la misma funcionalidad que con las API de OAuth1. La única excepción es que ahora la llamada GET/workflows/id/package devuelve un archivo en lugar de un objeto binario en la respuesta.

Los puntos de conexión de suscripción, V1 y V2 seguirán siendo compatibles con OAuth2.

Cómo convertir de OAuth1 a OAuth2

Actualizar tus scripts

  • Si actualmente utilizas la versión 21.4 y estás actualizando a 22.1 o a cualquiera de las versiones posteriores, puedes actualizar los scripts de API sin ningún tiempo de inactividad porque 21.4 tiene disponibles las API de OAuth1 y OAuth2. Te recomendamos que actualices tus scripts de la API de OAuth1 antes de realizar la actualización.

  • Si deseas actualizar a 22.1 desde una versión de Server que no sea 21.4, después de la actualización tendrás que actualizar los scripts a las API de OAuth2 para que funcionen.

  • Tienes que actualizar tus llamadas API de OAuth1 con el nuevo patrón OAuth2. Para ello, deberás actualizar dos aspectos de los scripts existentes:

    • Cambia la URL base de <hostname>/gallery/api/ a <hostname>/webapi/ .

    • Cambia el método de autorización de OAuth1 a OAuth2.

  • Si actualizas a la versión 22.1 e intentas ejecutar las API de OAuth1 sin actualizar los scripts de API, dichos scripts fallarán.

Esta actualización debe tardar aproximadamente 4 horas como máximo. Esta estimación solo aplica si estás siguiendo las prácticas recomendadas, tienes autenticación en un lugar y la URL base está definida en un único lugar. Si te autenticas en varios lugares y scripts, y utilizas direcciones URL completas y con codificación rígida en varios lugares y scripts, el proceso de actualización puede ser más tedioso. Para acelerar el proceso, puedes utilizar buscar y reemplazar .

Pruebas

Realiza una prueba rápida de humo para asegurarte de que las validaciones funcionan correctamente. Sin embargo, dado que no sabemos cómo utilizas las API, es imposible saber cuánto tardará la prueba.

Nota

Las diferencias entre las solicitudes y las respuestas para OAuth1 y OAuth2 son mínimas y se enumeran a continuación:

  • GET v1/jobs/{id}  ahora incluye nuevas líneas y espacios en blanco donde no lo hacía antes. Dependiendo de cómo proceses la respuesta, esto puede requerir ajustes en tus scripts.

  • GET v1/workflows/{id}/package devuelve un archivo en lugar de un blob JSON.

  • GET v1/jobs/{id}/output/{id} requiere un parámetro de formato en OAuth2. En Oauth1, este parámetro era opcional.

    Format parameter required for Oauth2 version.

Para obtener más información sobre la conversión y su impacto, ve a Instrucciones de conversión .