Crea un cliente OAuth
- 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. 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.
- Hacer clic Administración.
- En Integraciones, haga clic en OAuth.
- Click Menu > IT and Integrations > OAuth.
- Hacer clic Agregar cliente. Aparece la pestaña Detalles del cliente.
- Colocar Nombre de la aplicación a un nombre descriptivo de la aplicación. Este nombre se muestra cuando alguien autoriza este cliente OAuth.
- (Opcional) Escriba una breve descripción de la aplicación en el Descripción caja.
- A continuación, 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 2 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.
- Make a selection below Grant Types. Grant Types set the way an application gets an access token. Genesys Cloud supports the OAuth 2 authorization grant types listed below. Clicking the name of a grant type displays more information about it from the Genesys Cloud Developer Center.
- 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 un trabajo 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 podrá acceder a las API específicas del 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.
- Concesión de autorización de código: 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 es la opción más segura e ideal para sitios web donde las solicitudes de API se realizarán en el lado del servidor (por ejemplo, ASP.NET o PHP) y algunas aplicaciones de escritorio donde un cliente ligero autorizaría al usuario y pasaría el código de autenticación a un servidor back-end. para intercambiar 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 del código de autorización, pero es ideal para aplicaciones de navegador del lado del cliente (es decir, JavaScript) y la mayoría de las aplicaciones de escritorio (por ejemplo, .NET WPF / WinForms o programas de escritorio Java).
- SAML2 Bearer: An authentication process wherein a client application may use a Security Assertion Markup Language (SAML2) assertion to request a bearer token. See also: 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.
- Proporcione los parámetros requeridos por el tipo de subvención.
- Roles: If you selected Client Credentials, click the Roles tab. This opens a list of roles to choose from. Assign a minimum set of roles to determine what your OAuth client integration can do. Nota: Para otorgar roles a un cliente OAuth, debe tener esos roles asignados a su perfil.You must also associate each role with a division. Determine what divisions should be associated with roles for the Client Credential Grant. All Client Credential grant roles are scoped to the Home Division by default. Update with appropriate divisions so that the applications and systems which use those grants can access the appropriate data. If a client credential grant is supplied by a 3rd party, check with the 3rd party to understand the use of the grant and update the divisions for the roles appropriately. No other grant types are affected by access control.
- URI de redireccionamiento autorizado (uno por línea, hasta 125): Estos son los URI en los que se publica el código de autorización, que se intercambiarán por un token de acceso que se usará más tarde para autenticar las llamadas API posteriores.
- Alcance: Todos los tipos de concesión, excepto las Credenciales de cliente, tienen una configuración de Alcance. Haga clic en el cuadro Ámbito para mostrar una lista de los ámbitos disponibles para su aplicación. Como práctica recomendada, seleccione solo los alcances mínimos que necesita su aplicación. Para obtener información sobre los ámbitos, consulte Ámbitos de OAuth en el Centro de desarrolladores.
- Hacer clic Ahorrar. Genesys Cloud crea un ID de cliente y un secreto de cliente (token).
Su cliente Genesys Cloud OAuth ya está listo para ser utilizado.
- OAuth > Cliente > Agregar permiso
Si se aplica alguna de las situaciones, cree un cliente OAuth para Genesys Cloud Embeddable Framework:
- Está implementando una implementación pública.
- Está implementando una implementación privada que accede al getAuthToken método en su archivo framework.js. Para más información, ver User.getAuthToken (Centro de desarrolladores de Genesys Cloud).
Un cliente de OAuth genera un ID de cliente que los desarrolladores pueden usar para clientIds en el archivo framework.js. Para más información, ver clientIds (Centro de desarrolladores de Genesys Cloud).
- Hacer clic Administración.
- En Integraciones, haga clic en OAuth.
- Click Menu > IT and Integrations > OAuth.
- Hacer clic Agregar cliente. Aparece la pestaña Detalles del cliente.
- Configure App Name con un nombre descriptivo de la aplicación. El App Name es el nombre que se muestra cuando alguien autoriza a este cliente OAuth. Para más información, consulte Autorizar un cliente OAuth.
- (Opcional) En el cuadro Descripción, escriba una breve descripción de la aplicación.
- Establece el tiempo que transcurrirá hasta que caduquen los tokens creados con este cliente. 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 que establezca la duración del token en 18 horas (64800 segundos). Por lo general, esta duración hace que el token expire fuera de la jornada laboral normal de un agente.
- En Tipos de subvención, seleccione Implicit Grant (Browser). Para obtener más información, consulte Autorización (Centro de desarrollo de Genesys Cloud) y Concesión - Implícita (Centro de desarrollo de Genesys Cloud).
- En URI de redirección autorizados, añada https://apps.mypurecloud.com/crm/index.html, personalizado según su región de Genesys Cloud. Notas:
- Utilizar el Región de AWS según su despliegue.
- Si pones DedicadoLoginWindow a verdadero en su archivo framework.js, también agregue https://apps.mypurecloud.com/crm/authWindow.html debajo URI de redireccionamiento autorizado. Para más información, ver DedicadoLoginWindow debajo ajustes (Centro de desarrolladores de Genesys Cloud).
- Después de que Genesys publique su implementación pública, Genesys le proporcionará un nuevo URI para usar.
- En Ámbito, añada todos los ámbitos necesarios. También puede agregar ámbitos adicionales. Para obtener una lista de los ámbitos obligatorios, consulte Requisitos de administrador para los clientes integrados de Genesys Cloud. Para obtener información sobre ámbitos, consulte OAuth Scopes (Genesys Cloud Developer Center).
- Haga clic en Guardar. Genesys Cloud crea un ID de Cliente y un Secreto de Cliente.
- Proporcione el ID de cliente a los desarrolladores. A continuación, los desarrolladores deben añadir el ID de cliente a clientIds en el archivo framework.js. Para obtener más información, consulte clientIds (Genesys Cloud Developer Center).
Para obtener más información sobre la integración, consulte Acerca del marco integrable de Genesys Cloud.
- OAuth > Cliente > Agregar permiso
- Función de integración SCIM asignada a su usuario
- Si la Integración SCIM no aparece, restaure los roles predeterminados en su organización Genesys Cloud. Utilice API Explorer para realizar una llamada API a POST / api / v2 / autorización / roles / default. Para más información, ver Inicio rápido de herramientas para desarrolladores (Centro de desarrolladores de Genesys Cloud). Para acceder al Explorador de API, vaya a https://developer.genesys.cloud/developer-tools/#/api-explorer.
To use Genesys Cloud SCIM (Identity Management), create a Genesys Cloud OAuth client. The OAuth client generates a Client ID and Client Secret that you add to your identity management system.
- Hacer clic Administración.
- En Integraciones, haga clic en OAuth.
- Click Menu > IT and Integrations > OAuth.
- Hacer clic Agregar cliente. Aparece la pestaña Detalles del cliente.
- Configure App Name con un nombre descriptivo de la aplicación. El App Name es el nombre que se muestra cuando alguien autoriza a este cliente OAuth. Para más información, consulte Autorizar un cliente OAuth.
- (Opcional) Escriba una breve descripción de la aplicación en el Descripción caja.
- Establecer Token Duración. 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: Solo puede establecer el máximo en 38,880,000 segundos si usa el rol de Integración SCIM o un rol personalizado que tenga exactamente los mismos permisos.
- Debajo Tipos de subvenciones, Seleccione Credenciales de cliente.
- Haga clic en el Roles pestaña y asignar la Integración SCIM papel.
Importante:- 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 asigna otros roles o permisos, Duración del token que configuró en el paso 6 vuelve al valor predeterminado de 86.400 segundos.
- Incluya todas las divisiones que administrará con SCIM.
- Click Save. Genesys Cloud creates a Client ID and a Client Secret. Use these identifiers in the configuration of your identity management system.
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).