Skip to main content

Istruzioni per la conversione da OAuth1 a OAuth2

A partire dalla versione 22.1, abbiamo rimosso gli endpoint pubblici API OAuth1 legacy perché richiedono l'hash SHA1 non conforme a FIPS. La rimozione include gli endpoint WCF (Windows Communication Framework) legacy, lo Swagger per tali endpoint e il middleware OAuth1. Per sostituire gli endpoint OAuth1, è possibile utilizzare le versioni OAuth2 delle API legacy rilasciate nella versione 21.4 e conformi a FIPS. Le API OAuth2 offrono le stesse funzionalità delle API OAuth1. L'unica eccezione è che la chiamata GET/workflows/id/package ora restituisce nella risposta un file anziché un oggetto binario.

Gli endpoint Subscription, V1 e V2 continueranno a essere supportati in OAuth2.

Come eseguire la conversione da OAuth1 a OAuth2

Aggiornamento degli script

  • Se utilizzi la versione 21.4 e stai per eseguire l'aggiornamento alla versione 22.1 o successiva, puoi aggiornare gli script API senza tempi di inattività perché nella versione 21.4 sono disponibili le API OAuth1 e OAuth2. Ti consigliamo di aggiornare gli script API OAuth1 prima di eseguire l'upgrade.

  • Se desideri passare alla versione 22.1 da una versione Server diversa da 21.4, dopo aver eseguito l'operazione dovrai aggiornare gli script alle API OAuth2 per renderli operativi.

  • È necessario aggiornare le chiamate API OAuth1 con il nuovo modello OAuth2. A tale scopo, dovrai aggiornare 2 parametri degli script esistenti:

    • Modifica l' URL di base da <hostname>/gallery/api/ a <hostname>/webapi/ .

    • Modifica il tipo di autorizzazione da OAuth1 a OAuth2.

  • Se esegui l'aggiornamento alla versione 22.1 e tenti di eseguire le API OAuth1 senza aggiornare gli script, questi non verranno eseguiti.

Questo aggiornamento dovrebbe richiedere massimo 4 ore. Questa stima è valida se segui le best practice e hai eseguito l'autenticazione e definito l'URL di base in un'unica posizione. Se esegui l'autenticazione e utilizzi URL completi e hardcoded in più posizioni e script, il processo di aggiornamento potrebbe rallentare. Per velocizzarlo, puoi utilizzare un comando trova e sostituisci .

Test

Eseguire un rapido test del fumo per assicurarsi che le convalide funzionino correttamente. Tuttavia, poiché non sappiamo come utilizzi le API, è impossibile stabilire l'esatta durata dei test.

Nota

Le differenze tra le richieste e le risposte per OAuth1 e OAuth2 sono minime e sono elencate di seguito:

  • GET v1/jobs/{id} ora include i nuovi spazi e le nuove righe dove prima non lo erano. A seconda del modo in cui si elabora la risposta, potrebbe essere necessario apportare modifiche agli script.

  • GET v1/workflows/{id}/package restituisce un file invece di un blob JSON.

  • GET v1/Jobs/{id}/output/{id} richiede un parametro di formato in OAuth2. In Oauth1, questo parametro era facoltativo.

    Format parameter required for Oauth2 version.

Per ulteriori informazioni sulla conversione e sul suo impatto, consulta la sezione Istruzioni per la conversione .

In questa sezione: