Skip to main content

OAuth1 zu OAuth2 Anweisungen

Beginnend mit der Version 22.1 haben wir unsere öffentlichen Legacy-OAuth1-API-Endpunkte entfernt, da sie nicht FIPS-konformes SHA1-Hashing erfordern. Dies beinhaltet die Legacy-WCF-Endpunkte (Windows Communication Framework), Swagger für diese Legacy-Endpunkte und OAuth1-Middleware. Um die OAuth1-Endpunkte zu ersetzen, können Sie die OAuth2-Versionen der in 21.4 veröffentlichten Legacy-APIs verwenden, die FIPS-konform sind. Mit den OAuth2-APIs stehen Ihnen dieselben Funktionen zur Verfügung wie mit den OAuth1-APIs. Die einzige Ausnahme ist, dass der Aufruf GET/workflows/id/package jetzt eine Datei statt eines binären Objekts in der Antwort zurückgibt.

Abonnement-, V1- und V2-Endpunkte werden unter OAuth2 weiterhin unterstützt.

OAuth1 in Oauth2 konvertieren

Ihre Skripts aktualisieren

  • Wenn Sie derzeit mit 21.4 arbeiten und auf 22.1 oder eine der folgenden Versionen aktualisieren, können Sie die API-Skripts ohne Ausfallzeiten aktualisieren, da 21.4 die OAuth1- und OAuth2-APIs zur Verfügung stellt. Wir empfehlen Ihnen, Ihre OAuth1-API-Skripts vor dem Upgrade zu aktualisieren.

  • Wenn Sie eine Aktualisierung auf 22.1 von einer anderen Server-Version als 21.4 durchführen möchten, müssen Sie nach der Aktualisierung Ihre Skripts auf die OAuth2-APIs aktualisieren, bevor Ihre Skripts einsatzbereit sind.

  • Sie müssen Ihre OAuth1-API-Aufrufe mit dem neuen OAuth2-Muster aktualisieren. Dazu müssen Sie zwei Aspekte der vorhandenen Skripts aktualisieren:

    • Ändern Sie die Basis-URL von <hostname>/gallery/api/ in <hostname>/webapi/ .

    • Ändern Sie den Autorisierungstyp von OAuth1 in OAuth2.

  • Wenn Sie auf 22.1 aktualisieren und versuchen, OAuth 1-APIs auszuführen, ohne Ihre API-Skripts zu aktualisieren, werden diese Skripts fehlschlagen.

Diese Aktualisierung dauert schätzungsweise maximal etwa 4 Stunden. Diese Schätzung gilt, wenn Sie die empfohlenen Verfahrensweisen befolgen und die Authentifizierung an einem Ort haben und die Basis-URL an einem einzigen Ort definiert ist. Wenn Sie sich an mehreren Stellen und in mehreren Skripten authentifizieren und vollständige und fest codierte URLs an mehreren Stellen und in mehreren Skripten verwenden, kann der Aktualisierungsprozess langwieriger sein. Um den Vorgang zu beschleunigen, können Sie ein Suchen und Ersetzen -Fenster verwenden.

Testen

Führen Sie einen kurzen Smoke-Test (Rauchtest) durch, um sicherzustellen, dass die Validierungen ordnungsgemäß funktionieren. Da wir jedoch nicht wissen, wie Sie APIs verwenden, ist es in diesem Fall jedoch unmöglich die Dauer der Tests abzuschätzen.

Anmerkung

Die Unterschiede zwischen Anforderungen und Antworten für OAuth1 und OAuth2 sind minimal und sind folgend aufgeführt:

  • GET v1/jobs/{id} schließt jetzt auch Zeilenumbrüche und Leerzeichen ein, was zuvor nicht der Fall war. Je nachdem, wie Sie die Antwort verarbeiten, müssen Ihre Skripte möglicherweise angepasst werden.

  • GET v1/workflows/{id}/package gibt eine Datei anstelle eines JSON-Blobs zurück.

  • GET v1/jobs/{id}/output/{id} erfordert einen Formatparameter in OAuth2. In Oauth1 war dieser Parameter optional.

    Format parameter required for Oauth2 version.

Weitere Informationen über die Konvertierung und ihre Auswirkungen finden Sie unter Konvertierungsanweisungen .

In diesem Abschnitt: