BasicAuthとOAuth2
この記事では、BasicAuth、OAuth2(2-legged)、OAuth2(3-legged)認証、またはJWTを使用してWebhookコネクタを構成する方法について説明します。
BasicAuthの構成
このWebhookは、HTTPヘッダーフィールド Authorization を使用して基本的なHTTP認証をサポートしています。認証情報は {username}:{password}
のBase64エンコードされた文字列として渡されます。
BasicAuth Webhook構成のための以下の構成を使用してください:
構成 | 説明 |
---|---|
名前 | (必須) Webhookの説明的なタイトルを入力してください。 |
BasicAuth ユーザー名 | Webhookの認証用ユーザー名を入力してください。 |
BasicAuth パスワード | Webhookの認証用パスワードを入力してください。 |
次へをクリックするか、アクションタブに進んでください。アクションタブを使用してHTTPリクエストのトリガーを構成します。
OAuth2 (3-legged) の構成
WebhookのOAuth実装はサーバーサイドアプリケーションのみをサポートしています。
OAuth 2.0サービスにWebアプリケーションを登録することを忘れないでください。アプリケーションはリダイレクトURLを許可するように構成する必要があります:https://my.tealiumiq.com/oauth/webhook/callback.html
OAuth2 (3-legged) Webhook構成のための以下の構成を使用してください:
構成 | 説明 |
---|---|
名前 | (必須) Webhookの説明的なタイトルを入力してください。 |
クライアントID | (必須) OAuthサービスから割り当てられたアプリケーションのクライアント識別子を入力してください。 |
クライアントシークレット | (必須) OAuthサービスから割り当てられたアプリケーションのクライアントシークレットを入力してください。 |
スコープ | アプリケーションへのアクセス許可のタイプを選択してください。 |
認証URL | (必須) ユーザーを認証後にリダイレクトするURLを入力してください。 |
認証URLクエリパラメータ | 認証URLのための一つ以上の名前-値ペアを選択してください。複数のペアをアンパサンド (& ) で区切ってください。アンパサンド (& ) を先頭に使用しないでください。正しい例: access_type=offline&prompt=consent 誤った例: &access_type=offline&prompt=consent |
アクセストークンURL | (必須) リフレッシュトークンを取得するためのトークンURLを入力してください。 |
認証トークンの位置 | 認証トークンを配置する場所を指定してください。 |
認証ヘッダープレフィックス | デフォルト値は Bearer です。新しい値を指定して上書きする(一部のOAuth2サービスで必要)。 |
OAuth2 (2-legged) の構成
TealiumのWebhook OAuth2コネクタは、OAuth2 Two-Legged認証を必要とするAPIに完全にカスタマイズされたデータをHTTPリクエストとして送信することを可能にします。これはクライアント認証とリソースオーナーパスワード認証グラントをサポートしています。
コネクタを追加した後、OAuth2 2-Legged Webhook構成のための以下の構成を使用してください:
構成 | 説明 |
---|---|
名前 | (必須) Webhookの説明的なタイトルを入力してください。 |
アクセストークンURL | (必須) アクセストークンをリクエストするためのAPIエンドポイントURLを入力してください。 |
クライアントID | (必須) WebアプリケーションのクライアントIDを入力してください。 |
クライアントシークレット | (必須) Webアプリケーションのクライアントシークレットを入力してください。 |
ユーザー名 | ユーザー名を入力してください。パスワードグラントタイプを使用する場合は必須です。 |
パスワード | パスワードを入力してください。パスワードグラントタイプを使用する場合は必須です。 |
クライアント認証ID | 認証ヘッダーとして送信するクライアントID。 |
クライアント認証シークレット | 認証ヘッダーとして送信するクライアントシークレット。 |
スコープ | 要求する権限の範囲を選択してください(一部のOAuth2サービスで必要)。 |
追加の認証パラメータ | 追加の認証パラメータを追加してください(一部のOAuth2サービスで必要)。複数のパラメータを & で区切ってください。 |
認証URL | (必須) 認証コードをリクエストするためのAPIエンドポイントURL。 |
認証トークンの位置 | 認証トークンを配置する場所を指定してください。 |
認証ヘッダープレフィックス | デフォルト値は Bearer です。新しい値を指定して上書きする(一部のOAuth2サービスで必要)。 |
JWTの構成
このWebhookは、JSON Web Token(JWT)を使用した認証をサポートしています。
Webhook (JWT) 構成のための以下の構成を使用してください:
構成 | 説明 |
---|---|
名前 | (必須) Webhookの説明的なタイトルを入力してください。 |
JWTトークン | JSON Web Tokenを入力してください。 |
OAuth2のアクセストークン
Webhook OAuth2を使用するリクエストは、リクエストにアクセストークンを含める必要があります。OAuth2接続によって生成されたトークンは、コネクタによってテンプレート変数 {{webhook_access_token}}
として提供され、APIごとに異なる方法で渡されます。次の例では、Authorization: Bearer TOKEN_HERE
“Authorization” ヘッダーで期待されます。
このヘッダーを生成してマッピングするための以下の手順を使用してください:
- 次の例を使用して
auth_template
というテンプレートを作成します:
Bearer {{webhook_access_token}}
- ヘッダーセクションで、このテンプレートを Authorization にマッピングします。
- 保存をクリックします。
- 変更を保存して公開します。
すべてのWebhookアクションのアクションパラメータ
すべてのWebhookアクションに利用可能な以下のパラメータがあります。
パラメータ | 説明 |
---|---|
方法 | 必須* 次の方法をサポートします: * GET * POST * PUT * DELETE * PATCH |
URL* | (必須) リクエストを送信するURLを提供してください。 |
URLパラメータ* | Map ドロップダウンリストから値を送信したい属性を選択します。To フィールドにURLパラメータの名前を入力します。 |
ヘッダー* | Webhook (BasicAuth) ではオプション、Webhook OAuth2 では必須。Map ドロップダウンリストから値を送信したい属性を選択します。To フィールドにヘッダー名を入力します。 |
クッキー* | Map ドロップダウンリストから値を送信したい属性を選択します。To フィールドにクッキー名を入力します。 |
ボディコンテンツタイプ | Content-Type ヘッダーを指定します。すべてのタイプはUTF-8文字セットを使用します。GETメソッドの場合はこの構成を無視します。 |
ボディデータ* | HTTPリクエストを介してカスタマイズされたデータを送信 アクションのみサポートします。GETメソッドの場合はこの構成を無視します。ボディコンテンツタイプが application/x-www-form-urlencoded の場合は名前/値ペアを提供します。より複雑なペイロードの場合はテンプレート名を提供します。 |
バッチングオプション* | レコード数の最大値は10から10,000までです。有効期間は5分から60分までです。 |
テンプレート変数 | 詳細については、コネクターテンプレート変数を参照してください。 |
テンプレート | 詳細については、コネクタテンプレートについてを参照してください。各テンプレートには一意の名前が必要です。サポートされている任意のフィールドにテンプレートを注入するには、その名前を二重中括弧で囲んで参照します。テンプレートはURL、URLパラメータ、ヘッダー、クッキー、またはボディデータフィールドに注入できます。 |
バッチングオプション | レコード数の最大値は10から10,000までです。有効期間は5分から60分までです。 |
* テンプレートの名前を二重中括弧で囲んでフィールド値を入力することができます。たとえば、テンプレートが some-template
という名前の場合、その内容はフィールドに {{some-template}}
を参照することで注入できます。
最終更新日 :: 2025年September月11日