Utilisez ce composant pour obtenir un jeton d'accès OAuth2 avec le type d'autorisation Données d'identification de client. Autrement dit, vous l'utilisez pour obtenir un jeton d'accès basé sur les données d'identification du client et non sur le nom et le mot de passe de l'utilisateur. Vous pouvez utiliser ce composant pour obtenir un jeton qui permet l'accès aux ressources de client protégées par le service Oracle Identity Cloud ou Oracle Access Manager (OAM).

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

Afin de pouvoir utiliser ce composant dans une compétence, vous devez effectuer les tâches suivantes :

1. Si ce n'est pas encore fait, inscrivez le client auprès du fournisseur d'identités comme décrit dans la rubrique Enregistrement au niveau du fournisseur d'identités.
2. Ajoutez un service d'authentification client pour le fournisseur d'identités, comme décrit dans la rubrique Services d'authentification.

Ce composant ne comporte aucune action. Pour gérer les problèmes système qui peuvent survenir, ajoutez une transition next qui passe à un état pouvant traiter de telles 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 pour obtenir un jeton d'accès d'utilisateur OAuth2 (type d'autorisation Code) 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 termine toutes les étapes du flux OAuth2 à trois branches et retourne le jeton d'accès OAuth2.

Vous pouvez utiliser le paramètre requiresAuthorization pour indiquer les états exigeant une autorisation avant d'être appelés. Pour les états qui nécessitent une autorisation, si l'utilisateur n'en dispose pas encore, l'état System.OAuth2AccountLink est appelé, puis le flux appelle l'état qui exigeait l'autorisation. Vous pouvez voir comment utiliser cette fonctionnalité dans Autorisation d'utilisateur dans les clavardages en groupe (elle sert à tous les types de clavardage, pas seulement à ceux en groupe).

Si vous devez obtenir un jeton d'accès avec le type d'autorisation Données d'identification client pour accéder aux ressources de client, voir System.OAuth2Client.

Afin de pouvoir utiliser ce composant dans une compétence, vous devez effectuer les tâches suivantes :

1. Si ce n'est pas encore fait, inscrivez le client auprès du fournisseur d'identités comme décrit dans la rubrique Enregistrement au niveau du 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 période de conservation spécifiée pour le service d'authentification. Le système dorsal de l'assistant numérique peut utiliser le jeton d'actualisation, s'il est disponible, pour obtenir un nouveau jeton d'accès sans que l'utilisateur ait à se connecter de nouveau.

Conseil :

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

Vous pouvez également modifier les messages Other - oauthCancelPrompt et Other - oauthSuccessPrompt dans l'ensemble de configuration.

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

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

Ce composant peut retourner les actions suivantes :

Lorsque le moteur de dialogue rencontre le composant, le robot de compétence 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 pour obtenir un jeton d'accès, le moteur affiche la page de connexion ou la boîte de dialogue d'authentification du fournisseur d'identités comme indiqué par le service d'authentification. Une fois la connexion réussie, il obtient le jeton d'accès, définit les variables identifiées par accessTokenVariableName et authenticatedUserVariableName, puis passe à l'état qui est nommé par l'action pass (ou à l'état suivant en l'absence d'action pass). Si l'utilisateur annule, l'action de republication est réglée à fail. Si l'utilisateur entre du texte, l'action textReceived est retournée.

Comme mentionné précédemment, vous pouvez définir requiresAuthorization pour un état afin de garantir que l'utilisateur dispose de l'autorisation nécessaire avant d'appeler le composant de l'état. Si l'utilisateur n'est pas encore autorisé, 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é provenant du fournisseur d'identités que représente le service d'authentification. Il supprime également les jetons d'actualisation de la base de données. Pour l'utiliser, vous devez fournir l'URL de révocation du jeton d'actualisation du fournisseur d'identités dans l'interface utilisateur du service d'authentification.

La compétence doit inclure un état qui utilise le composant OAuth2AccountLink pour le même service d'authentification et ce dernier doit être appelé avant l'état qui utilise le composant System.OAuth2ResetTokens.

Ce composant peut retourner l'action suivante :

Utilisez ce composant pour obtenir le code d'autorisation pour les services sécurisés par un code d'autorisation, par exemple LinkedIn, Twitter, Google ou Microsoft. Les composants personnalisés de la compétence peuvent échanger le code d'autorisation contre un jeton d'accès qu'ils utilisent ensuite pour appeler le service final.

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

Vous pouvez utiliser le paramètre requiresAuthorization pour indiquer les états exigeant une autorisation avant d'être appelés. Pour les états qui nécessitent une autorisation, si l'utilisateur n'en dispose pas encore, l'état System.OAuthAccountLink est appelé, puis le flux appelle l'état qui exigeait l'autorisation. Vous pouvez voir comment utiliser cette fonctionnalité dans Autorisation d'utilisateur dans les clavardages en groupe (elle sert à tous les types de clavardage, pas seulement à ceux en groupe).

Conseil :

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

Vous pouvez également modifier les messages Other - oauthCancelPrompt et Other - oauthSuccessPrompt dans l'ensemble de configuration.

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

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

Ce composant peut retourner les actions suivantes :

Cet exemple présente les propriétés obligatoires que vous devez définir pour le composant System.OAuthAccountLink : prompt qui précise le message de connexion, variable qui indique le composant dans lequel stocker le code d'autorisation et authorizeURL qui définit à la fois l'URL OAuth du fournisseur et l'URL de redirection 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 détecte ce composant, le robot de compétence invite l'utilisateur avec deux liens — Login (Connexion) et Cancel (Annuler).

Description de l'illustration 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 qui est nommé par l'action fail.

• L'utilisateur ne clique sur aucun bouton mais entre du texte. Le composant passe à l'état qui est 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 en tant que vue Web, comme illustré dans l'exemple ci-dessous. Une fois l'autorisation reçue, le composant passe à l'état nommé par l'action pass (ou à l'état suivant s'il n'y a pas d'action pass), qui appelle généralement un composant personnalisé qui échangé le code d'autorisation contre un jeton d'accès.

Description de l'illustration 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.