BasicAuthとOAuth2
この記事では、BasicAuth、OAuth2(2-legged)、またはOAuth2(3-legged)認証を使用して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の構成には、以下の構成を使用します:
構成 | 説明 |
---|---|
クライアントID | 必須。OAuthサービスからアプリケーションに割り当てられたクライアント識別子を入力します。 |
クライアントシークレット | 必須。OAuthサービスからアプリケーションに割り当てられたクライアントシークレットを入力します。 |
スコープ | アプリケーションへのアクセスを要求する許可の種類を選択します。 |
認証URL | 必須。認証後にユーザーをリダイレクトしたいURLを入力します。 |
認証URLのクエリパラメータ | 認証URLの1つ以上の名前-値ペアを選択します。複数のペアはアンパサンド(& )で区切ります。最初にアンパサンド(& )を使用しないでください。 正しい: access_type=offline&prompt=consent 不正: &access_type=offline&prompt=consent |
アクセストークンURL | 必須。リフレッシュトークンを取得するためのトークンURLを入力します。 |
OAuth2(2-legged)の構成
TealiumのWebhook OAuth2コネクタを使用すると、OAuth2 Two-Legged認証が必要で、クライアント資格情報とリソース所有者のパスワード資格情報の付与をサポートするAPIに対して、完全にカスタマイズされたデータをHTTPリクエストとして送信できます。
コネクタを追加した後、OAuth2 2-Legged Webhookの構成には、以下の構成を使用します:
構成 | 説明 |
---|---|
アクセストークンURL | 必須。アクセストークンをリクエストするためのAPIエンドポイントURLを入力します。 |
クライアントID | 必須。WebアプリケーションのクライアントIDを入力します。 |
クライアントシークレット | 必須。Webアプリケーションのクライアントシークレットを入力します。 |
ユーザー名 | ユーザー名を入力します。パスワード付与タイプを使用する場合は、ユーザー名が必要です。 |
パスワード | パスワードを入力します。パスワード付与タイプを使用する場合は、パスワードが必要です。 |
スコープ | 要求する権限の範囲を選択します(一部のOAuth2サービスのみが必要)。 |
追加の認証パラメータ | 追加の認証パラメータを追加します(一部のOAuth2サービスのみが必要)。複数のパラメータは& で区切ります。 |
認証トークンの位置 | 認証トークンを配置する場所を指定します。 |
認証ヘッダープレフィックス | デフォルト値はBearer です。新しい値を指定して上書きします(一部のOAuth2サービスのみが必要)。 |
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パラメータ* | マップドロップダウンリストから、送信したい値の属性を選択します。Toフィールドに、構成するURLパラメータの名前を入力します。 |
ヘッダー* | Webhook(BasicAuth)の場合はオプション、Webhook OAuth2の場合は必須。マップドロップダウンリストから、送信したい値の属性を選択します。Toフィールドに、値を受け取るヘッダーのヘッダー名を入力します。 |
クッキー* | マップドロップダウンリストから、送信したい値の属性を選択します。Toフィールドに、値を受け取るクッキーのクッキー名を入力します。 |
ボディコンテンツタイプ | Content-Type ヘッダーを指定します。すべてのタイプはUTF-8文字セットを使用します。GETメソッドの場合は、この構成を無視します。 |
ボディデータ* | HTTPリクエストを介してカスタマイズされたデータを送信アクションのみがサポートされます。GETメソッドの場合は、この構成を無視します。ボディコンテンツタイプがapplication/x-www-form-urlencoded の場合は、名前/値のペアを提供します。より複雑なペイロードの場合は、テンプレート名を提供します。 |
バッチングオプション* | レコード数の最大値は、10から10,000の間です。生存時間は、5から60分の間です。 |
テンプレート変数 | 詳細については、Template Variables Guideを参照してください。 |
テンプレート | 詳細については、Trimou Templates Guideを参照してください。各テンプレートには一意の名前が必要です。その名前を二重中括弧で囲んで参照することで、テンプレートを任意のサポートフィールドに注入できます。テンプレートはURL、URLパラメータ、ヘッダー、クッキー、またはボディデータフィールドに注入できます。 |
バッチングオプション | レコード数の最大値は、10から10,000の間です。生存時間は、5から60分の間です。 |
* カスタムテンプレートのフィールド値を入力することができます。その名前を二重中括弧で囲んで参照します。例えば、テンプレートがsome-template
という名前の場合、レンダリングされたコンテンツは{{some-template}}
を参照することでフィールドに注入できます。
最終更新日 :: 2022年June月23日