Definizione del metodo di autenticazione per i webhook pre-messaggio e post-messaggio

Questo documento mostra il processo di configurazione dell'autenticazione per i webhook pre-messaggio e post-messaggio in watsonx Assistant. Vengono illustrati i metodi di autenticazione disponibili e come configurarli.

Panoramica

I webhook consentono a sistemi esterni di comunicare con watsonx Assistant. L'autenticazione garantisce che solo le fonti autorizzate possano attivare i webhook. Questa documentazione descrive il processo di configurazione e gestione dell'autenticazione dei webhook, che introduce un metodo aggiornato per l'autenticazione dei webhook.

Prima di iniziare

Prima di configurare l'autenticazione webhook:

  • È necessario disporre dei permessi di scrittura nell'ambiente.
  • È necessario disporre dei dettagli di autenticazione del server di destinazione, compresi gli URL di richiesta del token (se necessario) ed eventuali segreti, come password o token.

Procedura

  1. Andate a Home > Ambienti.

  2. Selezionare l' icona dell'ingranaggio Impostazioni dalla scheda Bozza > Ambiente bozza o dalla scheda Vivi > Ambiente vivi.

  3. Scegliere tra webhook pre-messaggio o webhook post-messaggio, a seconda di ciò che si desidera definire.

  4. Scorrere fino a Webhook setup e incollare l'API URL.

  5. Fare clic su Modifica autenticazione per aprire la pagina di configurazione dell'autenticazione.

  6. Nel menu a tendina, scegliere una delle seguenti opzioni:

  7. Fare clic su Salva.

Nessuna autenticazione

Questa è l'opzione predefinita.

Auth di base

  1. Inserire un nome utente e una password.

Autenticazione del portatore

  1. Inserire il token portatore.

Autenticazione della chiave API

  1. Inserire il nome della chiave API e la chiave API.

Firmato JWT

  1. Entrare nel segreto.
  2. Fare clic sull'icona Visualizza password per visualizzare il segreto.

OAuth 2.0

Se si usa la stringa Scope, deve essere un insieme delimitato da spazi di uno o più ambiti di autenticazione definiti dal server di destinazione. Ad esempio, scrittura, lettura+scrittura, e-mail-lettura e così via.

  1. In Tipo di sovvenzione, scegliere una delle seguenti opzioni:

  2. Fare clic su Salva.

Password

  1. Inserire il nome utente del webhook.

  2. Inserire la password per il servizio webhook.

  3. Inserire l'ID cliente del servizio di autenticazione webhook.

  4. Inserire il Client secret per autenticare il webhook.

  5. Inserire il token URL.

  6. Immettere il token di aggiornamento URL.

  7. Facoltativo: se il servizio necessita di una stringa di ambito, inserire la stringa di ambito definita dal server di destinazione.

  8. In Autenticazione client, è necessario scegliere una delle seguenti opzioni:

    • Inviare come intestazione Basic Auth: Le credenziali di autenticazione saranno inviate nell'intestazione HTTP.
    • Invia come corpo: Le credenziali di autenticazione saranno inviate nel corpo della richiesta.

  9. Immettere il prefisso dell'intestazione, ad esempio: Bearer.

Credenziali client

  1. Inserire l'ID cliente del servizio di autenticazione webhook.

  2. Inserire il Client secret per autenticare il webhook.

  3. Inserire il token URL.

  4. Immettere il token di aggiornamento URL.

  5. Facoltativo: se il servizio necessita di una stringa di ambito, inserire la stringa di ambito definita dal server di destinazione.

  6. In Autenticazione client, è necessario scegliere una delle seguenti opzioni:

    • Inviare come intestazione Basic Auth: Le credenziali di autenticazione saranno inviate nell'intestazione HTTP.
    • Invia come corpo: Le credenziali di autenticazione saranno inviate nel corpo della richiesta.

  7. Immettere il prefisso dell'intestazione, ad esempio: Bearer.

Codice di autorizzazione

  1. Inserire l'ID cliente del servizio di autenticazione webhook.

  2. Inserire il server di autorizzazione URL.

  3. Inserire il token URL.

  4. Immettere il token di aggiornamento URL.

  5. Facoltativo: se il servizio necessita di una stringa di ambito, inserire la stringa di ambito definita dal server di destinazione.

  6. In Autenticazione client, è necessario scegliere una delle seguenti opzioni:

    • Inviare come intestazione Basic Auth: Le credenziali di autenticazione saranno inviate nell'intestazione HTTP.
    • Invia come corpo: Le credenziali di autenticazione saranno inviate nel corpo della richiesta.

  7. Immettere il prefisso dell'intestazione, ad esempio: Bearer.

  8. Facoltativo: A seconda del server di destinazione, copiare l'url di reindirizzamento nel campo "Callback URL " dell'applicazione OAuth.

  9. Fare clic su Concedi accesso.

  10. Completare i passaggi della pagina che viene presentata dal server di concessione.

  11. Si viene reindirizzati all'Assistente e si riapre la maschera di modifica.

  12. Inserire il segreto del cliente in ID cliente, ora che il campo è visibile.

Personalizzato

  1. Immettere il nome del tipo di grant personalizzato del webhook.

  2. Inserire il token URL.

  3. Immettere il token di aggiornamento URL.

  4. Facoltativo: se il servizio necessita di una stringa di ambito, inserire la stringa di ambito definita dal server di destinazione.

  5. In Autenticazione client, è necessario scegliere una delle seguenti opzioni:

    • Inviare come intestazione Basic Auth: Le credenziali di autenticazione saranno inviate nell'intestazione HTTP.
    • Invia come corpo: Le credenziali di autenticazione saranno inviate nel corpo della richiesta.

  6. Immettere il prefisso dell'intestazione, ad esempio: Bearer.

Se è necessario aggiungere segreti personalizzati all'applicazione, procedere come segue:

  1. Fare clic su Aggiungi segreto +.

  2. Digitare il Nome segreto e il Valore segreto.

  3. Facoltativo: se si desidera aggiungere altri nomi e valori segreti, fare clic su Aggiungi segreto +.

  4. Fare clic su Aggiungi parametro +.

  5. Digitare il nome del parametro e il valore del parametro.

  6. Facoltativo: se si desidera aggiungere altri nomi e valori di parametri, fare clic su Aggiungi parametro +.