資格情報ローテーションの実装 (アドオンパートナー向け)
最終更新日 2024年02月06日(火)
Table of Contents
アドオンパートナーは、アドオンインスタンスに関連付けられた資格情報を、従来の v1 または現行の v3 の Partner Integration API を使用して自由にローテーションできます。
パートナーによっては、顧客が生成した資格情報のローテーション機能を SSO アドオンダッシュボードで実装しています。定期的に (たとえば、90 日ごとに) 資格情報をバックグラウンドで自動的にローテーションしているパートナーもあります。
アドオンサービスで使用する Partner Integration API のバージョンの特定
アドオンで使用している API のバージョンは、パートナーポータルの 「Settings」 (設定) -> 「Provisioning API」 (プロビジョニング API) で確認できます。
v1 Add-on Partner API の統合
従来の App Info API を使用して、アドオンインスタンスの環境設定を更新できます。
v3 Add-on Partner API の統合
パートナー向け Platform API を使用して環境設定を更新できます。v1 環境での運用を許可された一部のパートナーは、これらのエンドポイントを利用できる場合があります。それ以外の場所でプラットフォーム API を使用している場合は、従来の App Info API よりもこの方法が適しています。
注意事項
どちらの方法でも、次の場所で新しいリリース (および、それに続く dyno の再起動) が発生します。
- アドオンインスタンスを所有しているアプリ
- アドオンインスタンスにアタッチされたすべてのアプリ
これは通常、Heroku の顧客には透過的です。
リリースと dyno 再起動のプロセスが完了するまでの間、古い資格情報が機能するようにしてください。そうしないと、顧客が無効なキーを使用してサービスにリクエストを送信する可能性があります。Private Space 内の dyno は Common Runtime 内の dyno より再起動に時間がかかる可能性があるため、1 ～ 2 時間待ってから古い資格情報を削除するようにしてください。