Mit dieser Komponente können Sie ein OAuth2-Zugriffstoken des Berechtigungstyps "Clientzugangsdaten" abrufen. Sie können damit also ein Zugriffstoken abrufen, das auf den Clientzugangsdaten und nicht auf dem Namen und Kennwort des Benutzers basiert. Mit dieser Komponente können Sie ein Token abrufen, das den Zugriff auf Clientressourcen ermöglicht, die von Oracle Identity Cloud Service oder Oracle Access Manager (OAM) gesichert werden.

Wenn Sie im Namen eines Benutzers auf Ressourcen zugreifen müssen, finden Sie weitere Informationen unter System.OAuth2AccountLink und System.OAuthAccountLink.

Bevor Sie diese Komponente in einem Skill verwenden können, müssen Sie folgende Aufgaben ausführen:

1. Wenn der Client noch nicht registriert wurde, registrieren Sie ihn beim Identitätsprovider, wie unter Identitätsproviderregistrierung beschrieben.
2. Fügen Sie einen Clientzugangsdaten-Authentifizierungsservice für den Identitätsprovider hinzu, wie unter Authentifizierungsservices beschrieben.

Diese Komponente hat keine Aktionen. Um mögliche Systemprobleme zu verarbeiten, fügen Sie einen nächsten Übergang hinzu, der zu einem Status führt, der derartige Fehler verarbeiten kann.

Nachfolgend finden Sie ein Beispiel für einen Status, der diese Komponente verwendet:

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

Verwenden Sie diese Komponente, um ein OAuth2-Benutzerzugriffstoken (Berechtigungstyp Autorisierungscode) für Ressourcen abzurufen, die von OCI IAM, Oracle Access Manager (OAM), Microsoft-Identitätsplattform oder Google OAuth 2.0-Autorisierung gesichert werden. Diese Komponente führt alle Schritte für den dreistufigen OAuth2-Ablauf aus und gibt das OAuth2-Zugriffstoken zurück.

Mit der Einstellung requiresAuthorization können Sie angeben, welche Status eine Autorisierung erfordern, bevor sie aufgerufen werden können. Wenn der Benutzer für die Status, die eine Autorisierung erfordern, noch nicht autorisiert ist, wird der Status System.OAuth2AccountLink aufgerufen. Der Ablauf ruft dann den Status auf, der die Autorisierung erforderte. Unter Benutzerautorisierung in Gruppenchats erfahren Sie, wie Sie dieses Feature verwenden (es funktioniert für alle Chats, nicht nur für Gruppenchats).

Wenn Sie ein Zugriffstoken des Berechtigungstyps "Clientzugangsdaten" anfordern müssen, finden Sie weitere Informationen unter System.OAuth2Client.

Bevor Sie diese Komponente in einem Skill verwenden können, müssen Sie folgende Aufgaben ausführen:

1. Wenn der Client noch nicht registriert wurde, registrieren Sie ihn mit dem Identitätsprovider, wie unter Identitätsproviderregistrierung beschrieben.
2. Fügen Sie einen Authentifizierungsservice für den Identitätsprovider hinzu, wie unter Authentifizierungsservices beschrieben.

Einige Identitätsprovider stellen Aktualisierungstoken aus. Wenn Sie diese Komponente verwenden, speichert Digital Assistant das Aktualisierungstoken für den Aufbewahrungszeitraum, der für den Authentifizierungsservice angegeben ist. Das Backend von Digital Assistant kann das Aktualisierungstoken verwenden, sofern verfügbar, um ein neues Zugriffstoken abzurufen, ohne dass sich der Benutzer erneut anmelden muss.

Tipp:

In Skills mit Plattformversion 21.04 und höher werden die Standardwerte für die Eigenschaften cancelLabel, linkLabel und prompt im Resource Bundle des Skills gespeichert. Um einen Standardwert zu ändern, öffnen Sie die Seite Resource Bundle des Skills, klicken Sie auf , wählen Sie die Registerkarte Konfiguration aus, und ändern Sie die Nachricht für den Schlüssel OAuth2AccountLink - <Eigenschaftsname>. Wenn Sie das Resource Bundle des Skills verwenden, um den Standardwert zu ändern, müssen Sie die Eigenschaft nur in die Komponente aufnehmen, wenn Sie den Standardwert außer Kraft setzen möchten.

Sie können auch die Nachrichten Sonstige - oauthCancelPrompt und Sonstige - oauthSuccessPrompt im Konfigurations-Bundle ändern.

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

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

Diese Komponente kann folgende Aktionen zurückgeben:

Wenn die Dialog-Engine die Komponente ermittelt, fordert der Skillbot den Benutzer mit zwei Links zu einer Handlung auf: Zugriffstoken abrufen und Abbrechen (Sie können den Linktext mit linkLabel und cancelLabel ändern).

Wenn der Benutzer auf den Link zum Abrufen eines Zugriffstokens klickt, wird die Anmeldeseite oder das Authentifizierungsdialogfeld des Identitätsproviders angezeigt, wie vom Authentifizierungsservice angegeben. Nach erfolgreicher Anmeldung wird das Zugriffstoken abgerufen, die Werte für die Variablen accessTokenVariableName und authenticatedUserVariableName werden festlegt, und es wird in den Status übergegangen, der durch die pass-Aktion benannt wird (oder den nächsten Status, wenn keine pass-Aktion vorhanden ist). Wenn der Benutzer den Vorgang abbricht, wird die Postback-Aktion auf fail gesetzt. Wenn der Benutzer Text eingibt, wird die Aktion textReceived zurückgegeben.

Wie bereits erwähnt können Sie requiresAuthorization für einen Status festlegen, um sicherzustellen, dass der Benutzer autorisiert ist, bevor die Komponente des Status aufgerufen wird. Wenn der Benutzer noch nicht autorisiert ist, ruft das Dialogfeld die Aktion system.authorizeUser in defaultTransitions auf. Beispiel:

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"     

Mit dieser Komponente können Sie alle Aktualisierungs- und Benutzerzugriffstoken des angemeldeten Benutzers vom Identitätsprovider entziehen, den der Authentifizierungsservice repräsentiert. Außerdem werden die Aktualisierungstoken aus der Datenbank entfernt. Um diese Komponente verwenden zu können, müssen Sie die URL zum Widerrufen von Aktualisierungstoken des Identitätsproviders in der Authentifizierungsservice-UI angeben.

Der Skill muss einen Status enthalten, der die Komponente OAuth2AccountLink für denselben Authentifizierungsservice verwendet, und er muss vor dem Status aufgerufen werden, der die Komponente System.OAuth2ResetTokens verwendet.

Diese Komponente kann folgende Aktion zurückgeben:

Verwenden Sie diese Komponente, um den Autorisierungscode für Services zu erhalten, die durch den Autorisierungscode-Berechtigungsablauf gesichert werden, wie LinkedIn, Twitter, Google oder Microsoft. Die benutzerdefinierten Komponenten des Skills können den Autorisierungscode für ein Zugriffstoken austauschen, mit dem sie dann den Endservice aufrufen.

Die Komponente leitet den Benutzer zunächst zur Anmeldeseite des Identitätsproviders weiter. Nach erfolgreicher Anmeldung gibt die Komponente den Autorisierungscode in einer Variablen zurück, mit der Sie den Autorisierungscode an die benutzerdefinierte Komponente übergeben. Die benutzerdefinierte Komponenten-API muss den Autorisierungscode, die Client-ID und das Client Secret gegen ein OAuth2-Benutzerzugriffstoken austauschen.

Mit der Einstellung requiresAuthorization können Sie angeben, welche Status eine Autorisierung erfordern, bevor sie aufgerufen werden können. Wenn der Benutzer für die Status, die eine Autorisierung erfordern, noch nicht autorisiert ist, wird der Status System.OAuthAccountLink aufgerufen. Der Ablauf ruft dann den Status auf, der die Autorisierung erforderte. Unter Benutzerautorisierung in Gruppenchats erfahren Sie, wie Sie dieses Feature verwenden (es funktioniert für alle Chats, nicht nur für Gruppenchats).

Tipp:

In Skills mit Plattformversion 21.04 und höher werden die Standardwerte für die Eigenschaften cancelLabel, linkLabel und prompt im Resource Bundle des Skills gespeichert. Um einen Standardwert zu ändern, öffnen Sie die Seite Resource Bundle des Skills, klicken Sie auf , wählen Sie die Registerkarte Konfiguration aus, und ändern Sie die Nachricht für den Schlüssel OAuthAccountLink - <Eigenschaftsname>. Wenn Sie das Resource Bundle des Skills verwenden, um den Standardwert zu ändern, müssen Sie die Eigenschaft nur in die Komponente aufnehmen, wenn Sie den Standardwert außer Kraft setzen möchten.

Sie können auch die Nachrichten Sonstige - oauthCancelPrompt und Sonstige - oauthSuccessPrompt im Konfigurations-Bundle ändern.

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

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

Diese Komponente kann folgende Aktionen zurückgeben:

In diesem Beispiel werden die erforderlichen Eigenschaften dargestellt, die Sie für die Komponente System.OAuthAccountLink definieren müssen: prompt, in der die Anmeldenachricht festgelegt wird, variable, die die Komponente anweist, wo der Autorisierungscode gespeichert werden soll, und authorizeURL, die die OAuth-URL des Providers und die Umleitungs-URL definiert, die den Autorisierungscode erhält.

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

Wenn die Dialog-Engine diese Komponente aufruft, bietet der Skillbot dem Benutzer zwei Links an: Anmelden und Abbrechen.

Beschreibung der Abbildung fb-oauth.png

Es gibt mehrere Möglichkeiten für den Übergang von dieser Komponente aus:

• Der Benutzer klickt auf die Schaltfläche "Abbrechen", und die Komponente geht in den Status über, der von der Aktion fail benannt wird.

• Der Benutzer klickt nicht auf eine der Schaltflächen, sondern gibt stattdessen Text ein. Die Komponente geht in den Status über, der von der Aktion textReceived benannt wird.

• Der Benutzer klickt auf den Anmeldelink, und der Kanal zeigt die Anmeldeseite des Identitätsproviders oder das zugehörige Authentifizierungsdialogfeld als Webview an, wie im folgenden Beispiel dargestellt. Nach erfolgreicher Autorisierung geht die Komponente in den Status über, der von der Aktion pass benannt wird (oder in den nächsten Status, wenn keine Aktion pass vorhanden ist). Dabei wird normalerweise eine benutzerdefinierte Komponente aufgerufen, die den Autorisierungscode gegen ein Zugriffstoken austauscht.

Beschreibung der Abbildung webview-login.png

Wenn das Testfenster nicht als Webview angezeigt wird, können Sie den Linktext kopieren und in den Browser einfügen.