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 Anwendungsanbieter gedacht, die möchten, dass ihre App ein Token erhält, mit dem sie Anfragen an die Genesys Cloud stellen kann. Plattform API. Das Token stellt die Berechtigung eines Benutzers für die App dar, auf Genesys Cloud-Daten zuzugreifen, und wird verwendet, wenn die App eine Anfrage an einen API-Endpunkt autorisieren muss. Eine Liste der Genesys Cloud Platform-APIs finden Sie im API-Ressourcen im Genesys Cloud Developer Center. 

  1. Klicken Sie auf Admin.
  2. Klicken Sie unter Integrationen auf OAuth .
  3. Klicken Speisekarte > IT und Integrationen > OAuth .
  4. Klicken Sie auf der OAuth-Seite auf Client hinzufügen . Die Seite „Neuen Client hinzufügen“ wird angezeigt.
  5. Im App-Name Geben Sie in das Feld den Namen der Anwendung ein.
  6. (Optional) Im Beschreibung Geben Sie im Feld „Beschreibung“ die Beschreibung ein.
  7. Im Zuschussarten Wählen Sie im Feld einen Typ für die Gewährung aus. Berechtigungstypen 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 Berechtigungstyps klicken, werden weitere Informationen dazu vom Genesys Cloud Developer Center angezeigt.
    • Gewährung von Client-Anmeldeinformationen : Ein einstufiger Authentifizierungsprozess, der ausschließlich von Nicht-Benutzeranwendungen verwendet wird (z. B. ein Windows-Dienst oder ein Cron-Job). Die Client-Anwendung stellt OAuth-Client-Anmeldedaten im Austausch für ein Zugriffstoken zur Verfügung. Dieser Autorisierungstyp steht nicht im Kontext eines Benutzers und kann daher nicht auf benutzerspezifische APIs zugreifen (z. B. GET /v2/users/me). Informationen zum Zuweisen von Rollen für Genesys Cloud für Salesforce finden Sie auch unter OAuth-Clientberechtigungen für Genesys Cloud für Salesforce .
    • Code-Autorisierungsgewährung : 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. Diese Option ist die sicherste und ideal für Websites, bei denen API-Anfragen serverseitig gestellt werden (z. B. ASP.NET oder PHP), und einige Desktop-Anwendungen, bei denen ein Thin Client den Benutzer autorisiert und den Authentifizierungscode an einen Back-End-Server weiterleitet, um ihn gegen ein Authentifizierungstoken auszutauschen und API-Anfragen zu stellen.
    • Implizite Gewährung (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 eines Autorisierungscodes, ist jedoch ideal für clientseitige Browseranwendungen (z. B. JavaScript) und die meisten Desktopanwendungen (z. B. .NET WPF/WinForms oder Java-Desktopprogramme).
    • SAML2-Träger : Ein Authentifizierungsprozess, bei dem eine Clientanwendung eine SAML2-Assertion (Security Assertion Markup Language) verwenden kann, um ein Inhabertoken anzufordern. Weitere Informationen finden Sie unter Genesys Cloud Single Sign-On- und Identitätsanbieterlösung .
      Hinweis: Eine einzige Code-Autorisierung oder Implizite Erteilungsart kann in allen Regionen verwendet werden.
  8. Klicken Sie auf Weiter.
  9. Aktivieren Sie in der Tabelle „Rollen zuweisen“ in der Spalte „Zugewiesen“ den für jede Rolle verfügbaren Umschalter. Diese Aktion öffnet eine Liste mit Rollen zur Auswahl. Weisen Sie einen Mindestsatz an Rollen zu, um zu bestimmen, was Ihre OAuth-Clientintegration leisten 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. Bestimmen Sie, welchen Abteilungen Sie Rollen für die Client-Anmeldeinformationszuweisung zuordnen möchten. Alle Client Credential Grant-Rollen sind standardmäßig auf die Hauptabteilung beschränkt. Aktualisieren Sie die entsprechenden Abteilungen, damit die Anwendungen und Systeme, die diese Zuschüsse verwenden, auf die entsprechenden Daten zugreifen können. Wenn die Berechtigung für Clientanmeldeinformationen von einem Drittanbieter bereitgestellt wird, wenden Sie sich an den Drittanbieter, um die Verwendung der Berechtigung zu verstehen und die Aufteilungen für die Rollen entsprechend zu aktualisieren. Andere Berechtigungstypen sind von der Zugriffskontrolle nicht betroffen.
    • Autorisierte Umleitungs-URIs (eine pro Zeile, bis zu 125) : Der Autorisierungscode wird an diese URIs gesendet und gegen ein Zugriffstoken ausgetauscht, das später zur Authentifizierung nachfolgender API-Aufrufe verwendet werden kann.
    • Umfang : Alle Berechtigungstypen außer Client Credentials haben eine Einstellung für den Geltungsbereich. Klicken Sie auf das Feld „Bereich“, um eine Liste der für Ihre App verfügbaren Bereiche anzuzeigen. Wählen Sie als bewährte Methode nur die Mindestbereiche aus, die Ihre App benötigt. Weitere Informationen zu Bereichen finden Sie unter OAuth-Bereiche im Entwicklercenter. 
  10. Klicken Sie auf Weiter.
  11. Im Token-Dauer in Sekunden Geben Sie im Feld die gewünschte Dauer für das Token ein. 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. Dadurch wird die Lebensdauer des Tokens auf maximal zwei 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.
  12. Klicken Speichern . Eine Meldung bestätigt, dass der Client erstellt wurde. 
  13. Auf der Seite „Neuen Client hinzufügen“ wird der Abschnitt „Client Secret“ angezeigt. Das Feld „Client Secret“ zeigt eine geheime Zeichenfolge an, die die Anwendung zum Nachweis ihrer Identität verwendet, wenn der Benutzer ein Token anfordert. Dieses Geheimnis kann auch als Anwendungskennwort bezeichnet werden.
    Notiz : Sie können dieses Geheimnis nur einmal zum Zeitpunkt der Einrichtung anzeigen.
    In diesem Feld können Sie folgende Aktionen ausführen:
    • Um Details zum Passwort anzuzeigen, klicken Sie auf Zeigen .
    • Um das Passwort zu kopieren, klicken Sie auf Kopie .
    • Um einen neuen Geheimcode zu generieren, klicken Sie auf Neues Geheimnis generieren . Das Dialogfeld „Neuen geheimen Clientschlüssel generieren?“ wird angezeigt.
      • Klicken Sie auf Bestätigen Sie.
      • Eine Meldung bestätigt, dass das Passwort geändert wurde.  
  14. Klicken Beenden . Das Dialogfeld „Client-Geheimnis kopieren und speichern“ wird angezeigt.
  15. Klicken Bestätigen . Die App, die Sie gerade erstellt haben, wird mit dem folgenden Abschnitt unten auf der Seite angezeigt.
    • Erstellt von : Zeigt den Namen des Benutzers an, der den Client erstellt hat.
    • Datum : Zeigt das Erstellungsdatum des neuen Clients an.
    • Geändert von : Zeigt den Namen des Benutzers an, der die Clientdetails geändert hat.
    • Datum : Zeigt das Änderungsdatum des Clients an.

    Ihr Genesys Cloud OAuth-Client ist jetzt 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 möchten eine öffentliche Bereitstellung implementieren.
    • Sie möchten eine private Bereitstellung implementieren, die auf die getAuthToken Methode in Ihrer Datei framework.js. Weitere Informationen finden Sie unter User.getAuthToken im Genesys Cloud Developer Center.

    Ein OAuth-Client generiert eine Client-ID, die Entwickler für die Client-IDs in der Datei framework.js. Weitere Informationen finden Sie unter Client-IDs im Genesys Cloud Developer Center.

    1. Klicken Sie auf Admin.
    2. Klicken Sie unter Integrationen auf OAuth .
    3. Klicken Speisekarte > IT und Integrationen > OAuth .
    4. Klicken Client hinzufügen . Die Seite „Neuen Client hinzufügen“ wird angezeigt.
    5. Im App-Name Geben Sie in das Feld den Namen der Anwendung ein.
    6. (Optional) Im Beschreibung Geben Sie im Feld „Beschreibung“ die Beschreibung ein.
    7. Im Zuschussarten Feld, wählen Sie Zeichen Implizite Gewährung (Browser) . Weitere Informationen finden Sie unter Genehmigung Und Gewährung – implizit  im Entwicklercenter.
    8. Klicken Sie auf Weiter.
    9. Im Token-Dauer in Sekunden Geben Sie im Feld die gewünschte Dauer für das Token ein. Übernehmen Sie die Standarddauer, oder geben Sie einen Wert zwischen 300 und 172800 Sekunden ein. Diese Dauer legt die Lebensdauer des Tokens auf maximal zwei Tage oder weniger fest.
      Notiz : Genesys empfiehlt, die Tokendauer auf 18 Stunden (64.800 Sekunden) festzulegen. Diese Dauer führt im Allgemeinen dazu, dass das Token außerhalb des normalen Arbeitstages eines Agenten abläuft.
    10. Im Autorisierte Umleitungs-URIs (eine pro Zeile) Fügen Sie im Feld https://apps.mypurecloud.com/crm/index.html hinzu, angepasst an Ihre Genesys Cloud-Region.
      Notizen:
      • Verwenden Sie die AWS-Region entsprechend Ihrer Bereitstellung
      • Wenn Sie dediziertes Login-Fenster auf true in Ihrer framework.js-Datei, fügen Sie auch https://apps.mypurecloud.com/crm/authWindow.html unter Autorisierte Umleitungs-URIs . Weitere Informationen finden Sie unter dediziertes Login-Fenster unter Einstellungen im Entwicklercenter.
      • Nachdem Genesys Ihr öffentliches Deployment veröffentlicht hat, erhalten Sie von Genesys eine neue URI, die Sie verwenden können.
    11. Wählen Sie im Feld „Umfang“ die erforderlichen Umfänge aus. Sie können auch weitere Bereiche hinzufügen. Eine Liste der erforderlichen Bereiche finden Sie unter Administratoranforderungen für die Genesys Cloud Embedded Clients. Weitere Informationen zu Bereichen finden Sie unter OAuth-Bereiche im Entwicklercenter.
    12. Klicken Speichern . Auf der Seite „Neuen Client hinzufügen“ wird der Abschnitt „Client Secret“ angezeigt. Das Feld „Client Secret“ zeigt eine geheime Zeichenfolge an, die die Anwendung zum Nachweis ihrer Identität verwendet, wenn der Benutzer ein Token anfordert. Dieses Geheimnis kann auch als Anwendungskennwort bezeichnet werden.
      Notiz : Sie können dieses Geheimnis nur einmal zum Zeitpunkt der Einrichtung anzeigen.
      In diesem Feld können Sie folgende Aktionen ausführen:
      • Um Details zum Passwort anzuzeigen, klicken Sie auf Zeigen .
      • Um das Passwort zu kopieren, klicken Sie auf Kopie .
      • Um einen neuen Geheimcode zu generieren, klicken Sie auf Neues Geheimnis generieren . Das Dialogfeld „Neuen Client-Geheimnis generieren?“ wird angezeigt.
        • Das Dialogfeld „Neuen geheimen Clientschlüssel generieren?“ wird angezeigt. Klicken Bestätigen .
        • Eine Meldung bestätigt, dass das Passwort geändert wurde.  
    13. Klicken Sie auf Fertigstellen.
    14. Das Dialogfeld „Client-Geheimnis kopieren und speichern“ wird angezeigt. Um zu bestätigen, dass Sie das Passwort kopiert und gespeichert haben, aktivieren Sie das Kontrollkästchen. Wenn Sie fortfahren, können Sie dieses Passwort nicht erneut anzeigen. 
    15. Klicken Bestätigen . Die App, die Sie gerade erstellt haben, wird mit dem folgenden Abschnitt unten auf der Seite angezeigt.
        • Erstellt von : Zeigt den Namen des Benutzers an, der den Client erstellt hat.
        • Datum : Zeigt das Erstellungsdatum des neuen Clients an.
        • Geändert von : Zeigt den Namen des Benutzers an, der die Clientdetails geändert hat.
        • Datum : Zeigt das Änderungsdatum des Clients an.

      Geben Sie die Client-ID an die Entwickler weiter, die die Client-ID wiederum hinzufügen zu Client-IDs in der Datei framework.js. Weitere Informationen finden Sie unter Client-IDs im Entwicklercenter.

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

      Voraussetzungen
      • OAuth > Client > Berechtigung hinzufügen
      • Ihrem Benutzer zugewiesene SCIM-Integrationsrolle
      • 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 Schnellstart für Entwicklertools im Entwicklercenter. Zugang API Explorer im Entwicklercenter.

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

      1. Klicken Sie auf Admin.
      2. Klicken Sie unter Integrationen auf OAuth .
      3. Klicken Speisekarte > IT und Integrationen > OAuth .
      4. Klicken Client hinzufügen . Die Seite „Neuen Client hinzufügen“ wird angezeigt.
      5. Im App-Name Geben Sie in das Feld den Namen der Anwendung ein.
      6. (Optional) Im Beschreibung Geben Sie im Feld „Beschreibung“ die Beschreibung ein.
      7. Im Zuschussarten Wählen Sie im Feld „Client-Anmeldeinformationen“ aus. Weitere Informationen zu den einzelnen Berechtigungen finden Sie auf der Registerkarte „Plattform-API“ in Schritt 8.
      8. Klicken Sie auf Weiter.
      9. Weisen Sie in der Tabelle „Rollen zuweisen“ in der Spalte „Zugewiesen“ die Rolle „SCIM-Integration“ zu.
        Notiz : 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 keine anderen Rollen oder Berechtigungen zuweisen, wird der Wert, den Sie in der Token-Dauer in Sekunden Das Feld wird auf den Standardwert von 86.400 Sekunden zurückgesetzt. Beziehen Sie auch alle Abteilungen mit ein, die Sie mit SCIM verwalten werden.
      10. Klicken Sie auf Weiter.
      11. Im Token-Dauer in Sekunden Geben Sie im Feld die gewünschte Dauer für das Token ein. Die Token-Dauer ist die Zeitspanne bis zum Ablauf der mit diesem Client erstellten Token. Akzeptieren Sie die Standarddauer von 86.400 oder geben Sie einen Wert zwischen 300 und 38.880.000 Sekunden ein. Dadurch wird die Lebensdauer des Tokens auf maximal 450 Tage festgelegt.
        Notiz : Sie können das Maximum nur auf 38.880.000 Sekunden festlegen, wenn Sie die SCIM-Integrationsrolle oder eine benutzerdefinierte Rolle mit denselben Berechtigungen verwenden.
      12. Klicken Speichern . Eine Meldung bestätigt, dass der Client erstellt wurde. Auf der Seite „Neuen Client hinzufügen“ wird der Abschnitt „Client Secret“ angezeigt. Das Feld „Client Secret“ zeigt eine geheime Zeichenfolge an, die die Anwendung zum Nachweis ihrer Identität verwendet, wenn der Benutzer ein Token anfordert. Dieses Geheimnis kann auch als Anwendungskennwort bezeichnet werden.
        Notiz : Sie können dieses Geheimnis nur einmal zum Zeitpunkt der Einrichtung anzeigen.
        In diesem Feld können Sie folgende Aktionen ausführen:
        • Um Details zum Passwort anzuzeigen, klicken Sie auf Zeigen .
        • Um das Passwort zu kopieren, klicken Sie auf Kopie .
        • Um einen neuen Geheimcode zu generieren, klicken Sie auf Neues Geheimnis generieren . Das Dialogfeld „Neuen Client-Geheimnis generieren?“ wird angezeigt.
          • Das Dialogfeld „Neuen geheimen Clientschlüssel generieren?“ wird angezeigt. Klicken Bestätigen .
          • Eine Meldung bestätigt, dass das Passwort geändert wurde.  
      13. Klicken Sie auf Fertigstellen.
      14. Das Dialogfeld „Client-Geheimnis kopieren und speichern“ wird angezeigt. Um zu bestätigen, dass Sie das Passwort kopiert und gespeichert haben, aktivieren Sie das Kontrollkästchen. Wenn Sie fortfahren, können Sie dieses Passwort nicht erneut anzeigen. 
      15. Klicken Bestätigen . Die App, die Sie gerade erstellt haben, wird mit dem folgenden Abschnitt unten auf der Seite angezeigt.
        • Erstellt von : Zeigt den Namen des Benutzers an, der den Client erstellt hat.
        • Datum : Zeigt das Erstellungsdatum des neuen Clients an.
        • Geändert von : Zeigt den Namen des Benutzers an, der die Clientdetails geändert hat.
        • Datum : Zeigt das Änderungsdatum des Clients an.

      Darüber hinaus können Sie auf dieser Seite folgende Aktionen ausführen:

      • Bearbeiten Sie die Kundendetails, indem Sie auf das Client bearbeiten Taste.
      • Löschen Sie den erstellten Client, indem Sie auf das Client löschen Taste.

      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).