Crear un cliente OAuth

Los clientes de OAuth le permiten realizar solicitudes a la API de plataforma o autenticar con Genesys Cloud, o bien sincronizar entidades entre Genesys Cloud y terceros-persona sistemas.

Requisitos previos
  • OAuth > > Cliente > > Añadir permiso

Este procedimiento es para aplicación proveedores que desean que su aplicación reciba un token que le permita realizar solicitudes al Genesys Cloud Plataforma API. El token representa un usuario permiso de la aplicación para acceder a los datos Genesys Cloud. Se utiliza cuando la aplicación debe autorizar una solicitud a una API punto final. Para ver una lista de API de plataforma Genesys Cloud, consulte la Recursos de API en el Genesys Cloud Centro de desarrolladores.

  1. Haga clic Admin.
  2. Bajo Integraciones, haga clic en OAuth.
  3. Haga clic Añadir cliente. Aparece la pestaña Detalles del cliente.

  4. Establecer Nombre de la aplicación a un nombre descriptivo de la aplicación. Este nombre se muestra cuando alguien autoriza este cliente OAuth.
  5. (Opcional) Escriba una breve descripción de la aplicación en el Descripción caja.
  6. A continuación, establezca la duración del tiempo hasta que los tokens creados con este cliente caduquen. Acepte la duración de por opción predeterminada o introduzca un valor entre 300 y 172800 segundos. Esto establece la vida útil del token a un máximo de 2 días o menos.
  7. Realice una selección a continuación Tipos de subvención. Los tipos de subvención establecen el modo en que un aplicación recibe un token de acceso.Genesys Cloud es compatible con los tipos de subvenció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 sobreGenesys Cloud Centro de desarrolladores.

    • Concesión de credenciales del cliente: Un proceso autenticación único para uso exclusivo por aplicaciones nousuario (por ejemplo, un servicio de Windows o un trabajo de cron). El cliente aplicación 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 tanto, no podrá acceder a usuario API específicas (p. ej. GET /v2/users/me).

      Si asigna roles para Genesys Cloud para Salesforce, consulte también Permisos de cliente OAuth para Genesys Cloud para Salesforce.

    • Concesión de autorización de código: Un proceso de dos pasos autenticación en el que un usuario se autentifica con Genesys Cloud, el cliente aplicación se devuelve un código de autorización. El cliente aplicación 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 a la hora de realizar llamadas API autenticadas. Esta es la opción más segura e ideal para sitios web en los que las solicitudes de API se realizarán en el lado del servidor (por ejemplo, ASP.NET o PHP) y algunas de las aplicaciones escritorio en las que un cliente delgado autorizaría el usuario y pase el código de autenticación a un servidor de back-end para intercambiar un token de autenticación y realizar solicitudes de API.

    • Subvención implícita (navegador): Un proceso de un paso autenticación en el que un usuario se autentica con Genesys Cloud y el cliente aplicación se devuelve 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 cliente navegador (es decir, JavAscript) y la mayoría de escritorio aplicaciones (por ejemplo,programas NET WPF/WInforms o Java escritorio).

    • Portador SAML2: Un proceso autenticación en donde un cliente aplicación puede utilizar una Lenguaje de Marcado para Confirmaciones de Seguridad (SAML2) reivindicación para solicitar un token de portador. Consulte también:Genesys Cloud inicio de sesión único y proveedor de identidades solución.

      Nota: En todas las regiones se puede utilizar un único tipo de autorización de código o de subvención implícita.

  8. Parámetros de suministro requeridos por el tipo de subvención.

    • Funciones: Si ha seleccionado Credenciales del cliente, haga clic en el Funciones tab. Esto abre una lista de funciones entre las que elegir. Asigne un conjunto mínimo de funciones para determinar lo que puede hacer su integración de cliente OAuth.

      Nota: Para otorgar funciones a un cliente OAuth, debe tener los roles asignados a su perfil.

      También debe asociar cada función con un división. Determine qué divisiones deben asociarse a las funciones de la subvención de credenciales del cliente. Todas las funciones de concesión de credencial de cliente están destinadas a la división de inicio por opción predeterminada. Actualice con las divisiones adecuadas para que las aplicaciones y sistemas que utilicen esos derechos puedan acceder a los datos adecuados. Si una subvención de credencial de cliente se proporciona por medio de un 3er persona, consulte el 3er persona para comprender el uso de la beca y actualizar las divisiones de las funciones de forma adecuada. Ningún otro tipo de subvención se ve afectado por el control de acceso.

    • URI de redireccionamiento autorizados (uno por línea, hasta 125): Estas son las URL que se publican en el código de autorización, para ser intercambiadas por un token de acceso utilizado más tarde para autenticar llamadas API posteriores.

    • Alcance: Todos los tipos de subvención excepto las credenciales del cliente tienen un ajuste de alcance. Haga clic en el cuadro Alcance para mostrar una lista de los scopios disponibles para su aplicación. Como mejor práctica, seleccione solo el mínimo de alcance de sus necesidades de aplicación. Para obtener información sobre los endoscopios, consulte Endoscopios OAuth en el Centro de desarrolladores. 

  9. Haga clic Guardar. Genesys Cloud crea un ID de cliente y un secreto de cliente (token).

Su Genesys Cloud cliente OAuth ya está listo para usar.

Requisitos previos
  • OAuth > > Cliente > > Añadir permiso

Si se aplica alguna situación, cree un cliente OAuth para Genesys Cloud Marco empotrable:

  • Está implementando una implementación pública.
  • Está implementando una implementación privada que accede a getAuthToken en su archivo framework.js. Para obtener más información, consulte Usuario.getAuthToken (Genesys Cloud Centro de desarrolladores).

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

  1. Haga clic Admin.
  2. Bajo Integraciones, haga clic en OAuth.
  3. Haga clic Añadir cliente. Aparece la pestaña Detalles del cliente.

    Ficha Detalles del cliente para cliente OAuth

  4. Establecer Nombre de la aplicación a un nombre descriptivo de la aplicación.

    Nombre de la aplicación es el nombre que se muestra cuando alguien autoriza a este cliente OAuth. Para obtener más información, consulte Autorizar un cliente OAuth.

  5. (Opcional) Escriba una breve descripción de la aplicación en el Descripción caja.
  6. Establezca la duración del tiempo hasta que los tokens creados con este cliente caduquen.

    Acepte la duración de por opción predeterminada o introduzca un valor entre 300 y 172800 segundos. Esta duración establece la vida útil del token a un máximo de dos días o menos.

    Consejo: Genesys recomienda establecer la duración del token a 18 horas (64800 segundos). Esta duración suele provocar que el token caduque fuera de la jornada laboral normal de un agente.

  7. Bajo Tipos de subvención, seleccionar Subvención implícita (navegador).

    Para obtener más información, consulte Autorización (Genesys Cloud Centro de desarrolladores) y Subvención: implícita (Genesys Cloud Centro de desarrolladores).

  8. Bajo URL de redireccionamiento autorizadas, añadir https://apps.mypurecloud.com/crm/index.html.

    Notas:
    • Si establece dedicadoLoginaInicio en su archivo framework.js, también añadir https://apps.mypurecloud.com/crm/authWindow.html bajo URL de redireccionamiento autorizadas. Para obtener más información, consulte dedicadoLoginaInicio bajo ajustes (Genesys Cloud Centro de desarrolladores).
    • Después de Genesys publica su implementación pública, Genesys le proporcionará una URI nueva que utilizar.
  9. Bajo Alcance, añadir todos los endoscopios necesarios. También puede añadir endoscopios adicionales.

    Para obtener una lista de los endoscopios necesarios, consulte Requisitos de administrador para los clientes incluidos Genesys Cloud. Para obtener información sobre los endoscopios, consulte Endoscopios OAuth (Genesys Cloud Centro de desarrolladores).

  10. Haga clic Guardar.

    Genesys Cloud crea un ID de cliente y un secreto de cliente.

  11. Dé a los desarrolladores el ID de cliente.

    Los desarrolladores deben añadir el ID de cliente a CliEntidos en el archivo framework.js. Para obtener más información, consulte CliEntidos (Genesys Cloud Centro de desarrolladores).

Para obtener más información sobre la integración, consulte Acerca de Genesys Cloud Marco empotrable.

Requisitos previos
  • OAuth > > Cliente > > Añadir permiso
  • Integración de SCIM función asignada a su usuario

    Si la integración de SCIM no aparece, restaurar las funciones predeterminadas a su organización Genesys Cloud. Usar explorador de API para realizar una llamada API a POST /api/v2/autorización/roles/predeterminado. Para obtener más información, consulte Inicio rápido de herramientas para desarrolladores (Genesys Cloud Centro de desarrolladores). Para acceder a API Explorer, vaya a https://developer.genesys.cloud/developer-tools/#/api-explorer.

Para utilizar Genesys Cloud SCIM (Gestión de identidad), cree un cliente de OAuth Genesys Cloud. El cliente OAuth genera un ID de cliente y un secreto de cliente que se agrega a su sistema de gestión de identidad.

  1. Haga clic Admin.
  2. Bajo Integraciones, haga clic en OAuth.
  3. Haga clic Añadir cliente. Aparece la pestaña Detalles del cliente.
  4. Establecer Nombre de la aplicación a un nombre descriptivo de la aplicación.

    Nombre de la aplicación es el nombre que se muestra cuando alguien autoriza a este cliente OAuth. Para obtener más información, consulte Autorizar un cliente OAuth.

  5. (Opcional) Escriba una breve descripción de la aplicación en el Descripción caja.
  6. Establecer Duración de token

    La duración de token es la duración del tiempo hasta que los tokens creados con este cliente caducan. Acepte la duración predeterminada de 86.400 o introduzca un valor entre 300 y 38.880,000 segundos. Esto establece la vida útil del token a un máximo de 450 días.

    Nota: Sólo puede establecer un máximo de 38 880 000 segundos si utiliza la integración de SCIM función o una función personalizada que tenga exactamente los mismos permisos.

  7. Bajo Tipos de subvención, seleccionar Credenciales del cliente.
  8. Haga clic en el botón Funciones y asignar el Integración de SCIM función. 
    Importante:
    • Para otorgar este función a su cliente OAuth, debe tener este función asignado a su perfil.
    • No asigne otras funciones a su cliente OAuth ni a otros permisos a la integración de SCIM función. Si asigna otras funciones o permisos, Duración de token que establece el paso 6 vuelve al valor predeterminado de 86,400 segundos.
    • Incluya todas las divisiones que gestionará con SCIM.
  9. Haga clic Guardar.

    Genesys Cloud crea un ID de cliente y un secreto de cliente. Utilice estos identificadores en la configuración de su sistema de gestión de identidad.

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