OAuth-Clients anlegen
Lege OAuth-Clients an, damit Deine Integration im Namen Deiner Inxmail Benutzer·innnen arbeiten kann.
Für jede Integration, die im Namen Deiner Inxmail Benutzer·innen arbeiten soll, musst Du eine eigene Client-ID mit Secret anlegen.
Lege Dir vor dem Anlegen Deiner OAuth Clients folgende Informationen bereit:
Name |
Beschreibung |
---|---|
Name | Eindeutiger Name der Integration. |
Anzeigename |
Aussagekräftiger Name der Integration. Deine Benutzer·innen sehen den Anzeigename auf dem Consent Screen, über den sie der Integration erlauben, in ihrem Namen zu arbeiten. |
Space | Space, mit dem die Integration verbunden werden soll. |
Redirect URL(s) der Integration | Liste von gültigen Redirect-Endpunkten der Integrationsanwendung. Redirect-Endpunkte werden zum Abschluss des OAuth Authorization Code Grant aufgerufen. Redirect-URIs müssen das HTTPS-Protokoll verwenden. |
Logins gelten in Inxmail New Xperience immer für einen Space. Das gilt auch für OAuth-Clients, bei denen Deine Integration im Namen Deiner Inxmail Benutzer·innen arbeitet. Im Falle einer Multi-Space-Integration musst Du einen OAuth-Client pro Space anlegen.
Um sicherzustellen dass nur Deine Integration in der Lage ist, Tokens im Auftrag Deiner Inxmail ID Benutzer·innen anzufordern, muss sich Deine Integrations-Applikation gegenüber Inxmail New Xperience authentifizieren. Client-ID und Client-Secret werden an verschiedenen Stellen der OAuth-Kommunikation für die Authentifizierung der Anwendung verwendet (siehe: Refresh Token anfordern / Access Token mittels Refresh Token anfordern).
Schritt für Schritt
-
Öffne den Navigationspunkt "OAuth-Clients".
-
Klicke auf
. -
Gib einen eindeutigen Namen für Deinen OAuth-Client ein.
Du kannst den Namen nachträglich nicht ändern: Wähle Deinen Namen mit Bedacht: Er muss einmalig in Deinem Inxmail Account sein und Du kannst ihn nachträglich nicht ändern.
-
Gib einen Anzeigenamen ein und wähle den Space aus, mit dem die Integration verknüpft werden soll.
-
Redirect-URL: Gib die Redirect-URL innerhalb Deiner Integration ein, auf die Du nach erfolgreicher Anmeldung und Erteilung des Consent weiterleiten möchtest. Falls sie Dir noch nicht bekannt ist, kannst Du sie später nachtragen. Deine Redirect-URL muss das HTTPS-Protokoll verwenden.
Die Integration funktioniert nur mit Redirect-URL: Wenn Du keine Redirect-URL angibst, ist Deine Integration nicht funktionsfähig.
Im Falle von Drittfirmen-Integrationen: Informiere Dich direkt bei Deiner Drittfirma, welche Redirect-URL Du hinterlegen musst.
Im Standardfall wirst Du nur eine Redirect-URL haben. Klicke auf das -Symbol, um mehr als eine Redirect-URL zu hinterlegen.
-
Klicke auf
. -
Kopiere Deine Client-ID und Dein Secret in die Zwischenablage, sodass sie Dir später zur Verfügung stehen.
Gib auf Dein Secret acht: Dein Secret ist eine sensible Information. Gib es nicht weiter, teile es nicht mit Dritten und speichere es geschützt.
Nach diesem Schritt hast Du keinen Zugriff mehr auf Dein Secret: Achte darauf, dass Du Dein Secret sicherst. Weder Du noch Inxmail können auf Dein Secret zugreifen, sobald Du diesen Dialog geschlossen hast.
- Du hast einen OAuth-Client mit Client-ID und Secret in Inxmail New Xperience hinterlegt.
Wechsel nun in Deine Integration und schließe das OAuth-Setup dort ab.
Das Hinterlegen von Client-ID und Secret ist je nach Integration unterschiedlich. Halte Rücksprache mit Deiner internen IT-Abteilung oder mit Deiner Integrationsfirma, falls Du nicht sicher bist, wie Du weiter vorgehen musst.
Stelle außerdem sicher, dass die Redirect-Endpunkte Deiner Integrationsanwendung per HTTPS abgesichert sind.
Weitere Informationen findest Du im Artikel OAuth-Clients: Technische Details, URLs und Code-Ausschnitte.