Einen OAuth-Client erstellen

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.