Utilisez ce composant pour obtenir un jeton d'accès OAuth2 de type d'octroi Informations d'identification client. En d'autres termes, vous l'utilisez pour obtenir un jeton d'accès basé sur les informations d'identification du client, mais pas sur son nom ni sur son mot de passe. Vous pouvez utiliser ce composant pour obtenir un jeton qui permet d'accéder aux ressources client protégées par Oracle Identity Cloud Service ou Oracle Access Manager (OAM).

Si vous devez accéder aux ressources pour le compte d'un utilisateur, reportez-vous à System.OAuth2AccountLink et à System.OAuthAccountLink.

Pour pouvoir utiliser ce composant dans une brique, vous devez effectuer les tâches suivantes :

1. S'il n'est pas déjà inscrit, inscrivez le client auprès du fournisseur d'identités, comme décrit dans Inscription de fournisseur d'identités.
2. Ajoutez un service d'authentification d'informations d'identification client pour le fournisseur d'identités, comme décrit dans Services d'authentification.

Ce composant n'a aucune action. Pour gérer les problèmes système susceptibles de se produire, ajoutez une transition "next" qui passe à un état permettant de gérer ces erreurs.

Voici un exemple d'état utilisant ce composant :

  getAccessToken:
    component: "System.OAuth2Client"
    properties:
      authenticationService: "myAuthenticationService"
      accessTokenVariableName: "myAuthServiceToken"
    transitions:
      next: "next"
      error: "error" # handle auth service issues

Utilisez ce composant afin d'obtenir un jeton d'accès utilisateur OAuth2 (de type d'octroi Code d'autorisation) pour les ressources sécurisées par OCI IAM, Oracle Access Manager (OAM), la plate-forme d'identité Microsoft ou l'autorisation Google OAuth 2.0. Ce composant effectue toutes les étapes pour le flux OAuth2 à 3 acteurs et renvoie le jeton d'accès OAuth2.

Vous pouvez utiliser le paramètre requiresAuthorization afin d'indiquer les états nécessitant une autorisation pour être appelés. Pour les états nécessitant une autorisation, si l'utilisateur n'en dispose pas encore, l'état System.OAuth2AccountLink est appelé, puis le flux appelle l'état nécessitant une autorisation. Pour découvrir comment utiliser cette fonctionnalité, reportez-vous à Autorisation utilisateur dans les discussions de groupe (fonctionne pour tous les types de discussion, pas uniquement pour les discussions de groupe).

Si vous devez obtenir un jeton d'accès de type Informations d'identification client pour accéder aux ressources client, reportez-vous à System.OAuth2Client.

Pour pouvoir utiliser ce composant dans une brique, vous devez effectuer les tâches suivantes :

1. S'il n'a pas déjà été inscrit, inscrivez le client auprès du fournisseur d'identités, comme décrit dans Inscription de fournisseur d'identités.
2. Ajoutez un service d'authentification pour le fournisseur d'identités, comme décrit dans Services d'authentification.

Certains fournisseurs d'identités émettent des jetons d'actualisation. Lorsque vous utilisez ce composant, Digital Assistant stocke le jeton d'actualisation pendant la durée de conservation spécifiée pour le service d'authentification. Le back-end Digital Assistant peut utiliser le jeton d'actualisation, s'il est disponible, pour obtenir un nouveau jeton d'accès sans nécessiter de nouvelle connexion de la part de l'utilisateur.

Conseil :

Dans les briques avec les versions 21.04 et ultérieures de la plate-forme, les valeurs par défaut des propriétés cancelLabel, linkLabel et prompt sont stockées dans le groupe de ressources de la brique. Pour modifier une valeur par défaut, ouvrez la page Groupe de ressources de la brique, cliquez sur , sélectionnez l'onglet Configuration et modifiez le message de la clé OAuth2AccountLink - <nom de propriété>. Si vous utilisez le groupe de ressources de la brique pour modifier la valeur par défaut, vous n'avez pas besoin d'inclure la propriété dans le composant, sauf si vous voulez remplacer la valeur par défaut.

Vous pouvez également modifier les messages Autre - oauthCancelPrompt et Autre - oauthSuccessPrompt dans le groupe de configuration.

${(system.message.channelConversation.channelType=='twilio')?then('true','false')}

${(system.message.channelConversation.channelType=='twilio')?then('false','true')}

Ce composant peut renvoyer les actions suivantes :

Lorsque le moteur de dialogue rencontre le composant, le bot de brique propose deux liens à l'utilisateur : Obtenir un jeton d'accès et Annuler (vous pouvez utiliser linkLabel et cancelLabel pour modifier le texte du lien).

Si l'utilisateur clique sur le lien permettant d'obtenir un jeton d'accès, cela affiche la page de connexion ou la boîte de dialogue d'authentification du fournisseur d'identités, telle que définie par le service d'authentification. Une fois la connexion établie, il obtient le jeton d'accès, définit les valeurs des variables identifiées par accessTokenVariableName et authenticatedUserVariableName, puis passe à l'état nommé par l'action pass (ou à l'état suivant si l'action pass n'existe pas). Si l'utilisateur annule, l'action de postback est définie sur fail. Si l'utilisateur saisit du texte, il renvoie l'action textReceived.

Comme indiqué précédemment, vous pouvez définir requiresAuthorization pour un état afin de vous assurer que l'utilisateur dispose des autorisations nécessaires avant d'appeler le composant de l'état. Si l'utilisateur ne dispose pas encore des autorisations, la boîte de dialogue appelle l'action system.authorizeUser dans defaultTransitions. Voici un exemple :

main: true
name: RequiresAuthorizationExample
context:
  variables:
    iResult: "nlpresult"

defaultTransitions:
  actions:
    system.authorizeUser: "login"

states:
  intent:
    component: "System.Intent"
    properties:
      variable: "iResult"
    transitions:
      actions:
        reg.general.showPasscode: "showPasscode"
        reg.general.showPhoneNumber: "showPhoneNumber"
        unresolvedIntent: "handleUnresolved"        

  showPasscode:
    component: "System.Output"
    requiresAuthorization: true
    properties:
      text: "XYZABC123"
    transitions:
      return: "done"          
       
  showPhoneNumber:
    component: "System.Output"
    requiresAuthorization: false
    properties:
      text: "555-1212"
    transitions:
      return: "done"
       
  handleUnresolved:
    component: "System.Output"
    requiresAuthorization: false
    properties:
      text: "You can ask for my phone number or ask for the passcode."
    transitions:
      return: "done"
         
  login:
    component: "System.OAuth2AccountLink"
    properties:
      prompt: "${profile.firstName}, please login"
      authenticationService: "MyAuthenticationService"
      accessTokenVariableName: "user.accessToken"
      authenticatedUserVariableName: "user.authenticatedUserId"
    transitions:
      actions:
        pass : "${system.requestedState}"
        fail : "handleFailedLogin"
        textReceived: "intent"       

  handleFailedLogin:
    component: "System.Output"
    requiresAuthorization: false
    properties:
      text: "Sorry, you aren't authorized to do that"
    transitions:
      return: "done"     

Utilisez ce composant pour révoquer tous les jetons d'actualisation et d'accès de l'utilisateur connecté du fournisseur d'identités représenté par le service d'authentification. Il enlève également les jetons d'actualisation de la base de données. Pour utiliser ce composant, vous devez fournir l'URL de révocation de jeton d'actualisation du fournisseur d'identités dans l'interface utilisateur du service d'authentification.

La brique doit inclure un état qui utilise le composant OAuth2AccountLink pour le même service d'authentification, et doit être appelée avant l'état qui utilise le composant System.OAuth2ResetTokens.

Ce composant peut renvoyer l'action suivante :

Utilisez ce composant pour obtenir le code d'autorisation des services sécurisés par le flux d'octroi de code d'autorisation, comme LinkedIn, Twitter, Google ou Microsoft. Les composants personnalisés de la brique peuvent échanger le code d'autorisation avec un jeton d'accès, qui sera ensuite utilisé pour appeler le service de fin.

Le composant dirige d'abord l'utilisateur vers la page de connexion du fournisseur d'identités. Une fois la connexion établie, le composant renvoie le code d'autorisation dans une variable, que vous utilisez pour transmettre le code d'autorisation au composant personnalisé. L'API du composant personnalisé doit échanger le code d'autorisation, l'ID client et la clé secrète du client avec un jeton d'accès utilisateur OAuth2.

Vous pouvez utiliser le paramètre requiresAuthorization afin d'indiquer les états nécessitant une autorisation pour être appelés. Pour les états nécessitant une autorisation, si l'utilisateur n'en dispose pas encore, l'état System.OAuthAccountLink est appelé, puis le flux appelle l'état nécessitant une autorisation. Pour découvrir comment utiliser cette fonctionnalité, reportez-vous à Autorisation utilisateur dans les discussions de groupe (fonctionne pour tous les types de discussion, pas uniquement pour les discussions de groupe).

Conseil :

Dans les briques avec les versions 21.04 et ultérieures de la plate-forme, les valeurs par défaut des propriétés cancelLabel, linkLabel et prompt sont stockées dans le groupe de ressources de la brique. Pour modifier une valeur par défaut, ouvrez la page Groupe de ressources de la brique, cliquez sur , sélectionnez l'onglet Configuration et modifiez le message de la clé OAuthAccountLink - <nom de propriété>. Si vous utilisez le groupe de ressources de la brique pour modifier la valeur par défaut, vous n'avez pas besoin d'inclure la propriété dans le composant, sauf si vous voulez remplacer la valeur par défaut.

Vous pouvez également modifier les messages Autre - oauthCancelPrompt et Autre - oauthSuccessPrompt dans le groupe de configuration.

${(system.message.channelConversation.channelType=='twilio')?then('true','false')}

${(system.message.channelConversation.channelType=='twilio')?then('false','true')}

Ce composant peut renvoyer les actions suivantes :

Cet exemple présente les propriétés requises que vous devez définir pour le composant System.OAuthAccountLink : prompt, qui spécifie le message de connexion, variable, qui indique au composant où stocker le code d'autorisation et authorizeURL qui définit l'URL OAuth du fournisseur et l'URL de réacheminement qui reçoit le code d'autorisation.

login:
  component: "System.OAuthAccountLink"
  properties:
    prompt: "Please login now."
    linkLabel: "login"
    cancelLabel: "cancel"
    authorizeURL: "https://www.linkedin.com/oauth/v2/authorization?response_type=code&client_id=75k0vq4&scope=r_basicprofile&redirect_uri=https%3A%2F%2FmyBotsinstance%2Fconnectors%2Fv2%2Fcallback"
    variable: "authCode"
  transitions:
      next: getBankUserProfile
      actions:
        textReceived: handleAuthTextResponse
        fail: authCancelled

Lorsque le moteur de dialogue rencontre ce composant, le bot de brique invite l'utilisateur à interagir avec deux liens : Connexion et Annuler.

Description de l'image fb-oauth.png

Il existe plusieurs façons d'effectuer une transition à partir de ce composant :

• L'utilisateur clique sur le bouton d'annulation et le composant passe à l'état nommé par l'action fail.

• L'utilisateur ne clique sur aucun bouton, mais saisit du texte à la place. Le composant passe à l'état nommé par l'action textReceived.

• L'utilisateur clique sur le lien de connexion et le canal affiche la page de connexion du fournisseur d'identités ou sa boîte de dialogue d'authentification sous forme de vue Web, comme illustré dans l'exemple ci-dessous. Après l'autorisation, le composant passe à l'état nommé par l'action pass (ou à l'état suivant s'il n'existe pas d'action pass), qui appelle généralement un composant personnalisé qui échange le code d'autorisation avec un jeton d'accès.

Description de l'image webview-login.png

Si la fenêtre de test n'affiche pas la vue Web, coupez et collez le texte du lien dans votre navigateur.