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

   Wenn Sie Ihre Authentifizierungseinstellungen aktualisieren, schlagen vorhandene Verbindungen fehl. Sie müssen eine neue Verbindung erstellen und Ihre Prozesse aktualisieren, um die neue Verbindung zu verwenden.
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 folgenden Optionen werden unterstützt:

• 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:

Beim Einrichten der Authentifizierung konfigurieren Sie, wie sich jeder authentifizieren muss, der Ihren Connector verwendet. Das sind Sie, während Sie den Connector erstellen, aber es können auch andere sein, die Ihre Erstellung verwenden.

OAuth 2.0: Autorisierungscode

Überblick

Der OAuth 2.0-Autorisierungscode ist eines der am häufigsten verwendeten Authentifizierungsprotokolle.

Authentifizierungsfelder

URL-Felder wie Autorisierungs-URL und Token-URL übernehmen nicht die Basis-URL vom Connector und erfordern die gesamte URL. Dies ermöglicht Anwendungsfälle, in denen ein Anbieter eine andere Basis-URL für die Authentifizierung verwendet als die der restlichen API.

Pflichtfelder

Hinweis: Die Client-ID und der geheime Clientschlüssel werden oft vom API-Anbieter generiert. Bitte lesen Sie die Dokumentation des Anbieters, um zu erfahren, wie diese Werte für die Authentifizierung generiert werden.

Feld	Beschreibung
Client-ID	Vom Anbieter generierter Anwendungsbezeichner.
Geheimer Clientschlüssel	Vom Anbieter generierter geheimer Anwendungsschlüssel.
Autorisierungs-URL	URL, die den Benutzer umleitet, um den Authentifizierungsprozess abzuschließen. Gibt einen Autorisierungscode zurück.
Token-URL	URL, die UiPath zum Austausch des Autorisierungscodes für ein Token verwendet.

Zusätzliche Felder

Feld	Beschreibung
Umfang	Fügen Sie die erforderlichen Scopes für einen Connector hinzu, indem Sie die einzelnen Scopes durch ein Leerzeichen trennen (d. h. read write openid).
URL des Aktualisierungstokens	URL, die zum Generieren eines neuen Zugriffstokens erforderlich ist, wenn auch ein Aktualisierungstoken zurückgegeben wird. Dies ist oft die gleiche URL, die für die Token-URL verwendet wird.
URL für Tokenwiderruf	URL, die zum Widerrufen des Zugriffstokens erforderlich ist.
Aktualisierungsintervall	Die Gültigkeitsdauer des Zugriffstokens. Der Standardwert ist 3600 Sekunden oder 60 Minuten.
Verbindungsname	Der Name der Verbindung in UiPath nach Abschluss der Authentifizierung.
Basisheader	Gibt an, ob die Client-ID und der geheime Schlüssel als Base64-codierter Wert im Authorization -Header gesendet werden. Boolescher Wert (true/false); Der Standardwert ist „true“.

Wie es funktioniert

Sobald alle Feldwerte für den Connector hinzugefügt oder konfiguriert wurden, führt UiPath® Sie automatisch durch die erforderlichen Schritte, um den Authentifizierungsablauf abzuschließen. UiPath unterstützt das Protokoll und generiert, wenn es mit einem Aktualisierungstoken-URI bereitgestellt wird, Zugriffstoken im Hintergrund nach Bedarf automatisch neu. Dadurch bleibt die Verbindung erhalten und funktionsfähig, solange das zugrunde liegende Aktualisierungstoken gültig ist.

Anforderungsformat nach der Autorisierung

Nachdem die Erstkonfiguration abgeschlossen und eine Verbindung hergestellt wurde, wird bei allen Anforderungen für diesen Connector der Autorisierungsheader automatisch in die Anforderung aufgenommen.

curl --request GET \
  --url https://{baseUrl}/{resource} \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer {yourToken}'

OAuth 2.0-Autorisierungscode mit PKCE

Überblick

OAuth 2.0-Authentifizierungscode mit PKCE (Proof Key for Code Exchange) ist ein gängiges Authentifizierungsprotokoll, das hauptsächlich von einseitigen Anwendungen, von Anwendungen, die einen geheimen Clientschlüssel nicht sicher speichern können, oder von Anwendungen, die den sicheren Abruf eines Autorisierungscodes nicht gewährleisten können, genutzt wird.

Authentifizierungsfelder

URL-Felder wie Autorisierungs-URL und Token-URL übernehmen nicht die Basis-URL vom Connector und erfordern die gesamte URL. Dies ermöglicht Anwendungsfälle, in denen ein Anbieter eine andere Basis-URL für die Authentifizierung verwendet als die der restlichen API.

Pflichtfelder

Hinweis: Die Client-ID und der geheime Clientschlüssel werden oft vom API-Anbieter generiert. Bitte lesen Sie die Dokumentation des Anbieters, um zu erfahren, wie diese Werte für die Authentifizierung generiert werden.

Feld	Beschreibung
Client-ID	Vom Anbieter generierter Anwendungsbezeichner.
Geheimer Clientschlüssel	Vom Anbieter generierter geheimer Anwendungsschlüssel.
Autorisierungs-URL	URL, die den Benutzer umleitet, um den Authentifizierungsprozess abzuschließen. Gibt einen Autorisierungscode zurück.
Token-URL	URL, die UiPath zum Austausch des Autorisierungscodes für ein Token verwendet.

Zusätzliche Felder

Feld	Beschreibung
Umfang	Fügen Sie die erforderlichen Scopes für einen Connector hinzu, indem Sie die einzelnen Scopes durch ein Leerzeichen trennen (d. h. read write openid).
URL des Aktualisierungstokens	URL, die zum Generieren eines neuen Zugriffstokens erforderlich ist, wenn auch ein Aktualisierungstoken zurückgegeben wird. Dies ist oft die gleiche URL, die für die Token-URL verwendet wird.
OAuth2 PKCE: Code-Herausforderungsmethode	Die Methode, mit der die Herausforderung generiert wird. Kann entweder S256 oder plain sein (empfohlen: S256).
URL für Tokenwiderruf	URL, die zum Widerrufen des Zugriffstokens erforderlich ist.
Aktualisierungsintervall	Die Gültigkeitsdauer des Zugriffstokens. Der Standardwert ist 3600 Sekunden oder 60 Minuten.
Verbindungsname	Der Name der Verbindung in UiPath nach Abschluss der Authentifizierung.
Basisheader	Gibt an, ob die Client-ID und der geheime Schlüssel als Base64-codierter Wert im Authorization -Header gesendet werden. Boolescher Wert (true/false); Der Standardwert ist „true“.

Wie es funktioniert

Sobald alle Feldwerte für den Connector hinzugefügt oder konfiguriert wurden, führt UiPath® Sie automatisch durch die erforderlichen Schritte, um den Authentifizierungsablauf abzuschließen. UiPath unterstützt das Protokoll und generiert, wenn es mit einem Aktualisierungstoken-URI bereitgestellt wird, Zugriffstoken im Hintergrund nach Bedarf automatisch neu. Dadurch bleibt die Verbindung erhalten und funktionsfähig, solange das zugrunde liegende Aktualisierungstoken gültig ist.

UiPath stellt die Herausforderungszeichenfolge bereit, die für die PKCE-basierte Autorisierung erforderlich ist. Nur die OAuth2 PKCE Code-Herausforderungsmethode ist erforderlich.

Anforderungsformat nach der Autorisierung

Nachdem die Erstkonfiguration abgeschlossen und eine Verbindung hergestellt wurde, wird bei allen Anforderungen für diesen Connector der Autorisierungsheader automatisch in die Anforderung aufgenommen.

curl --request GET \
  --url https://{baseUrl}/{resource} \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json'
  --header 'Authorization: Bearer {yourToken}',

OAuth 2.0: Client-Anmeldeinformationen

Überblick

OAuth 2.0 Client-Anmeldeinformationen ist eine Methode zum Zurückgeben eines Zugriffstokens, das Zugriff auf geschützte Ressourcen gewährt, mithilfe von anwendungsspezifischen Anmeldeinformationen, die die erforderliche Berechtigung erteilen. Client-Anmeldeinformationen werden häufig für M2M-Anwendungen (Machine-to-Machine) verwendet und sind in der Regel nicht repräsentativ für Benutzerberechtigungen.

Authentifizierungsfelder

URL-Felder wie Token-URL erben nicht die Basis-URL vom Connector und erfordern die gesamte URL. Dies ermöglicht Anwendungsfälle, in denen ein Anbieter eine andere Basis-URL für die Authentifizierung verwendet als die der restlichen API.

Pflichtfelder

Hinweis: Die Client-ID und der geheime Clientschlüssel werden oft vom API-Anbieter generiert. Bitte lesen Sie die Dokumentation des Anbieters, um zu erfahren, wie diese Werte für die Authentifizierung generiert werden.

Feld	Beschreibung
Client-ID	Vom Anbieter generierter Anwendungsbezeichner.
Geheimer Clientschlüssel	Vom Anbieter generierter geheimer Anwendungsschlüssel.
Token-URL	URL, die zum Abrufen des Zugriffstokens verwendet wird.

Zusätzliche Felder

Feld	Beschreibung
Umfang	Fügen Sie die erforderlichen Scopes für einen Connector hinzu, indem Sie die einzelnen Scopes durch ein Leerzeichen trennen (d. h. read write openid).
Aktualisierungsintervall	Die Gültigkeitsdauer des Zugriffstokens. Der Standardwert ist 3600 Sekunden oder 60 Minuten.
Verbindungsname	Der Name der Verbindung in UiPath nach Abschluss der Authentifizierung.
Basisheader	Gibt an, ob die Client-ID und der geheime Schlüssel als Base64-codierter Wert im Authorization -Header gesendet werden. Boolescher Wert (true/false); Der Standardwert ist „true“.

Wie es funktioniert

Sobald alle Feldwerte für den Connector hinzugefügt oder konfiguriert wurden, generiert UiPath® eine Autorisierungsanforderung und übergibt die erforderlichen Anmeldeinformationen, um ein Zugriffstoken zu generieren. Da die OAuth 2.0-Client-Anmeldeinformationen für M2M-Anwendungen gedacht sind, sehen Sie nur die erste UiPath-Autorisierungsseite und es gibt keine weiteren Weiterleitungen.

Sobald ein erfolgreicher Autorisierungsablauf erkannt wurde, hält UiPath die Verbindung aufrecht, solange die angegebenen Anmeldeinformationen gültig sind.

Anforderungsformat nach der Autorisierung

Nachdem die Erstkonfiguration abgeschlossen und eine Verbindung hergestellt wurde, wird bei allen Anforderungen für diesen Connector der Autorisierungsheader automatisch in die Anforderung aufgenommen.

curl --request GET \
  --url https://{baseUrl}/{resource} \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json'
  --header 'Authorization: Bearer {yourToken}',

Standardauthentifizierung

Überblick

Mit dem grundlegenden Authentifizierungstyp können Sie einen Benutzernamen und ein Kennwort definieren, die dann Base64-codiert sind und denen das Präfix Basic vorangestellt ist. Der Benutzername und das Kennwort, die geändert werden können, werden in allen Connector-Anforderungen als Wert für den Autorisierungsheader verwendet.

Authentifizierungsfelder

Feld	Beschreibung
Benutzername	Der erste Wert im zweiteiligen Doppelpunkt abgegrenzten und base64-codierten Authorization -Headerwert.
Passwort	Der zweite Wert im zweiteiligen Doppelpunkt abgegrenzten und base64-codierten Authorization Headerwert.
Verbindungsname	Der Name der Verbindung in UiPath nach Abschluss der Authentifizierung.

Wie es funktioniert

Wenn UiPath® die Benutzernamen- und Kennwortwerte erhält, kombiniert UiPath® die Werte, trennt sie durch Doppelpunkte, codiert sie Base64 und stellt Basic mit einem Präfix versehen, um einen Authorization -Headerwert zu generieren (z. B Authorization: Basic base64(username:password)). Dieser Headerwert wird zur Authentifizierung in jede Anforderung übertragen.

Anforderungsformat nach der Autorisierung

Nachdem die Erstkonfiguration abgeschlossen und eine Verbindung hergestellt wurde, wird bei allen Anforderungen für diesen Connector der Autorisierungsheader automatisch in die Anforderung aufgenommen.

curl --request GET \
  --url https://{baseUrl}/{resource} \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json'
  --header 'Authorization: Basic base64(username:password)'

API-Schlüssel

Überblick

Einige Anbieter bieten einen API-Schlüssel als Authentifizierung für den Zugriff auf ihre API-Ressourcen an. Im Connector-Generator führt dieser Authentifizierungstyp zur Verwendung eines 'X-Acess-Token: <provider_api_key>' -Headers, der an Connector-Anforderungen übergeben wird.

Authentifizierungsfelder

Feld	Beschreibung
API-Schlüssel	Der vom API-Anbieter generierte API-Schlüssel, der als Wert für den X-Access-Token -Header in allen Connector-Anforderungen verwendet werden soll.
Verbindung mname	Der Name der Verbindung in UiPath nach Abschluss der Authentifizierung

Wie es funktioniert

Wenn Sie den vom Anbieter generierten API-Schlüsselwert für den Parameter API-Schlüssel in Einstellungen – Authentifizierung verwenden, enthält jede Anforderung für diesen Connector einen X-Access-Token -Header mit dem API-Schlüssel, der als Headerwert angegeben wird.

Anforderungsformat nach der Autorisierung

Nachdem die Erstkonfiguration abgeschlossen und eine Verbindung hergestellt wurde, wird bei allen Anforderungen für diesen Connector der X-Access-Token -Header automatisch in die Anforderung aufgenommen.

curl --request GET \
  --url https://{baseUrl}/{resource} \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json'
  --header 'X-Access-Token: {yourtoken}'

Persönliches Zugriffstoken

Überblick

Einige Anbieter stellen nicht ablaufende Zugriffstoken bereit und verwenden das Headermuster Authorization: {access_token} für die Authentifizierung von Anforderungen. Mit der PAT-Authentifizierungsmethode können Sie das erforderliche Zugriffstoken bereitstellen und die zuvor aufgeführten Header anwenden, aber das Zugriffstoken wird nicht beibehalten, wenn es zu einem beliebigen Zeitpunkt abläuft.

Authentifizierungsfelder

Feld	Beschreibung
Persönliches Zugriffstoken	Das vom Anbieter generierte Zugriffstoken, das als Wert im Authorization -Headerfeld für alle Connector-Anforderungen verwendet werden soll. Das Feld stellt dem Token standardmäßig Bearer , um das allgemeine Bearer-Authentifizierungsmuster zu unterstützen.
Verbindungsname	Der Name der Verbindung in UiPath nach Abschluss der Authentifizierung.

Wie es funktioniert

Wenn Sie den vom Anbieter generierten API-Schlüsselwert für den Token-Parameter Personal Access in „Einstellungen – Authentifizierung“ verwenden, enthält jede Anforderung für diesen Connector einen X-Access-Token -Header mit dem persönlichen Zugriffstoken, das als Headerwert angegeben ist.

Anforderungsformat nach der Autorisierung

Nachdem die Erstkonfiguration abgeschlossen und eine Verbindung hergestellt wurde, wird bei allen Anforderungen für diesen Connector der Authorization -Header automatisch in die Anforderung aufgenommen.

curl --request GET \
  --url https://{baseUrl}/{resource} \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json'
  --header 'Authorization: {personal_access_token}'

Benutzerdefiniert

Überblick

Benutzerdefinierte Authentifizierung sollte verwendet werden, wenn die Anbieterkonfiguration keinem der Standards entspricht, aber erfordert, dass Authentifizierungsdetails bei jeder Anforderung ausgetauscht und gesendet werden.

Authentifizierungsfelder

Die benutzerdefinierten Authentifizierungsfelder enthalten einen Authorization -Parameter als Beispielfeld, können jedoch an die Authentifizierungsmuster des API-Anbieters angepasst werden.

Alle Parameter, die der Authentifizierung über die Benutzerdefinierte Authentifizierung hinzugefügt wurden, gelten für die Anforderungen des Connectors.

Hinweis: Derzeit können Sie mit der benutzerdefinierten Authentifizierung keinen benutzerdefinierten Authentifizierungsablauf erstellen. Damit können Sie die Standardauthentifizierungsparameter anpassen, die auf Anforderungen innerhalb des Connectors angewendet werden.

Wie es funktioniert

Parameter, die dem Authentifizierungsabschnitt hinzugefügt wurden, werden automatisch in alle Connector-Anforderungen aufgenommen.

Keine Authentifizierung

Die Option Keine Authentifizierung bietet eine schnelle Auswahl aus der Liste und löscht alle Eigenschaften aus der Konfigurationstabelle der Authentifizierung.

Verwendungsweise

Verwenden Sie diese Option, wenn die Anbieteranwendung, mit der Sie eine Verbindung herstellen, ohne Anmeldung verfügbar ist. Dies kann ein öffentlicher Online-Dienst oder eine API sein, die intern innerhalb des Unternehmens verfügbar gemacht wird. Es müssen keine Header für Anfragen gesendet werden, die angeben, wer den API-Aufruf macht.

Ergebnis beim Senden einer Anforderung

curl --request GET \
  --url https://{baseUrl}/{resource} \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json'