プレメッセージとポストメッセージのウェブフックにおける認証方法の定義

この文書では、 watsonx Assistant で、プレメッセージ Webhook とポストメッセージ Webhook の認証を設定する手順を示します。 利用可能な認証方法とその設定方法について説明する。

概要

Webhook は、外部システムと watsonx Assistant との通信を可能にする。 認証は、許可されたソースのみがウェブフックをトリガーできることを保証する。 このドキュメントでは、Webhook 認証の設定と管理の手順について説明します。

開始前に

ウェブフック認証を設定する前に

  • 環境に書き込み権限が必要です。
  • トークン・リクエストURL（必要な場合）、パスワードやトークンなどのシークレットを含む、ターゲット・サーバーの認証詳細が必要です。

手順

  1. ホーム > 環境へ。

  2. ドラフトタブ＞ ドラフト環境、またはライブタブ＞ ライブ環境から、 設定 歯車アイコンを 選択します。

  3. 定義したい内容に応じて、 Pre-message webhook または Post-message webhookのいずれかを選択します。

  4. Webhook setupまでスクロールダウンし、API URL を貼り付ける。

  5. 認証の編集] をクリックして、 [認証の設定] ページを開きます。

  6. ドロップダウンで、以下のオプションのいずれかを選択します：

  7. 保存 をクリックします。

認証なし

これはデフォルト・オプションです。

ベーシック認証

  1. ユーザー名とパスワードを入力してください。

ベアラ認証

  1. ベアラートークンを入力します。

APIキー認証

  1. APIキー名と APIキーを入力します。

署名入りJWT

  1. シークレットに入る
  2. パスワードの表示 ] アイコ ンをクリックすると、秘密が表示されます。

OAuth 2.0

Scope文字列を使用する場合は、ターゲット・サーバで定義されている1つ以上の認証スコープを、スペースで区切って指定する必要がある。 例えば、write、read+write、email-readなど。

  1. Grant type（補助金の種類 ）で、以下のオプションのいずれかを選択する：

  2. 保存 をクリックします。

パスワード

  1. ウェブフックのユーザー名を入力してください。

  2. Webhookサービスのパスワードを入力します。

  3. Webhook認証サービスのクライアントIDを入力します。

  4. Webhookを認証するためのクライアントシークレットを入力します。

  5. トークン URL を入力します。

  6. Refresh トークン URL を入力してください。

  7. オプション： サービスにスコープ文字列が必要な場合は、ターゲットサーバーで定義されているスコープ文字列を入力します。

  8. クライアント認証では、以下のいずれかのオプションを選択する必要があります：

    • Basic Authヘッダーとして送信する： 認証情報は HTTP ヘッダーで送られる。
    • 本文として送信： 認証クレデンシャルはリクエストボディに送信されます。

  9. ヘッダーのプレフィックスを入力します：ベアラ

クライアント資格情報

  1. Webhook認証サービスのクライアントIDを入力します。

  2. Webhookを認証するためのクライアントシークレットを入力します。

  3. トークン URL を入力します。

  4. Refresh トークン URL を入力してください。

  5. オプション： サービスにスコープ文字列が必要な場合は、ターゲットサーバーで定義されているスコープ文字列を入力します。

  6. クライアント認証では、以下のいずれかのオプションを選択する必要があります：

    • Basic Authヘッダーとして送信する： 認証情報は HTTP ヘッダーで送られる。
    • 本文として送信： 認証クレデンシャルはリクエストボディに送信されます。

  7. ヘッダーのプレフィックスを入力します：ベアラ

許可コード

  1. Webhook認証サービスのクライアントIDを入力します。

  2. 認証サーバー URL を入力する。

  3. トークン URL を入力します。

  4. Refresh トークン URL を入力してください。

  5. オプション： サービスにスコープ文字列が必要な場合は、ターゲットサーバーで定義されているスコープ文字列を入力します。

  6. クライアント認証では、以下のいずれかのオプションを選択する必要があります：

    • Basic Authヘッダーとして送信する： 認証情報は HTTP ヘッダーで送られる。
    • 本文として送信： 認証クレデンシャルはリクエストボディに送信されます。

  7. ヘッダーのプレフィックスを入力します：ベアラ

  8. オプション： ターゲットサーバーによっては、リダイレクトURLをOAuthアプリの'Callback URL ' フィールドにコピーしてください。

  9. アクセスを許可 」をクリックします。

  10. 付与サーバーが提示するページのステップを完了します。

  11. アシスタントにリダイレクトされ、編集モーダルが再度開きます。

  12. クライアントIDの下にクライアントシークレットを入力します。

カスタム

  1. Webhookのカスタムグラントタイプ名を入力します。

  2. トークン URL を入力します。

  3. Refresh トークン URL を入力してください。

  4. オプション： サービスにスコープ文字列が必要な場合は、ターゲットサーバーで定義されているスコープ文字列を入力します。

  5. クライアント認証では、以下のいずれかのオプションを選択する必要があります：

    • Basic Authヘッダーとして送信する： 認証情報は HTTP ヘッダーで送られる。
    • 本文として送信： 認証クレデンシャルはリクエストボディに送信されます。

  6. ヘッダーのプレフィックスを入力します：ベアラ

アプリケーションにカスタムシークレットを追加する必要がある場合は、以下の手順に従ってください：

  1. 秘密の追加をクリックする。

  2. シークレット名と シークレット値を入力します。

  3. オプション： さらに秘密名と秘密値を追加したい場合は、「 Add secret +」をクリックします。

  4. Add parameter + をクリックする。

  5. パラメータ名と パラメータ値を入力する。

  6. オプション： さらにパラメータ名とパラメータ値を追加したい場合は、 Add parameter +をクリックします。