Crea un cliente OAuth

Prerrequisitos
  • OAuth > Cliente > Agregar permiso

Los clientes de OAuth le permiten realizar solicitudes a la API de la plataforma o autenticarse contra Genesys Cloud, o sincronizar entidades entre Genesys Cloud y sistemas de terceros.

Este procedimiento es para los proveedores de aplicaciones que desean que su aplicación reciba un token que le permita realizar solicitudes a la API de la Plataforma de Genesys Cloud. El token representa el permiso de un usuario para que la aplicación acceda a los datos de Genesys Cloud y se utiliza cuando la aplicación debe autorizar una solicitud a un punto final de la API. Para ver una lista de las API de Genesys Cloud Platform, consulte la página API resources en el Centro de Desarrolladores de Genesys Cloud. 

  1. Hacer clic Administración.
  2. En Integraciones, haga clic en OAuth.
  3. Haga clic en Menú > TI e integraciones > OAuth.
  4. En la página OAuth, haga clic en Añadir cliente. Aparecerá la página Añadir nuevo cliente.
  5. En el campo App Name, introduzca el nombre de la aplicación.
  6. (Opcional) En el campo Descripción, introduzca la descripción.
  7. En el campo Grant Types, seleccione un tipo para la subvención. Los tipos de concesión establecen la forma en que una aplicación obtiene un token de acceso. Genesys Cloud admite los tipos de concesión de autorización OAuth 2 que se enumeran a continuación. Al hacer clic en el nombre de un tipo de subvención se muestra más información sobre ella desde el Centro de desarrollo de Genesys Cloud.
    • Concesión de credenciales de cliente: Un proceso de autenticación de un solo paso para uso exclusivo de aplicaciones que no son de usuario (por ejemplo, un servicio de Windows o una tarea cron). La aplicación cliente proporciona credenciales de cliente OAuth a cambio de un token de acceso. Este tipo de autorización no está en el contexto de un usuario y, por lo tanto, no puede acceder a las API específicas de usuario (por ejemplo, GET /v2/users/me). Si asigna funciones para Genesys Cloud for Salesforce, consulte también Permisos de cliente OAuth para Genesys Cloud for Salesforce.
    • Código Autorización Subvención: Un proceso de autenticación de dos pasos en el que un usuario se autentica con Genesys Cloud, luego la aplicación cliente recibe un código de autorización. La aplicación cliente proporciona credenciales de cliente OAuth y utiliza el código de autorización para obtener un token de acceso. El token de acceso se puede utilizar al realizar llamadas API autenticadas. Esta opción es la más segura e ideal para sitios web en los que las solicitudes de API se realizan en el servidor (por ejemplo, ASP.NET o PHP) y algunas aplicaciones de escritorio en las que un cliente ligero autoriza al usuario y pasa el código de autenticación a un servidor back-end para intercambiarlo por un token de autenticación y realizar solicitudes de API.
    • Concesión implícita (Navegador): Un proceso de autenticación de un solo paso en el que un usuario se autentica con Genesys Cloud y la aplicación cliente recibe directamente un token de acceso. Esta opción proporciona menos seguridad para el token de acceso que la concesión de código de autorización, pero es ideal para aplicaciones de navegador del lado del cliente (por ejemplo, JavaScript) y la mayoría de las aplicaciones de escritorio (por ejemplo, .NET WPF/WinForms o programas de escritorio Java).
    • Portador SAML2: Proceso de autenticación en el que una aplicación cliente puede utilizar una aserción SAML2 (Security Assertion Markup Language) para solicitar un token de portador. Para obtener más información, consulte Genesys Cloud single sign-on and identity provider solution.
      Nota: Se puede utilizar un único tipo de autorización de código o concesión implícita en todas las regiones.
  8. Hacer clic próximo.
  9. En la tabla Asignar funciones, en la columna Asignado, active el conmutador disponible para cada función. Esta acción abre una lista de funciones entre las que elegir. Asigna un conjunto mínimo de roles para determinar qué puede hacer tu integración de cliente OAuth.
    Nota: Para otorgar roles a un cliente OAuth, debe tener esos roles asignados a su perfil.
    También debe asociar cada rol con un división. Determine qué divisiones desea asociar a las funciones para la Concesión de credenciales de cliente. Todos los roles de concesión de credenciales de cliente están asignados a la División de origen de forma predeterminada. Actualizar con las divisiones correspondientes para que las aplicaciones y los sistemas que utilizan esas subvenciones puedan acceder a los datos adecuados. Si una concesión de credenciales de cliente es suministrada por un tercero, verifique con el tercero para entender el uso de la concesión y actualice las divisiones para los roles apropiadamente. Ningún otro tipo de subvención se ve afectado por el control de acceso.
    • URIs de redirección autorizadas (una por línea, hasta 125): El código de autorización se envía a estos URI y se intercambian por un token de acceso que se utilizará posteriormente para autenticar las siguientes llamadas a la API.
    • Alcance: Todos los tipos de concesión, excepto las Credenciales de cliente, tienen una configuración de Alcance. Haga clic en el cuadro Ámbito y vea una lista de los ámbitos disponibles para su aplicación. Como práctica recomendada, seleccione sólo los ámbitos mínimos que necesite su aplicación. Para más información sobre ámbitos, consulte Ámbitos de OAuth en el Centro de desarrollo. 
  10. Hacer clic próximo.
  11. En el campo Token Duration in seconds, introduzca la duración requerida para el token. Establezca la duración del tiempo hasta que caduquen los tokens creados con este cliente. Acepte la duración predeterminada o ingrese un valor entre 300 y 172800 segundos. Esto establece la vida útil del token en un máximo de dos días o menos.
    Nota: Cuando el cumplimiento de la HIPAA está habilitado para su organización, Genesys Cloud aplica un tiempo de espera de 15 minutos y este tiempo de espera también se aplica a los tokens emitidos por los clientes de OAuth. Para más información, ver Cumplimiento de HIPAA.
  12. Haga clic en Guardar. Un mensaje confirma que se ha creado el cliente. 
  13. En la página Añadir nuevo cliente, aparece la sección Secreto del cliente. El campo Secreto del cliente muestra una cadena secreta que la aplicación utiliza para demostrar su identidad cuando el usuario solicita un token. Este secreto también puede denominarse contraseña de la aplicación.
    Nota: Puede ver este secreto sólo una vez en el momento de la configuración.
    En este campo puede realizar las siguientes acciones:
    • Para ver los detalles de la contraseña, haga clic en Mostrar .
    • Para copiar la contraseña, haga clic en Copiar .
    • Para generar un nuevo código secreto, pulse Generar nuevo secreto. Aparece el cuadro de diálogo ¿Generar nuevo secreto de cliente?
      • Hacer clic Confirmar.
      • Un mensaje confirma que la contraseña ha sido modificada.  
  14. Haga clic en Finalizar. Aparecerá el cuadro de diálogo Copiar y almacenar secreto de cliente.
  15. Haga clic en Confirme. La aplicación que acabas de crear aparece con la siguiente sección en la parte inferior de la página.
    • Creado por: Muestra el nombre del usuario que ha creado el cliente.
    • Fecha: Muestra la fecha de creación del nuevo cliente.
    • Modificado por: Muestra el nombre del usuario que ha modificado los datos del cliente.
    • Fecha: Muestra la fecha de modificación del cliente.

    Su cliente Genesys Cloud OAuth ya está listo para ser utilizado. 

    Prerrequisitos
    • OAuth > Cliente > Agregar permiso

    Si se aplica alguna de las situaciones, cree un cliente OAuth para Genesys Cloud Embeddable Framework:

    • Desea implantar un despliegue público.
    • Quieres implementar un despliegue privado que acceda al método getAuthToken en tu archivo framework.js. Para obtener más información, consulte User.getAuthToken en el Centro de desarrollo de Genesys Cloud.

    Un cliente OAuth genera un ID de cliente que los desarrolladores pueden utilizar para clientIds en el archivo framework.js. Para obtener más información, consulte clientIds en el Centro de desarrollo de Genesys Cloud.

    1. Hacer clic Administración.
    2. En Integraciones, haga clic en OAuth.
    3. Haga clic en Menú > TI e integraciones > OAuth.
    4. Haga clic en Añadir cliente. Aparecerá la página Añadir nuevo cliente.
    5. En el campo App Name, introduzca el nombre de la aplicación.
    6. (Opcional) En el campo Descripción, introduzca la descripción.
    7. En el campo Grant Types, seleccione Token Implicit Grant (Browser). Para obtener más información, consulte Autorización y Concesión - Implícita  en el Centro de desarrollo.
    8. Hacer clic próximo.
    9. En el campo Token Duration in seconds, introduzca la duración requerida para el token. Acepte la duración predeterminada o ingrese un valor entre 300 y 172800 segundos. Esta duración fija el tiempo de vida de la ficha en un máximo de dos días o menos.
      Nota: Genesys recomienda establecer la duración del token en 18 horas (64.800 segundos). Por lo general, esta duración hace que el token expire fuera de la jornada laboral normal de un agente.
    10. En la casilla URIs de redirección autorizadas (una por línea), añada https://apps.mypurecloud.com/crm/index.html, personalizada según su región de Genesys Cloud.
      Notas:
      • Utilizar el Región de AWS según su despliegue.
      • Si establece dedicatedLoginWindow a true en su archivo framework.js, añada también https://apps.mypurecloud.com/crm/authWindow.html bajo URIs de redirección autorizadas. Para obtener más información, consulte dedicatedLoginWindow en settings en el Centro de desarrollo.
      • Después de que Genesys publique su implementación pública, Genesys le proporcionará un nuevo URI para usar.
    11. En el campo Ámbito, seleccione los ámbitos necesarios. También puedes añadir más ámbitos. Para obtener una lista de los ámbitos obligatorios, consulte Requisitos de administrador para los clientes integrados de Genesys Cloud. Para más información sobre ámbitos, consulte Ámbitos de OAuth en el Centro de desarrollo.
    12. Haga clic en Guardar. En la página Añadir nuevo cliente, aparece la sección Secreto del cliente. El campo Secreto del cliente muestra una cadena secreta que la aplicación utiliza para demostrar su identidad cuando el usuario solicita un token. Este secreto también puede denominarse contraseña de la aplicación.
      Nota: Puede ver este secreto sólo una vez en el momento de la configuración.
      En este campo puede realizar las siguientes acciones:
      • Para ver los detalles de la contraseña, haga clic en Mostrar .
      • Para copiar la contraseña, haga clic en Copiar .
      • Para generar un nuevo código secreto, pulse Generar nuevo secreto. Aparecerá el cuadro de diálogo ¿Generar nuevo secreto de cliente?
        • Aparece el cuadro de diálogo ¿Generar nuevo secreto de cliente? Haga clic en Confirme.
        • Un mensaje confirma que la contraseña ha sido modificada.  
    13. Hacer clic Terminar.
    14. Aparecerá el cuadro de diálogo Copiar y almacenar secreto de cliente. Para confirmar que ha copiado y guardado la contraseña, marque la casilla de verificación. Si continúa, no podrá volver a ver esta contraseña. 
    15. Haga clic en Confirme. La aplicación que acabas de crear aparece con la siguiente sección en la parte inferior de la página.
        • Creado por: Muestra el nombre del usuario que ha creado el cliente.
        • Fecha: Muestra la fecha de creación del nuevo cliente.
        • Modificado por: Muestra el nombre del usuario que ha modificado los datos del cliente.
        • Fecha: Muestra la fecha de modificación del cliente.

      Proporcione el ID de cliente a los desarrolladores, que a su vez añaden el ID de cliente a clientIds en el archivo framework.js. Para más información, consulte clientIds en el Centro de desarrollo.

      Para obtener más información sobre la integración, consulte Acerca del marco integrable de Genesys Cloud.

      Prerrequisitos
      • OAuth > Cliente > Agregar permiso
      • Función de integración SCIM asignada a su usuario
      • Si no aparece SCIM Integration, restaure los roles predeterminados en su organización de Genesys Cloud. Utilice API Explorer para realizar una llamada API a POST / api / v2 / autorización / roles / default. Para más información, consulte Developer tools quick start en el Centro de desarrollo. Acceda a API Explorer en el Centro de desarrollo.

      Para utilizar Genesys Cloud SCIM (Gestión de identidades), cree un cliente Genesys Cloud OAuth. El cliente OAuth genera un ID de cliente y un secreto de cliente que usted añade a su sistema de gestión de identidades. 

      1. Hacer clic Administración.
      2. En Integraciones, haga clic en OAuth.
      3. Haga clic en Menú > TI e integraciones > OAuth.
      4. Haga clic en Añadir cliente. Aparecerá la página Añadir nuevo cliente.
      5. En el campo App Name, introduzca el nombre de la aplicación.
      6. (Opcional) En el campo Descripción, introduzca la descripción.
      7. En el campo Grant Types, seleccione Client Credentials. Para obtener más información sobre cada subvención, consulte el paso 8 de la pestaña API de la plataforma.
      8. Hacer clic próximo.
      9. En la tabla Asignar roles, en la columna Asignado, asigne el rol Integración SCIM.
        Nota: Para otorgar esta función a su cliente OAuth, debe tener esta función asignada a su perfil. No asigne otros roles a su cliente OAuth ni otros permisos al rol de Integración de SCIM. Si no asigna otras funciones o permisos, el valor que establezca en el campo Duración del token en segundos volverá al valor predeterminado de 86.400 segundos. Incluya también todas las divisiones que gestionará con SCIM.
      10. Hacer clic próximo.
      11. En el campo Token Duration in seconds, introduzca la duración requerida para el token. La duración del token es el tiempo que falta para que caduquen los tokens creados con este cliente. Acepte la duración predeterminada de 86,400 o ingrese un valor entre 300 y 38,880,000 segundos. Esto fija la vida útil del token en un máximo de 450 días.
        Nota: Sólo puede establecer el máximo en 38.880.000 segundos si utiliza el rol Integración SCIM o un rol personalizado que tenga los mismos permisos.
      12. Haga clic en Guardar. Un mensaje confirma que se ha creado el cliente. En la página Añadir nuevo cliente, aparece la sección Secreto del cliente. El campo Secreto del cliente muestra una cadena secreta que la aplicación utiliza para demostrar su identidad cuando el usuario solicita un token. Este secreto también puede denominarse contraseña de la aplicación.
        Nota: Puede ver este secreto sólo una vez en el momento de la configuración.
        En este campo puede realizar las siguientes acciones:
        • Para ver los detalles de la contraseña, haga clic en Mostrar .
        • Para copiar la contraseña, haga clic en Copiar .
        • Para generar un nuevo código secreto, pulse Generar nuevo secreto. Aparecerá el cuadro de diálogo ¿Generar nuevo secreto de cliente?
          • Aparece el cuadro de diálogo ¿Generar nuevo secreto de cliente? Haga clic en Confirme.
          • Un mensaje confirma que la contraseña ha sido modificada.  
      13. Hacer clic Terminar.
      14. Aparecerá el cuadro de diálogo Copiar y almacenar secreto de cliente. Para confirmar que ha copiado y guardado la contraseña, marque la casilla de verificación. Si continúa, no podrá volver a ver esta contraseña. 
      15. Haga clic en Confirme. La aplicación que acabas de crear aparece con la siguiente sección en la parte inferior de la página.
        • Creado por: Muestra el nombre del usuario que ha creado el cliente.
        • Fecha: Muestra la fecha de creación del nuevo cliente.
        • Modificado por: Muestra el nombre del usuario que ha modificado los datos del cliente.
        • Fecha: Muestra la fecha de modificación del cliente.

      Además, en esta página puede realizar las siguientes acciones:

      • Edite los detalles del cliente pulsando el botón Editar cliente.
      • Elimine el cliente creado pulsando el botón Eliminar cliente.

      Para obtener información sobre Genesys Cloud SCIM (Gestión de identidades), consulte Acerca de Genesys Cloud SCIM (Gestión de identidades) y Descripción general de Genesys Cloud SCIM (Gestión de identidades) (Centro de desarrolladores de Genesys Cloud).