Utilice este componente para obtener un token de acceso de OAuth2 del tipo de permiso Credenciales de cliente. Es decir, puede utilizarlo para obtener un token de acceso basado en las credenciales del cliente, no en el nombre y la contraseña del usuario. Puede utilizar este componente para obtener un token que permita acceder a los recursos del cliente protegidos por Oracle Identity Cloud Service u Oracle Access Manager (OAM).

Si necesita acceder a recursos en nombre de un usuario, consulte System.OAuth2AccountLink y System.OAuthAccountLink.

Para poder utilizar este componente en una aptitud, debe realizar las siguientes tareas:

1. Si aún no está registrado, registre el cliente con el proveedor de identidad, como se describe en Registro de proveedor de identidad.
2. Agregue un servicio de autenticación de credenciales de cliente para el proveedor de identidad, como se describe en Servicios de autenticación.

Este componente no incluye ninguna acción. Para manejar los problemas del sistema que puedan surgir, agregue una transición que pase a un estado que pueda manejar este tipo de errores.

A continuación, se muestra un ejemplo de un estado que utiliza este componente:

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

Utilice este componente para obtener un token de acceso de usuario OAuth2 (código de autorización de tipo de permiso) para los recursos protegidos por OCI IAM, Oracle Access Manager (OAM), la plataforma de identidad de Microsoft o la autorización de Google OAuth 2.0. Este componente completa todos los pasos del flujo de OAuth2 en 3 partes y devuelve el token de acceso de OAuth2.

Puede utilizar el valor requiresAuthorization para indicar qué estados requieren autorización antes de que se puedan llamar. Para los estados que requieren autorización, si el usuario aún no lo ha autorizado, se llama al estado System.OAuth2AccountLink y, a continuación, el flujo llama al estado que requiere autorización. Puede aprender a utilizar esta función en Autorización de usuario en chats de grupo (funciona para todos los tipos de chats, no solo para chats de grupo).

Si necesita obtener un token de acceso con el tipo de permiso Credenciales de cliente para acceder a los recursos del cliente, consulte System.OAuth2Client.

Para poder utilizar este componente en una aptitud, debe realizar las siguientes tareas:

1. Si aún no se ha registrado, registre el cliente con el proveedor de identidad, tal y como se describe en Registro de proveedor de identidad.
2. Agregue un servicio de autenticación para el proveedor de identidad, como se describe en Servicios de autenticación.

Algunos proveedores de identidad han emitido tokens de refrescamiento. Cuando se utilizar este componente, Digital Assistant almacena el token de refrescamiento para el período de retención especificado para el servicio de autenticación. El backend de Digital Assistant puede utilizar el token de refrescamiento, si está disponible, para obtener un nuevo token de acceso sin que el usuario tenga que volver a conectarse.

Consejo:

En aptitudes con la versión 21.04 y posteriores de la plataforma, los valores por defecto para las propiedades cancelLabel, linkLabel y prompt se almacenan en el grupo de recursos de la aptitud. Para cambiar un valor por defecto, abra la página Grupo de recursos de la aptitud, haga clic en , seleccione el separador Configuración y cambie el mensaje para la clave OAuth2AccountLink - <nombre de propiedad>. Si utiliza el grupo de recursos de la aptitud para cambiar el valor por defecto, no es necesario incluir la propiedad en el componente a menos que desee sustituir el valor por defecto.

También puede cambiar los mensajes Otro - oauthCancelPrompt y Otro - oauthSuccessPrompt en el grupo de configuración.

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

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

Este componente puede devolver las siguientes acciones:

Cuando el motor de diálogo encuentra el componente, el bot de aptitudes solicita al usuario dos enlaces: Obtener un token de acceso y Cancelar (puede utilizar linkLabel y cancelLabel para cambiar el texto del enlace).

Si el usuario hace clic en el enlace para obtener un token de acceso, se muestra la página de conexión del proveedor de identidad o el diálogo de autenticación especificado por el servicio de autenticación. Tras establecer una conexión correcta, obtiene el token de acceso, define los valores para las variables identificadas por accessTokenVariableName y authenticatedUserVariableName y, a continuación, fluye al estado con el nombre de la acción pass (o al siguiente estado si no hay una acción pass). Si el usuario cancela, la acción de devolución se establece en fail. Si el usuario introduce texto, devuelve la acción textReceived.

Como se ha mencionado anteriormente, puede definir requiresAuthorization para un estado a fin de garantizar que el usuario esté autorizado antes de llamar al componente de estado. Si el usuario aún no está autorizado, el diálogo llama a la acción system.authorizeUser en defaultTransitions. Ejemplo:

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"     

Utilice este componente para revocar todos los tokens de acceso de usuario y los tokens de refrescamiento de usuario conectado del proveedor de identidad que representa el servicio de autenticación. También elimina los tokens de refrescamiento de la base de datos. Para utilizar este componente, debe proporcionar el URL del token de refrescamiento de revocación del proveedor de identidad en la interfaz de usuario del servicio de autenticación.

La aptitud debe incluir un estado que utilice el componente OAuth2AccountLink para el mismo servicio de autenticación y se debe llamar antes que el estado que utiliza el componente System.OAuth2ResetTokens.

Este componente puede devolver la siguiente acción:

Utilice este componente para obtener el código de autorización para servicios protegidos por el flujo de concesión de código de autorización, como LinkedIn, Twitter, Google o Microsoft. Los componentes personalizados de la aptitud pueden intercambiar el código de autorización por un token de acceso, que luego utilizan para llamar el servicio final.

El componente dirige en primer lugar al usuario a la página de conexión del proveedor de identidad. Después de una conexión correcta, el componente devuelve el código de autorización en una variable, que se utiliza para transferir el código de autorización al componente personalizado. La API de componente personalizado debe intercambiar el código de autorización, el ID de cliente y el secreto de cliente para un token de acceso de usuario de OAuth2.

Puede utilizar el valor requiresAuthorization para indicar qué estados requieren autorización antes de que se puedan llamar. Para los estados que requieren autorización, si el usuario aún no ha autorizado, se llama al estado System.OAuthAccountLink y, a continuación, el flujo llama al estado que requiere autorización. Puede aprender a utilizar esta función en Autorización de usuario en chats de grupo (funciona para todos los tipos de chats, no solo para chats de grupo).

Consejo:

En aptitudes con la versión 21.04 y posteriores de la plataforma, los valores por defecto para las propiedades cancelLabel, linkLabel y prompt se almacenan en el grupo de recursos de la aptitud. Para cambiar un valor por defecto, abra la página Grupo de recursos de la aptitud, haga clic en , seleccione el separador Configuración y cambie el mensaje para la clave OAuthAccountLink - <nombre de propiedad>. Si utiliza el grupo de recursos de la aptitud para cambiar el valor por defecto, no es necesario incluir la propiedad en el componente a menos que desee sustituir el valor por defecto.

También puede cambiar los mensajes Otro - oauthCancelPrompt y Otro - oauthSuccessPrompt en el grupo de configuración.

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

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

Este componente puede devolver las siguientes acciones:

En este ejemplo, se muestran las propiedades necesarias que debe definir para el componente System.OAuthAccountLink: prompt, que especifica el mensaje de conexión, variable, que indica el componente donde se almacena el código de autorización y authorizeURL, que define tanto el URL de OAuth del proveedor como el URL de redirección que recibe el código de autorización.

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

Cuando el motor de diálogo encuentra este componente, el bot de aptitud solicita al usuario dos enlaces: Conexión y Cancelar.

Descripción de la ilustración fb-oauth.png

Hay varias formas de realizar la transición desde este componente:

• El usuario hace clic en el botón Cancelar y el componente pasa al estado que especifica la acción fail.

• El usuario no hace clic en ningún botón, sino que introduce texto en su lugar. El componente pasa al estado especificado por la acción textReceived.

• El usuario hace clic en el enlace de conexión y el canal representa la página de conexión del proveedor de identidad o el cuadro de diálogo de autenticación en forma de vista web, como se muestra en el siguiente ejemplo. Tras una autorización correcta, el componente pasa al estado especificado por la acción pass (o al siguiente estado si no hay una acción pass), que normalmente llamaría a un componente personalizado que intercambia el código de autorización por un token de acceso.

Descripción de la ilustración webview-login.png

Si la ventana de prueba no representa la vista web, corte y pegue el texto del enlace en el explorador.