Skip to main content

Instructions de migration d'OAuth1 vers OAuth2

À partir de la version 22.1, nous avons supprimé nos points de terminaison d'API OAuth1 publics hérités car ils nécessitent un hachage SHA1 non conforme à la norme FIPS. Cette suppression inclut les points de terminaison WCF (Windows communication Framework) hérités, Swagger pour ces points de terminaison hérités et le middleware OAuth1. Pour remplacer les points de terminaison OAuth1, vous pouvez utiliser les versions OAuth2 des API héritées publiées dans la version 21.4, qui sont conformes à la norme FIPS. Vous obtiendrez la même fonctionnalité avec les API OAuth2 que celle disponible avec les API OAuth1. La seule exception concerne l'appel GET/workflows/id/package , qui renvoie désormais un fichier au lieu d'un objet binaire dans la réponse.

La souscription et les points de terminaison V1 et V2 continueront d'être pris en charge sous OAuth2.

Comment passer d'OAuth1 à OAuth2

Mettez à jour vos scripts

  • Si vous utilisez actuellement la version 21.4 et effectuez une mise à niveau vers la version 22.1 ou toute version ultérieure, vous pouvez mettre à jour les scripts d'API sans aucun temps d'arrêt, car la version 21.4 dispose des API OAuth1 et OAuth2. Nous vous recommandons de mettre à jour vos scripts d'API OAuth1 avant de procéder à la mise à niveau.

  • Si vous souhaitez effectuer une mise à niveau vers la version 22.1 à partir d'une version de Server autre que 21.4, après la mise à niveau, vous devrez mettre à jour vos scripts vers les API OAuth2 pour que vos scripts puissent être opérationnels.

  • Vous devez mettre à jour vos appels API OAuth1 avec le nouveau modèle OAuth2. Pour ce faire, vous devez modifier deux aspects des scripts existants :

    • Remplacez l' URL de base <hostname>/gallery/api/ par <hostname>/webapi/ .

    • Modifiez le type d'autorisation de OAuth1 à OAuth2.

  • Si vous effectuez une mise à niveau vers la version 22.1 et essayez d'exécuter les API OAuth1 sans mettre à jour vos scripts d'API, ces scripts échoueront.

Le temps de mise à jour est estimée à environ 4 heures au maximum. Cette estimation s'applique si vous suivez les meilleures pratiques, que vous disposez d'une authentification au même endroit, et que l'URL de base est définie à un seul emplacement. Si vous vous authentifiez à plusieurs endroits et dans plusieurs scripts et que vous utilisez des URL complètes et codées en dur à plusieurs emplacements et dans plusieurs scripts, le processus de mise à jour peut s'avérer plus fastidieux. Pour accélérer le processus, vous pouvez utiliser une fonction Rechercher et remplacer .

Test

Effectuez un test de fumée rapide pour vous assurer que les validations fonctionnent correctement. Cependant, comme nous ne connaissons pas votre mode d'utilisation d'API, il est impossible de prévoir la durée des tests.

Note

Les différences entre les demandes et les réponses pour OAuth1 et OAuth2 sont minimes et sont énumérées ci-dessous :

  • GET v1/jobs/{id} inclut désormais les nouvelles lignes et les espaces blancs, ce qui n'était pas le cas auparavant. Selon la façon dont vous traitez la réponse, cela peut nécessiter des ajustements de vos scripts.

  • GET v1/workflows/{id}/package renvoie un fichier au lieu d'un blob JSON.

  • GET v1/jobs/{id}/output/{id} nécessite un paramètre de format dans OAuth2. In Oauth1, this parameter was optional.

    Format parameter required for Oauth2 version.

Pour en savoir plus sur la migration et son impact, reportez-vous à la section Instructions de conversion .

Dans cette section​: