Webhook署名のローテーション

ガイドWebhookWebhookの処理Webhook署名のローテーション

Webhook署名のローテーション

アプリケーションのWebhook署名キーを一度に1つ更新することにより、競合することなくキーをローテーションできます。

設定時、Boxは常にすべてのWebhookペイロードで2つの署名を送信します。少なくとも1つの署名が有効であれば、アプリケーションはペイロードを信頼できます。

一度に1つの署名キーを更新すると、アプリケーションは常に少なくとも1つの有効な署名を持つペイロードを受信することになります。

循環の手順

これらの手順は、これまでにプライマリキーとセカンダリキーを作成済みで、どちらかのキーを置き換える準備ができていることを前提としています。

これらの手順に従うことにより、競合することなく、2つの新しいキーを使ってアプリケーションを構成できます。

  1. プライマリキーをアプリケーションの開発者コンソールで変更します。アプリケーション設定画面の[Webhook]セクションに移動し、プライマリキーの[リセット]ボタンをクリックします。
  2. 新しいプライマリキーでアプリケーションを更新します。アプリケーションは引き続き古いプライマリキーで通知を受信する可能性がありますが、セカンダリキーがまだ有効であるため、Webhookは今後も正しく処理されます。
  3. 古いプライマリキーを持つWebhookが動作していないことを確認できたら、同じプロセスを使用してセカンダリキーを更新できます。