Konfigurieren der Authentifizierung

Eine der großen Pfeiler beim Erstellen eines Connectors ist die Identifizierung und korrekte Integration des Authentifizierungs-Setups. Wenn es richtig gemacht ist, können Benutzer nach der Veröffentlichung des Connectors im Integration Service-Katalog Verbindungen dazu erstellen, genau wie bei jedem anderen Connector im Katalog.

Alle Connectors verwenden das Authentifizierungsframework wieder, sodass der vollständige Authentifizierungsablauf und die Verbindungsverwaltung in einem einheitlichen Ansatz gehandhabt werden können.

Das Endergebnis der Authentifizierung ist, dass jede nachfolgende Anforderung innerhalb dieses Connectors das Ergebnis des Authentifizierungsprozesses für jeden API-Aufruf verwendet. Beispielsweise wird bei jedem API-Aufruf ein Bearer-Token in den Headern gesendet:

Der Connector-Generator unterstützt die folgenden Branchenstandards durch einfache Konfiguration statt umfangreicher Codierung:

• OAuth 2.0: Autorisierungscode
• OAuth 2.0-Autorisierungscode mit PKCE
• OAuth 2.0: Client-Anmeldeinformationen
• Standard
• API-Schlüssel
• Persönliches Zugriffstoken (PAT)
• Benutzerdefiniert
• Keine Authentifizierung

Da der Connector-Generator in das Integration Service-Framework eingebunden ist, ist das Definieren Ihres Authentifizierungs-Setups jetzt eine Frage der Konfiguration und nicht eines komplexen Prozesses. Das bedeutet, dass das Framework den Token-Austausch, die Aktualisierung und andere derartige Aufgaben übernimmt. Connector-Generator verwendet standardmäßig den OAuth 2.0-Autorisierungscode, da dies der gängigste Anbieteransatz für die Authentifizierung ist.

Die Authentifizierungsseite besteht aus drei Komponenten:

1. Der Authentifizierungstyp, der bestimmt, wie das Authentifizierungsframework mit zusätzlicher Validierung für PKCE, vollständigem Tokenaustausch (für OAuth) usw. aussieht. Darüber hinaus wird die Tabelle mit Eigenschaften darunter neu konfiguriert, sodass die erforderlichen Eigenschaften umrissen werden.
   

   

   
   
2. Die Eigenschaftentabelle kann mit benutzerdefinierten Parametern geändert werden und/oder vorhandene bearbeitet werden. Je nach Auswahl des Authentifizierungstyps im Dropdownmenü können einige Felder obligatorisch sein und rot angezeigt werden.
   Hinweis: Wenn Sie diese Eigenschaften in dieser Tabelle oder den Authentifizierungstyp im Allgemeinen ändern, wird die Verbindung ungültig, die Sie möglicherweise bereits im Connector Builder erstellt haben. Während der Entwurfszeit gibt es nur eine Verbindung, die eingerichtet und anhand der neuesten Authentifizierungskonfiguration getestet werden muss.
3. Der Authentifizierungsbildschirm wird basierend auf der von Ihnen angegebenen Konfiguration automatisch generiert. Was Sie während der Konfiguration im Connector Builder sehen, ist genau das Endergebnis, das Benutzer Ihres Aktivitätspakets sehen werden.
   
   
   
   

Konfiguration der Authentifizierungstabelle

Ohne Berücksichtigung des Authentifizierungstyps identifiziert die geladene Eigenschaftentabelle zwei Elemente:

1. Was der Benutzer innerhalb des Authentifizierungsbildschirms sieht.
2. Wie die Authentifizierung vom Authentifizierungsframework behandelt wird.

• Jedes Zeilenelement in der Tabelle stellt eine Eigenschaft dar, die vom Benutzer überschrieben werden kann oder nicht. Um ein bestimmtes Feld auf dem Bildschirm anzuzeigen, muss es als Benutzer fragen – Ja gekennzeichnet werden.
• Jedes Zeilenelement hat einen Namen und einen Anzeigenamen. Der Name ist das, was der Anbieter für das technische Setup erwartet, und letzterer ist wichtig für die Abfrage der Eingabe des Benutzers auf dem Authentifizierungsbildschirm.
• Jedes Zeilenelement enthält ein Aktionsmenü, mit dem die Eigenschaft noch detaillierter bearbeitet werden kann. Hier können Sie angeben, dass eine bestimmte Eigenschaft als Header gesendet werden soll. Weitere Beispiele finden Sie im Abschnitt API-Schlüssel .

Authentifizierungstypen

Auf der Registerkarte Authentifizierung konfigurieren Sie den Authentifizierungstyp für Ihren Connector. Die unterstützten Optionen sind:

• OAuth 2.0: Autorisierungscode
• OAuth 2.0-Autorisierungscode mit PKCE
• OAuth 2.0: Client-Anmeldeinformationen
• Standard
• API-Schlüssel
• Persönliches Zugriffstoken (PAT)
• Benutzerdefiniert
• Keine Authentifizierung

Hinweis: Wenn Sie die Authentifizierung konfigurieren, konfigurieren Sie, wie sich jede Person, die Ihren Connector verwendet, authentifizieren muss. Während Sie den Connector erstellen, werden Sie das sein, aber es könnten auch andere sein, die Ihre Erstellung verwenden.

Standardauthentifizierung

1. Wählen Sie Bearbeiten aus unter der Spalte Aktion zum Konfigurieren der einzelnen Eigenschaften. Benutzername und Kennwort sind standardmäßig verfügbar.

2. Wählen Sie Parameter hinzufügen aus, wenn Sie ein weiteres Feld hinzufügen möchten, das während der Authentifizierung verwendet werden soll:

   • Anzeigename – Wird dem Benutzer beim Herstellen der Verbindung angezeigt.
   • Typ – Definiert das Eingabefeld im Verbindungsdialog. Wählen Sie eine Option aus der Dropdownliste aus: true/false, Kennwort, Test, ja/nein.
   • Dem Benutzer fragen – Legen Sie Ja fest, wenn eine Benutzereingabe erforderlich ist.
   • Wert – Verwenden Sie dieses Feld, um einen Standardwert festzulegen.
   • Hinweistext – Benutzeranleitung für das Eingabefeld.
   • Anbietername – Der technische Schlüssel für den API-Aufruf.
   • An Anbieter als Typ senden – Wie die API den Wert empfängt. Wählen Sie eine Option aus der Dropdownliste aus: Konfiguration, Header, Pfad, Text, Abfrage, Formular. Standardwert: header.
   
   

   

   
   
3. Wählen Sie Speichern aus, um Ihren neuen Authentifizierungsparameter zu speichern.
4. Verwenden Sie die Option Auf Standardwert zurücksetzen, wenn Sie Ihre Authentifizierung auf die ursprünglichen Werte für Standard zurücksetzen möchten. Dieser Vorgang kann nicht rückgängig gemacht werden.

OAuth 2.0-Autorisierungscode

Um den OAuth 2.0-Autorisierungscode zu verwenden, müssen Sie eine OAuth-App in der Anwendung erstellen, mit der Sie integrieren möchten, und von dort die Anmeldeinformationen abrufen, die für die Konfiguration Ihres Connectors erforderlich sind.

Konfigurieren Sie die folgenden Felder:

• Client-ID
• Geheimer Clientschlüssel
• Umfang
• Autorisierungs-URL
• Token-URL
• URL des Aktualisierungstokens
• Basisheader
• URL für Tokenwiderruf

• Aktualisierungsintervall

  Hinweis: Die URLs für Autorisierung, Token und Aktualisierungstoken sollten in der API-Dokumentation der App verfügbar sein.

OAuth 2.0-Autorisierungscode mit PKCE

OAuth 2.0-Autorisierungscode mit PKCE ist identisch mit der OAuth 2.0-Autorisierungscode-Methode, enthält aber auch das Feld für die OAuth2 PKCE-Code-Herausforderungsmethode .

OAuth 2.0 Client-Anmeldeinformationen

Für OAuth 2.0 Client-Anmeldeinformationen müssen Sie die folgenden Felder konfigurieren:

• Client-ID
• Geheimer Clientschlüssel
• Umfang
• Token-URL
• Basisheader

• Aktualisierungsintervall

API-Schlüssel

Verwenden Sie diese Option für die Integration mit Apps, die einen API-Schlüssel erfordern, für den sie API-Aufrufe tätigen können.

Legen Sie das Feld API-Schlüssel auf den gewünschten Wert fest.

Persönliches Zugriffstoken

Verwenden Sie diese Option für die Integration mit Apps, die ein Bearer-Token erfordern, für das sie API-Aufrufe tätigen können.

Legen Sie das Feld Persönliches Zugriffstoken auf Ihr Bearer-Token fest.

Benutzerdefiniert

Sie können auch eine benutzerdefinierte Authentifizierung mit beliebigen Feldern einrichten.

Keine Authentifizierung

Verwenden Sie diese Option, wenn Sie nicht möchten, dass sich Benutzer für die Verwendung des Connectors authentifizieren.