Einen OAuth-Client erstellen

Voraussetzungen
  • OAuth > Client > Berechtigung hinzufügen

OAuth-Clients ermöglichen es Ihnen, Anfragen an die Plattform-API zu stellen, sich gegenüber Genesys Cloud zu authentifizieren oder Entitäten zwischen Genesys Cloud und Systemen Dritter zu synchronisieren.

Dieses Verfahren ist für Anbieter von Anwendungen gedacht, die ein Token erhalten möchten, mit dem sie Anfragen an die Genesys Cloud Platform API stellen können Das Token steht für die Erlaubnis des Benutzers, dass die App auf Genesys Cloud-Daten zugreifen darf. Sie wird verwendet, wenn die Anwendung eine Anfrage an einen API-Endpunkt autorisieren muss. Eine Liste der Genesys Cloud Platform APIs finden Sie unter API resources im Genesys Cloud Developer Center

  1. Klicken Sie auf Admin.
  2. Unter Integrationen, klicken Sie auf OAuth.
  3. Klicken Sie auf Client hinzufügen. Die Registerkarte Kundendetails wird angezeigt.

  4. Setzen Sie App Name auf einen beschreibenden Namen der App. Dieser Name wird angezeigt, wenn jemand diesen OAuth-Client autorisiert.
  5. (Optional) Geben Sie eine kurze Beschreibung der App in das Feld Beschreibung ein
  6. Legen Sie dann die Zeitspanne fest, nach der die mit diesem Client erstellten Token ablaufen. Übernehmen Sie die Standarddauer, oder geben Sie einen Wert zwischen 300 und 172800 Sekunden ein. Dadurch wird die Lebensdauer des Tokens auf maximal 2 Tage oder weniger festgelegt.
    Hinweis: Wenn die HIPAA-Compliance für Ihre Organisation aktiviert ist, erzwingt Genesys Cloud eine Leerlaufzeit von 15 Minuten. Diese Leerlaufzeit gilt auch für Token, die von OAuth-Clients ausgegeben werden. Weitere Informationen finden Sie unter HIPAA compliance.
  7. Treffen Sie eine Auswahl unter Zuschussarten. Grant Types legen fest, wie eine Anwendung ein Zugriffstoken erhält. Genesys Cloud unterstützt die unten aufgeführten OAuth 2 Autorisierungsarten. Wenn Sie auf den Namen eines Grant-Typs klicken, werden weitere Informationen über diesen Grant-Typ unter im Genesys Cloud Developer Center angezeigt

    • Client Credentials Grant: Ein einstufiges Authentifizierungsverfahren, das ausschließlich von Nicht-Benutzer-Anwendungen (z. B. einem Windows-Dienst oder Cron-Job) verwendet wird. Die Client-Anwendung stellt OAuth-Client-Anmeldedaten im Austausch für ein Zugriffstoken zur Verfügung. Dieser Berechtigungstyp steht nicht im Kontext eines Benutzers und kann daher nicht auf benutzerspezifische APIs (z. B. GET /v2/users/me) zugreifen.

      Wenn Sie Rollen für Genesys Cloud for Salesforce zuweisen, siehe auch OAuth-Client-Berechtigungen für Genesys Cloud for Salesforce.

    • Code Autorisierung Erteilung: Ein zweistufiger Authentifizierungsprozess, bei dem sich ein Benutzer bei Genesys Cloud authentifiziert und die Client-Anwendung dann einen Autorisierungscode zurückerhält. Die Client-Anwendung stellt OAuth-Client-Anmeldedaten bereit und verwendet den Autorisierungscode, um ein Zugriffstoken zu erhalten. Das Zugriffstoken kann dann bei authentifizierten API-Aufrufen verwendet werden. Dies ist die sicherste Option und ideal für Websites, bei denen API-Anfragen serverseitig gestellt werden (z. B. ASP.NET oder PHP), sowie für einige Desktop-Anwendungen, bei denen ein Thin-Client den Benutzer autorisiert und den Autorisierungscode an einen Back-End-Server weitergibt, um ihn gegen ein Autorisierungs-Token auszutauschen und API-Anfragen zu stellen.

    • Token-implizite Erteilung (Browser) Ein einstufiger Authentifizierungsprozess, bei dem sich ein Benutzer bei Genesys Cloud authentifiziert und die Client-Anwendung direkt ein Zugriffstoken erhält. Diese Option bietet weniger Sicherheit für das Zugriffstoken als die Gewährung des Autorisierungscodes, ist aber ideal für clientseitige Browseranwendungen (d. h. JavaScript) und die meisten Desktopanwendungen (z. B. .NET WPF/WinForms oder Java-Desktopprogramme).

    • SAML2 Bearer Ein Authentifizierungsprozess, bei dem eine Client-Anwendung eine SAML2-Assertion (Security Assertion Markup Language) verwenden kann, um ein Überbringer-Token anzufordern. Siehe auch: Genesys Cloud Single Sign-On und Identity Provider Lösung.

      Hinweis: Eine einzige Code-Autorisierung oder Implizite Erteilungsart kann in allen Regionen verwendet werden.

  8. Geben Sie die für die Förderungsart erforderlichen Parameter ein.

    • Rollen: Wenn Sie Client Credentialsgewählt haben, klicken Sie auf die Registerkarte Roles Es öffnet sich eine Liste von Rollen, aus der Sie wählen können. Weisen Sie eine Mindestanzahl von Rollen zu, um festzulegen, was Ihre OAuth-Client-Integration tun kann.

      Hinweis: Um einem OAuth-Client Rollen zu gewähren, müssen Sie diese Rollen Ihrem Profil zugewiesen haben.

      Außerdem müssen Sie jede Rolle mit einer Abteilungverknüpfen. Legen Sie fest, welche Abteilungen mit den Rollen für die Client Credential Grant verbunden werden sollen. Alle Client Credential Grant-Rollen sind standardmäßig auf die Hauptabteilung beschränkt. Aktualisierung mit den entsprechenden Abteilungen, damit die Anwendungen und Systeme, die diese Zuschüsse verwenden, auf die entsprechenden Daten zugreifen können. Wenn ein Client Credential Grant von einem Dritten zur Verfügung gestellt wird, überprüfen Sie mit dem Dritten, um die Verwendung des Grant zu verstehen und aktualisieren Sie die Abteilungen für die Rollen dementsprechend. Andere Arten von Förderungen sind von der Zugriffskontrolle nicht betroffen.

    • Zugelassene Umleitungs-URIs (eine pro Zeile, bis zu 125): Dies sind die URIs, an die der Autorisierungscode gesendet wird, um gegen ein Zugriffstoken ausgetauscht zu werden, das später zur Authentifizierung nachfolgender API-Aufrufe verwendet wird.

    • Umfänge Alle Berechtigungstypen außer Client Credentials haben eine Einstellung für den Geltungsbereich. Klicken Sie auf das Feld Geltungsbereich, um eine Liste der für Ihre Anwendung verfügbaren Geltungsbereiche anzuzeigen. Wählen Sie am besten nur die Mindestumfänge aus, die Ihre Anwendung benötigt. Informationen über Bereiche finden Sie unter OAuth Scopes im Developer Center 

  9. Klicken Sie auf Speichern. Genesys Cloud erstellt eine Client ID und ein Client Secret (Token).

Ihr Genesys Cloud OAuth-Client ist nun einsatzbereit.

Voraussetzungen
  • OAuth > Client > Berechtigung hinzufügen

Wenn eine der beiden Situationen zutrifft, erstellen Sie einen OAuth-Client für Genesys Cloud Embeddable Framework:

  • Sie implementieren eine öffentliche Bereitstellung.
  • Sie implementieren eine private Bereitstellung, die auf die Methode getAuthToken in Ihrer framework.js-Datei zugreift Für weitere Informationen siehe User.getAuthToken (Genesys Cloud Developer Center)

Ein OAuth-Client erzeugt eine Client-ID, die Entwickler für die clientIds in der Datei framework.js verwenden können Für weitere Informationen siehe clientIds (Genesys Cloud Developer Center)

  1. Klicken Sie auf Admin.
  2. Unter Integrationen, klicken Sie auf OAuth.
  3. Klicken Sie auf Client hinzufügen. Die Registerkarte Kundendetails wird angezeigt.

    Registerkarte Kundendetails für OAuth-Client

  4. Setzen Sie App Name auf einen beschreibenden Namen der App

    App Name ist der Name, der angezeigt wird, wenn jemand diesen OAuth-Client autorisiert. Weitere Informationen finden Sie unter Autorisieren eines OAuth-Clients.

  5. (Optional) Geben Sie eine kurze Beschreibung der App in das Feld Beschreibung ein
  6. Legen Sie die Zeitspanne fest, bis die mit diesem Client erstellten Token ablaufen.

    Übernehmen Sie die Standarddauer, oder geben Sie einen Wert zwischen 300 und 172800 Sekunden ein. Mit dieser Dauer wird die Lebensdauer des Tokens auf maximal zwei Tage oder weniger festgelegt.

    Tipp: Genesys empfiehlt, dass Sie die Token-Dauer auf 18 Stunden (64800 Sekunden) einstellen. Diese Zeitspanne führt in der Regel dazu, dass der Token außerhalb des normalen Arbeitstages eines Agenten abläuft.

  7. Unter Grant Types, wählen Sie Implicit Grant (Browser).

    Weitere Informationen finden Sie unter Autorisierung (Genesys Cloud Developer Center) und Gewährung - Implizit (Genesys Cloud Developer Center).

  8. Unter Authorized redirect URIs, fügen Sie https://apps.mypurecloud.com/crm/index.htmlhinzu, angepasst an Ihre Genesys Cloud Region.

    Notizen:
    • Verwenden Sie die AWS-Region entsprechend Ihrer Bereitstellung
    • Wenn Sie dedicatedLoginWindow in Ihrer framework.js-Datei auf true setzen, fügen Sie auch https://apps.mypurecloud.com/crm/authWindow.html unter Authorized redirect URIshinzu. Weitere Informationen finden Sie unter dedicatedLoginWindow unter settings (Genesys Cloud Developer Center).
    • Nachdem Genesys Ihr öffentliches Deployment veröffentlicht hat, erhalten Sie von Genesys eine neue URI, die Sie verwenden können.
  9. Fügen Sie unter Scopealle erforderlichen Scopes hinzu. Sie können auch zusätzliche Geltungsbereiche hinzufügen.

    Eine Liste der erforderlichen Bereiche finden Sie unter Administratoranforderungen für die Genesys Cloud Embedded Clients. Informationen über Bereiche finden Sie unter OAuth Scopes (Genesys Cloud Developer Center)

  10. Klicken Sie auf Speichern.

    Genesys Cloud erstellt eine Client ID und ein Client Secret.

  11. Geben Sie den Entwicklern die Client ID.

    Die Entwickler müssen die Client-ID zu clientIds in der Datei framework.js hinzufügen Für weitere Informationen siehe clientIds (Genesys Cloud Developer Center)

Weitere Informationen über die Integration finden Sie unter About Genesys Cloud Embeddable Framework.

Voraussetzungen
  • OAuth > Client > Berechtigung hinzufügen
  • SCIM-Integrationsrolle, die Ihrem Benutzer zugewiesen wurde

    Wenn die SCIM-Integration nicht angezeigt wird, stellen Sie die Standardrollen für Ihre Genesys Cloud Organisation wieder her. Verwenden Sie API Explorer, um einen API-Aufruf an POST /api/v2/authorization/roles/defaultdurchzuführen. Weitere Informationen finden Sie unter Developer tools quick start (Genesys Cloud Developer Center) Um auf den API Explorer zuzugreifen, gehen Sie zu https://developer.genesys.cloud/developer-tools/#/api-explorer.

Um Genesys Cloud SCIM (Identity Management) zu nutzen, erstellen Sie einen Genesys Cloud OAuth Client. Der OAuth-Client generiert eine Client-ID und ein Client-Geheimnis, die Sie zu Ihrem Identitätsmanagementsystem hinzufügen.

  1. Klicken Sie auf Admin.
  2. Unter Integrationen, klicken Sie auf OAuth.
  3. Klicken Sie auf Client hinzufügen. Die Registerkarte Kundendetails wird angezeigt.
  4. Setzen Sie App Name auf einen beschreibenden Namen der App

    App Name ist der Name, der angezeigt wird, wenn jemand diesen OAuth-Client autorisiert. Weitere Informationen finden Sie unter Autorisieren eines OAuth-Clients.

  5. (Optional) Geben Sie eine kurze Beschreibung der App in das Feld Beschreibung ein
  6. Token Dauereinstellen. 

    Token Duration ist die Zeitspanne, bis die mit diesem Client erstellten Token ablaufen. Akzeptieren Sie die Standarddauer von 86.400 oder geben Sie einen Wert zwischen 300 und 38.880.000 Sekunden ein. Damit wird die Lebensdauer des Tokens auf maximal 450 Tage festgelegt.

    Hinweis: Sie können den Höchstwert nur dann auf 38.880.000 Sekunden festlegen, wenn Sie die SCIM-Integrationsrolle oder eine benutzerdefinierte Rolle verwenden, die über genau dieselben Berechtigungen verfügt.

  7. Unter Grant Types, wählen Sie Client Credentials.
  8. Klicken Sie auf die Registerkarte Rollen und weisen Sie die Rolle SCIM Integration zu. 
    Wichtig:
    • Um Ihrem OAuth-Client diese Rolle zu gewähren, muss diese Rolle Ihrem Profil zugewiesen sein.
    • Weisen Sie Ihrem OAuth-Client keine anderen Rollen oder der SCIM-Integrationsrolle keine anderen Berechtigungen zu. Wenn Sie andere Rollen oder Berechtigungen zuweisen, wird Token Duration , die Sie in Schritt 6 festgelegt haben, auf den Standardwert von 86.400 Sekunden zurückgesetzt
    • Geben Sie alle Abteilungen an, die Sie mit SCIM verwalten werden.
  9. Klicken Sie auf Speichern.

    Genesys Cloud erstellt eine Client ID und ein Client Secret. Verwenden Sie diese Bezeichner in der Konfiguration Ihres Identitätsmanagementsystems.

Informationen über Genesys Cloud SCIM (Identity Management) finden Sie unter Über Genesys Cloud SCIM (Identity Management) und Genesys Cloud SCIM (Identity Management) Übersicht (Genesys Cloud Developer Center).