OAuth1 から OAuth2 への移行手順
22.1 リリース以降、当社は、FIPS に準拠していない SHA1 ハッシュを必要とするレガシーの公開 OAuth1 API エンドポイントを削除しました。この削除では、レガシーのWCF(Windows Communication Framework) エンドポイント、こうしたレガシーエンドポイントのSwagger、およびOAuth1ミドルウェアも対象になります。OAuth1 エンドポイントの代わりに、21.4 でリリースされたレガシー API の OAuth2 エンドポイント (FIPS 準拠) を使用できます。OAuth2 API では、OAuth1 API と同じ機能を利用できます。唯一の例外は、
GET/workflows/id/package
のコールにおいて、応答でバイナリオブジェクトではなく、ファイルが返されるようになったことです。
サブスクリプション、V1 および V2 エンドポイントは、今後も OAuth2 でサポートされる予定です。
OAuth1 から OAuth2 に移行する方法
スクリプトの更新
現在 21.4 を使用していて、22.1 以降のリリースにアップグレードする場合、21.4 では OAuth1 API と OAuth2 API を利用できるので、ダウンタイムなしで API スクリプトを更新できます。アップグレードする前に、OAuth1 API スクリプトを更新しておくことをお勧めします。
21.4 以外の Server から 22.1 にアップグレードする場合は、アップグレード後にスクリプトを OAuth2 API に更新する必要があります。その後、スクリプトは使用可能になります。
OAuth1 API 呼び出しを、新しい OAuth2 のパターンで更新します。そのためには、既存のスクリプトについて 2 点、更新が必要です。
ベース URL を
<hostname>/gallery/api/から<hostname>/webapi/に変更します。認証タイプ を OAuth1 から OAuth2 に変更します。
22.1 にアップグレードしてから、API スクリプトを更新しないで OAuth1 API を実行しようとすると、スクリプトは失敗します。
この更新には最大で 4 時間程度かかると推定されます。この推定が該当するのは、ベストプラクティスに従っており、認証やベース URL の定義を 1 か所で行っている場合です。複数の場所やスクリプトで認証を行っている、あるいは複数の場所やスクリプトで完全な URL やハードコード化された URL を使用している場合は、更新プロセスが長引く可能性があります。作業をスピードアップするには、 [検索置換] の使用をお勧めします。
テスト
簡便なスモークテストを実行して、検証が正しく機能することを確認します。ただし、API の使用方法はそれぞれ異なるので、テストにかかる時間をお伝えすることはできません。
注記
OAuth1とOAuth2の要求と応答の違いは最小限で、次のとおりです。
GET v1/jobs/{id}は以前は含まれなかった改行(newlines)と空白が含まれるようになりました。応答の処理方法によっては、スクリプトの調整が必要になる場合があります。GET v1/workflows/{id}/packageはJSON blobの代わりにファイルを返します。GET v1/jobs/{id}/output/{id}には、OAuth2形式でのパラメーターが必要です。Oauth1では、このパラメーターはオプションでした。
移行と、その影響の詳細については「 移行手順 」をご確認ください。