Créer un client OAuth

Conditions préalables
  • Oauth > client > ajouter autorisation

Clients OAuth vous permettent de faire des demandes de l’API ou la plate - forme pour l’authentification à l’PureCloud, ou à des entités de synchronisation entre PureCloud et troisième participant systèmes.

Cette procédure est destinée aux fournisseurs d'applications qui souhaitent que leur application reçoive un jeton lui permettant d'effectuer des requêtes auprès de la plateforme Genesys Cloud API. Le jeton représente l'autorisation de l'utilisateur pour que l'application accède aux données de Genesys Cloud et est utilisé lorsque l'application doit autoriser une demande à un point de terminaison de l'API. Pour obtenir une liste des API de Genesys Cloud Platform, consultez le site API resources dans le Genesys Cloud Developer Center. 

  1. Cliquez sur Admin. 
  2. Sous Intégrations, cliquez sur OAuth.
  3. Cliquez sur Menu > IT et intégrations > OAuth.
  4. Dans la page OAuth, cliquez sur Ajouter un client. La page Ajouter un nouveau client s'affiche.
  5. Dans le champ App Name, saisissez le nom de l'application.
  6. (Facultatif) Dans le champ Description, saisissez la description.
  7. Dans le champ Grant Types, sélectionnez un type de subvention. Les types de subventions définissent la manière dont une application obtient un jeton d'accès. Genesys Cloud prend en charge les types d'octroi d'autorisation OAuth 2 répertoriés ci-dessous. En cliquant sur le nom d'un type de subvention, vous obtiendrez plus d'informations à son sujet dans le Genesys Cloud Developer Center.
    • Octroi des informations d'identification du client: Processus d'authentification en une seule étape utilisé exclusivement par des applications non-utilisateurs (par exemple un service Windows ou une tâche cron). Le application client fournit les informations d’identification du client OAuth en échange d’un jeton d’accès. Ce type d'autorisation n'est pas dans le contexte d'un utilisateur et ne peut donc pas accéder aux API spécifiques à l'utilisateur (par exemple, GET /v2/users/me). Si vous attribuez des rôles à Genesys Cloud pour Salesforce, consultez également Autorisations du client OAuth pour Genesys Cloud pour Salesforce.
    • Code Autorisation Subvention: Un processus authentification en deux utilisateur étapes où un application authentifiatse avec PureCloud , puis le client est retourné un code d’autorisation. Le application client fournit les informations d’identification du client OAuth et utilise le code d’autorisation pour obtenir un jeton d’accès. Le jeton d’accès peut ensuite être utilisé lors d’appels d’API authentifiés. Cette option est la plus sûre et idéale pour les sites web où les demandes d'API sont effectuées côté serveur (par exemple, ASP.NET ou PHP) et pour certaines applications de bureau où un client léger autorise l'utilisateur et transmet le code d'authentification à un serveur dorsal en échange d'un jeton d'authentification et pour effectuer des demandes d'API.
    • Subvention implicite (navigateur): Un processus d’authentification une seule étape où un utilisateur s’authentifie avec Genesys Cloud et l’application cliente reçoit directement un jeton d’accès. Cette option offre moins de sécurité pour le jeton d'accès que l'octroi d'un code d'autorisation, mais elle est idéale pour les applications de navigateur côté client (par exemple, JavaScript) et la plupart des applications de bureau (par exemple, .NET WPF/WinForms ou les programmes de bureau Java).
    • Porteur SAML2: Processus d'authentification dans lequel une application client peut utiliser une assertion SAML2 (Security Assertion Markup Language) pour demander un jeton de porteur. Pour plus d'informations, voir Genesys Cloud single sign-on and identity provider solution.
      Remarque :  Un seul type d'autorisation de code ou de subvention implicite peut être utilisé dans toutes les régions.
  8. Cliquez sur Suivant.
  9. Dans le tableau Attribuer des rôles, dans la colonne Assigné, activez la bascule disponible pour chaque rôle. Cette action ouvre une liste de rôles à choisir. Attribuez un ensemble minimum de rôles pour déterminer ce que votre intégration client OAuth peut faire.
    Remarque :  Pour accorder ce rôle à votre client OAuth, vous devez avoir ce rôle attribué à votre profil.
    Vous devez également rôle associer chacun à une division. Déterminez les divisions que vous souhaitez associer à des rôles pour l'octroi de justificatifs de client. Tous les rôles de subvention d’accréditation par défaut du client sont portées à la division d’accueil par. Mettre à jour avec les divisions appropriées afin que les applications et les systèmes qui utilisent ces subventions puissent accéder aux données appropriées. Si une habilitation de client est fournie par un tiers, vérifiez auprès de ce dernier l'utilisation de l'habilitation et mettez à jour les divisions pour les rôles de manière appropriée. Aucun autre type de subvention n'est affecté par le contrôle d'accès.
    • URI de redirection autorisés (un par ligne, jusqu'à 125): Le code d'autorisation est envoyé à ces URI et est échangé contre un jeton d'accès à utiliser ultérieurement pour authentifier les appels ultérieurs à l'API.
    • Champ d'application: Tous les types de subventions, à l’exception des informations d’identification des clients, ont un paramètre De scope. Cliquez sur la case Scope et affichez la liste des scopes disponibles pour votre application. En tant que meilleure pratique, sélectionnez uniquement les portées minimales dont votre application a besoin. Pour plus d'informations sur les champs d'application, voir OAuth Scopes dans le Developer Center. 
  10. Cliquez sur Suivant.
  11. Dans le champ Token Duration in seconds, entrez la durée requise pour le jeton. Définissez le délai d’expiration des jetons créés avec ce client. Acceptez par défaut la durée, ou entrez une valeur comprise entre 300 et 172800 secondes. Cela fixe la durée de vie du jeton à un maximum de deux jours ou moins.
    Remarque : Lorsque la conformité HIPAA est activée pour votre organisation, Genesys Cloud applique un délai d'inactivité de 15 minutes et ce délai d'inactivité est également applicable aux jetons émis par les clients OAuth. Pour plus d’informations, voir Conformité HIPAA.
  12. Cliquez sur Enregistrer. Un message confirme que le client a été créé. 
  13. Dans la page Ajouter un nouveau client, la section Secret du client s'affiche. Le champ Secret du client affiche une chaîne secrète que l'application utilise pour prouver son identité lorsque l'utilisateur demande un jeton. Ce secret peut également être appelé le mot de passe de l'application.
    Note: Vous ne pouvez consulter ce secret qu'une seule fois au moment de la configuration.
    Vous pouvez effectuer les actions suivantes dans ce champ :
    • Pour afficher les détails du mot de passe, cliquez sur Show .
    • Pour copier le mot de passe, cliquez sur Copy .
    • Pour générer un nouveau code secret, cliquez sur Generate new secret. La boîte de dialogue Generate New Client Secret ? s'affiche.
      • Cliquez sur Confirmer.
      • Un message confirme que le mot de passe a été modifié.  
  14. Cliquez sur Finish. La boîte de dialogue Copier et enregistrer le secret du client s'affiche.
  15. Cliquez sur Confirmez. L'application que vous venez de créer apparaît avec la section suivante au bas de la page.
    • Créé par: Affiche le nom de l'utilisateur qui a créé le client.
    • Date: Affiche la date de création du nouveau client.
    • Modifié par: Affiche le nom de l'utilisateur qui a modifié les détails du client.
    • Date: Affiche la date de modification du client.

    Votre client Genesys Cloud OAuth est maintenant prêt à être utilisé. 

    Conditions préalables
    • Oauth > client > ajouter autorisation

    Si l’une ou l’autre situation s’applique, créez un client OAuth pour Genesys Cloud Embeddable Framework :

    • Vous souhaitez mettre en œuvre un déploiement public.
    • Vous souhaitez mettre en œuvre un déploiement privé qui accède à la méthode getAuthToken dans votre fichier framework.js. Pour plus d'informations, voir User.getAuthToken dans le Genesys Cloud Developer Center.

    Un client OAuth génère un identifiant de client que les développeurs peuvent utiliser pour clientIds dans le fichier framework.js. Pour plus d'informations, voir clientIds dans le Genesys Cloud Developer Center.

    1. Cliquez sur Admin. 
    2. Sous Intégrations, cliquez sur OAuth.
    3. Cliquez sur Menu > IT et intégrations > OAuth.
    4. Cliquez sur Ajouter un client. La page Ajouter un nouveau client s'affiche.
    5. Dans le champ App Name, saisissez le nom de l'application.
    6. (Facultatif) Dans le champ Description, saisissez la description.
    7. Dans le champ Grant Types, sélectionnez Token Implicit Grant (Browser). Pour plus d'informations, voir Authorization et Grant - Implicit  dans le Developer Center.
    8. Cliquez sur Suivant.
    9. Dans le champ Token Duration in seconds, entrez la durée requise pour le jeton. Acceptez par défaut la durée, ou entrez une valeur comprise entre 300 et 172800 secondes. Cette durée fixe la durée de vie du jeton à un maximum de deux jours ou moins.
      Note: Genesys recommande de fixer la durée du jeton à 18 heures (64 800 secondes). Cette durée entraîne généralement l'expiration du jeton en dehors de la journée de travail normale de l'agent.
    10. Dans la case Redirect URIs autorisés (un par ligne), ajoutez https://apps.mypurecloud.com/crm/index.html, personnalisé en fonction de votre région Genesys Cloud.
      Remarques:
      • Utilisez le Région AWS selon votre déploiement.
      • Si vous avez défini dedicatedLoginWindow à true dans votre fichier framework.js, ajoutez également https://apps.mypurecloud.com/crm/authWindow.html sous Redirection autorisée des URI. Pour plus d'informations, voir dedicatedLoginWindow sous settings dans le Developer Center.
      • Une fois que Genesys a publié votre déploiement public, Genesys vous fournira un nouvel URI à utiliser.
    11. Dans le champ Champ d'application, sélectionnez les champs d'application requis. Vous pouvez également ajouter d'autres champs d'application. Pour obtenir la liste des étendues requises, consultez Exigences d’administrateur pour les clients embarqués Genesys Cloud. Pour plus d'informations sur les champs d'application, voir OAuth Scopes dans le Developer Center.
    12. Cliquez sur Enregistrer. Dans la page Ajouter un nouveau client, la section Secret du client s'affiche. Le champ Secret du client affiche une chaîne secrète que l'application utilise pour prouver son identité lorsque l'utilisateur demande un jeton. Ce secret peut également être appelé le mot de passe de l'application.
      Note: Vous ne pouvez consulter ce secret qu'une seule fois au moment de la configuration.
      Vous pouvez effectuer les actions suivantes dans ce champ :
      • Pour afficher les détails du mot de passe, cliquez sur Show .
      • Pour copier le mot de passe, cliquez sur Copy .
      • Pour générer un nouveau code secret, cliquez sur Generate new secret. La boîte de dialogue Generate New Client Secret ? s'affiche
        • La boîte de dialogue Generate New Client Secret ? s'affiche. Cliquez sur Confirmez.
        • Un message confirme que le mot de passe a été modifié.  
    13. Cliquez sur Terminer. 
    14. La boîte de dialogue Copier et enregistrer le secret du client s'affiche. Pour confirmer que vous avez copié et enregistré le mot de passe, cochez la case. Si vous continuez, vous ne pourrez plus consulter ce mot de passe. 
    15. Cliquez sur Confirmez. L'application que vous venez de créer apparaît avec la section suivante au bas de la page.
        • Créé par: Affiche le nom de l'utilisateur qui a créé le client.
        • Date: Affiche la date de création du nouveau client.
        • Modifié par: Affiche le nom de l'utilisateur qui a modifié les détails du client.
        • Date: Affiche la date de modification du client.

      Fournir l'identifiant du client aux développeurs, qui l'ajouteront à clientIds dans le fichier framework.js. Pour plus d'informations, voir clientIds dans le Developer Center.

      Pour plus d’informations sur l’intégration, consultez À propos de Genesys Cloud Embeddable Framework.

      Conditions préalables
      • Oauth > client > ajouter autorisation
      • Rôle d'intégration SCIM attribué à votre utilisateur
      • Si l'intégration SCIM n'apparaît pas, rétablissez les rôles par défaut dans votre organisation Genesys Cloud. Utilisez l’API Explorer pour effectuer un appel d’API à POST / api / v2 / autorisation / rôles / par défaut. Pour plus d’informations, consultez Démarrage rapide des outils de développement dans le Developer Center. Accédez à API Explorer dans le centre de développement.

      Pour utiliser Genesys Cloud SCIM (Identity Management), créez un client Genesys Cloud OAuth. Le client OAuth génère un identifiant et un secret client que vous ajoutez à votre système de gestion des identités. 

      1. Cliquez sur Admin. 
      2. Sous Intégrations, cliquez sur OAuth.
      3. Cliquez sur Menu > IT et intégrations > OAuth.
      4. Cliquez sur Ajouter un client. La page Ajouter un nouveau client s'affiche.
      5. Dans le champ App Name, saisissez le nom de l'application.
      6. (Facultatif) Dans le champ Description, saisissez la description.
      7. Dans le champ Grant Types, sélectionnez Client Credentials. Pour plus d'informations sur chaque subvention, voir l'étape 8 de l'onglet API de la plateforme.
      8. Cliquez sur Suivant.
      9. Dans le tableau Attribuer des rôles, dans la colonne Assigné, attribuez le rôle d'intégration SCIM.
        Note: Pour accorder ce rôle à votre client OAuth, vous devez avoir ce rôle attribué à votre profil. N’attribuez pas d’autres rôles à votre client OAuth ou d’autres autorisations au rôle intégration SCIM. Si vous n'attribuez pas d'autres rôles ou autorisations, la valeur que vous avez définie dans le champ Token Duration in seconds revient à la valeur par défaut de 86 400 secondes. Indiquez également toutes les divisions que vous gérerez à l'aide du SCIM.
      10. Cliquez sur Suivant.
      11. Dans le champ Token Duration in seconds, entrez la durée requise pour le jeton. La durée du jeton est la durée qui s'écoule avant que les jetons créés avec ce client n'expirent. Acceptez la durée par défaut de 86 400 ou entrez une valeur comprise entre 300 et 38 880 000 secondes. La durée de vie du jeton est ainsi fixée à 450 jours maximum.
        Note: Vous ne pouvez fixer la durée maximale à 38 880 000 secondes que si vous utilisez le rôle Intégration SCIM ou un rôle personnalisé disposant des mêmes autorisations.
      12. Cliquez sur Enregistrer. Un message confirme que le client a été créé. Dans la page Ajouter un nouveau client, la section Secret du client s'affiche. Le champ Secret du client affiche une chaîne secrète que l'application utilise pour prouver son identité lorsque l'utilisateur demande un jeton. Ce secret peut également être appelé le mot de passe de l'application.
        Note: Vous ne pouvez consulter ce secret qu'une seule fois au moment de la configuration.
        Vous pouvez effectuer les actions suivantes dans ce champ :
        • Pour afficher les détails du mot de passe, cliquez sur Show .
        • Pour copier le mot de passe, cliquez sur Copy .
        • Pour générer un nouveau code secret, cliquez sur Generate new secret. La boîte de dialogue Generate New Client Secret ? s'affiche
          • La boîte de dialogue Generate New Client Secret ? s'affiche. Cliquez sur Confirmez.
          • Un message confirme que le mot de passe a été modifié.  
      13. Cliquez sur Terminer. 
      14. La boîte de dialogue Copier et enregistrer le secret du client s'affiche. Pour confirmer que vous avez copié et enregistré le mot de passe, cochez la case. Si vous continuez, vous ne pourrez plus consulter ce mot de passe. 
      15. Cliquez sur Confirmez. L'application que vous venez de créer apparaît avec la section suivante au bas de la page.
        • Créé par: Affiche le nom de l'utilisateur qui a créé le client.
        • Date: Affiche la date de création du nouveau client.
        • Modifié par: Affiche le nom de l'utilisateur qui a modifié les détails du client.
        • Date: Affiche la date de modification du client.

      Vous pouvez également effectuer les actions suivantes sur cette page :

      • Modifiez les détails du client en cliquant sur le bouton Edit Client.
      • Supprimez le client créé en cliquant sur le bouton Delete Client.

      Pour plus d’informations sur Genesys Cloud SCIM (Identity Management), consultez À propos de Genesys Cloud SCIM (Identity Management)et Genesys Cloud SCIM (Identity Management) aperçu (Centre de développement Genesys Cloud ).