認証
認証は、エンドポイントの呼び出し元を確認するためのものです。[設定]→[開発者向け設定]→[Webhook]→[セキュリティ設定]→[認証]で、1つ以上の認証方法を有効にします。
ベーシック認証
HTTPベーシック認証を使用して、ユーザー名とパスワードでWebhookエンドポイントを保護できます。ベーシック認証を有効にし、エンドポイントでの検証に使用するユーザー名とパスワードを入力します。
メモ:認証情報はBase64でエンコードされ、すべてのWebhook要求のAuthorizationヘッダーで送信されます。
Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=
// ベーシック認証ヘッダーの生成方法:
credentials = 'username:password'
encoded = base64(credentials)
header = 'Basic ' + encoded
OAuth 2.0
OAuth 2.0を使用してWebhookを認証します。Zoho Signは、クライアント認証情報による付与方式でトークンURLからアクセストークンを取得し、すべてのWebhook要求のAuthorizationヘッダーでBearerトークンとして送信します。
- OAuth 2.0を有効にし、プロバイダーを選択します。
- トークンURL、クライアントID、クライアントシークレットを入力します。
- (任意)スコープを入力します。
- (任意)[追加パラメーター]で、トークン要求の本文にそのまま含めて送信する独自の名前と値の組み合わせ(例:audience)を追加します。さらに追加するには、[+]アイコンをクリックします。
メモ:OAuth 2.0とベーシック認証は同時に有効にできません。一方を有効にすると、もう一方は無効になります。
Authorizationヘッダーの例:
Authorization: Bearer <access_token>
// アクセストークンは、クライアントIDとクライアントシークレットを使用し、
// クライアント認証情報による付与方式でトークンURLから取得され、有効期限が切れるまでキャッシュされます。
相互TLS(mTLS)
相互TLS検証用のクライアント証明書を使用して、Webhookエンドポイントを認証できます。相互TLS(mTLS)を有効にし、次のいずれかの形式で証明書を指定します:
- クライアント証明書(.pem)と秘密鍵(.pem/.key)。鍵が暗号化されている場合は、鍵のパスワードも指定します。または、
- PFX/P12証明書ファイルと、その鍵のパスワード。
メモ:2つのクライアント証明書形式のうち、一度に有効にできるのは1つのみです。
認証の追加やルーティングのために、すべてのWebhook要求に独自のHTTPヘッダーを付加できます。
設定手順は次のとおりです:
- [カスタム要求ヘッダー]を有効にし、[ヘッダー名]と[ヘッダー値]を入力します。
- 別のヘッダーを追加するには、[+]アイコンをクリックします。カスタムヘッダーは最大5つまで追加できます。
整合性
整合性の設定では、ペイロードが正当なものであり、改ざんされていないことを確認します。[設定]→[開発者向け設定]→[Webhook]→[セキュリティ設定]→[整合性]で設定します。