Définition de la méthode d'authentification pour les webhooks pré-message et post-message

Ce document présente le processus de configuration de l'authentification pour les webhooks pré-message et les webhooks post-message dans watsonx Assistant. Il présente les méthodes d'authentification disponibles et explique comment les configurer.

Présentation

Les webhooks permettent à des systèmes externes de communiquer avec watsonx Assistant. L'authentification garantit que seules les sources autorisées peuvent déclencher des webhooks. Cette documentation décrit le processus de configuration et de gestion de l'authentification des webhooks, qui introduit une nouvelle méthode d'authentification des webhooks.

Avant de commencer

Avant de configurer l'authentification du webhook :

  • Vous devez avoir des droits d'écriture dans l'environnement.
  • Vous devez disposer des détails d'authentification du serveur cible, y compris les URL de demande de jeton (si nécessaire) et tout secret, tel qu'un mot de passe ou un jeton.

Procédure

  1. Allez dans Accueil > Environnements.

  2. Sélectionnez l' icône de l'engrenage des paramètres à partir de l'onglet Draft > environnement Draft ou de l'onglet Live > environnement Live.

  3. Sélectionnez soit Pre-message webhook, soit Post-message webhook, en fonction de ce que vous souhaitez définir.

  4. Faites défiler la page jusqu'à l'option Webhook setup, et collez l'API URL.

  5. Cliquez sur Modifier l'authentification pour ouvrir la page Configuration de l'authentification.

  6. Dans la liste déroulante, choisissez l'une des options suivantes :

  7. Cliquez sur Sauvegarder.

Pas d'authentification

Il s'agit de l'option par défaut.

Authentification de base

  1. Entrez un nom d'utilisateur et un mot de passe.

Porteur auth

  1. Saisir le jeton du porteur.

Autorisation de la clé API

  1. Saisissez le nom et la clé de l'API.

JWT signé

  1. Entrez dans le secret.
  2. Cliquez sur l' icône Afficher le mot de passe pour afficher le secret.

OAuth 2.0

Si vous utilisez la chaîne Scope, il doit s'agir d'un ensemble délimité par des espaces d'une ou plusieurs portées d'authentification définies par le serveur cible. Par exemple, écrire, lire+écrire, lire le courrier électronique, etc.

  1. Dans Type de subvention, choisissez l'une des options suivantes :

  2. Cliquez sur Sauvegarder.

Mot de passe

  1. Saisissez le nom d'utilisateur de votre webhook.

  2. Saisissez le mot de passe de votre service webhook.

  3. Saisissez l'ID du client pour votre service d'authentification webhook.

  4. Saisissez le secret du client pour authentifier votre webhook.

  5. Saisissez le jeton URL.

  6. Saisissez le jeton d'actualisation URL.

  7. Facultatif : Si votre service a besoin d'une chaîne d'étendue, entrez la chaîne d'étendue telle qu'elle est définie par le serveur cible.

  8. Dans Authentification du client, vous devez choisir l'une des options suivantes :

    • Envoyer en tant qu'en-tête Basic Auth : Les informations d'authentification seront envoyées dans l'en-tête HTTP.
    • Send as Body : Les informations d'authentification seront envoyées dans le corps de la demande.

  9. Entrez le préfixe de l'en-tête, par exemple : Bearer.

Données d'identification du client

  1. Saisissez l'ID du client pour votre service d'authentification webhook.

  2. Saisissez le secret du client pour authentifier votre webhook.

  3. Saisissez le jeton URL.

  4. Saisissez le jeton d'actualisation URL.

  5. Facultatif : Si votre service a besoin d'une chaîne d'étendue, entrez la chaîne d'étendue telle qu'elle est définie par le serveur cible.

  6. Dans Authentification du client, vous devez choisir l'une des options suivantes :

    • Envoyer en tant qu'en-tête Basic Auth : Les informations d'authentification seront envoyées dans l'en-tête HTTP.
    • Send as Body : Les informations d'authentification seront envoyées dans le corps de la demande.

  7. Entrez le préfixe de l'en-tête, par exemple : Bearer.

Code d'autorisation

  1. Saisissez l'ID du client pour votre service d'authentification webhook.

  2. Entrez le serveur d'autorisation URL.

  3. Saisissez le jeton URL.

  4. Saisissez le jeton d'actualisation URL.

  5. Facultatif : Si votre service a besoin d'une chaîne d'étendue, entrez la chaîne d'étendue telle qu'elle est définie par le serveur cible.

  6. Dans Authentification du client, vous devez choisir l'une des options suivantes :

    • Envoyer en tant qu'en-tête Basic Auth : Les informations d'authentification seront envoyées dans l'en-tête HTTP.
    • Send as Body : Les informations d'authentification seront envoyées dans le corps de la demande.

  7. Entrez le préfixe de l'en-tête, par exemple : Bearer.

  8. Facultatif : En fonction du serveur cible, copiez l'url de redirection dans le champ "Callback URL " de votre application OAuth.

  9. Cliquez sur Accorder l'accès.

  10. Complétez les étapes de la page présentée par le serveur d'octroi.

  11. Vous êtes redirigé vers l'assistant et la fenêtre modale de modification s'ouvre à nouveau.

  12. Saisissez le secret du client sous l'ID du client maintenant que le champ est visible.

Custom

  1. Saisissez le nom du type de subvention personnalisé de votre webhook.

  2. Saisissez le jeton URL.

  3. Saisissez le jeton d'actualisation URL.

  4. Facultatif : Si votre service a besoin d'une chaîne d'étendue, entrez la chaîne d'étendue telle qu'elle est définie par le serveur cible.

  5. Dans Authentification du client, vous devez choisir l'une des options suivantes :

    • Envoyer en tant qu'en-tête Basic Auth : Les informations d'authentification seront envoyées dans l'en-tête HTTP.
    • Send as Body : Les informations d'authentification seront envoyées dans le corps de la demande.

  6. Entrez le préfixe de l'en-tête, par exemple : Bearer.

Si vous devez ajouter des secrets personnalisés à votre application, procédez comme suit :

  1. Cliquez sur Ajouter un secret +.

  2. Saisissez le nom et la valeur du secret.

  3. Facultatif : si vous souhaitez ajouter d'autres noms et valeurs secrets, cliquez sur Ajouter un secret +.

  4. Cliquez sur Ajouter un paramètre +.

  5. Saisissez le nom et la valeur du paramètre.

  6. Facultatif : si vous souhaitez ajouter d'autres noms et valeurs de paramètres, cliquez sur Ajouter un paramètre +.