UiPath Marketplace-Benutzerhandbuch

Letzte Aktualisierung 5. Sep. 2024

Authentifizierung

Die Authentifizierung bei der UiPath Orchestrator-API hängt vom Typ der Orchestrator-Instanz ab, mit der Sie eine Verbindung herstellen. Es gibt zwei Arten von Orchestrator-Instanzen, die beide ein Bearer-Token für die Authentifizierung verwenden: Cloud Orchestrator und On-Premises Orchestrator.

Endpunkte und Eingaben

Aus der Sicht der Authentifizierung gibt es zwei Hauptunterschiede zwischen den Instanztypen. Die erste ist der Endpunkt, an den Sie Anforderungen senden, und die zweite sind die erforderlichen Eingaben für die Authentifizierungsanforderungen.

Die folgende Tabelle zeigt die verschiedenen Endpunkte und Eingaben für jeden Instanztyp sowie Links zur entsprechenden API-Dokumentation.

	Cloud Orchestrator	Lokaler Orchestrator
Endpoint	https://account.uipath.com/oauth/token	https://{{orchestrator-url}}/api/Account/Authenticate
Eingaben	Logischer Name des Kontos Logischer Name des Mandanten Client-ID Benutzerschlüssel Ordner (optional)	Orchestrator-URL Name des Orchestrator-Mandanten E-Mail-Adresse oder Benutzername Passwort Ordner (optional)
Anforderung/Antwort	API Prahlerei Postman	API Prahlerei Postman

Hinweis: Cloud Orchestrator: Weitere Informationen darüber, wie ein Benutzer seine Client-ID, seinen Benutzerschlüssel, seinen logischen Namen und seinen logischen Namen finden kann, finden Sie unter Abrufen der API-Zugriffsinformationen in der Orchestrator-API-Dokumentation.

Ordner

Beide Instanztypen enthalten eine optionale Ordnereingabe . Mit Ordnern können Sie Automatisierungen und deren zugehörige Entitäten sowie Personal in der gesamten Organisation differenziert steuern. Im Orchestrator sind zwei Arten von Ordnern verfügbar: klassisch und modern. Klassische Ordner sind standardmäßig aktiviert, während die Funktion Moderne Ordner vom Host- oder Tenant-Administrator aktiviert werden muss.

Wenn ein Benutzer einen Ordnerwert eingibt, müssen Sie die OrganizationUnitId des Ordners abrufen. Dieser Bezeichner muss nach Abschluss der Authentifizierung im Header aller nachfolgenden API-Anforderungen enthalten sein.

Wie erhalte ich den Wert der OrganizationUnitId eines Ordners?

Zum Abrufen der OrganizationUnitId benötigen Sie den Ordnernamen und die unten aufgeführten API-Anforderungen.

Verwenden Sie den Ordnernamen als Eingabeparameter und senden Sie eine GET-Anforderung an den GetFolders- Endpunkt (z. B. {{base url}}/odata/Folders?$filter=FullyQualifiedName eq '{{FolderName}}').

Wenn der Benutzername des Benutzers bekannt ist, können Sie auch die OrganizationUnitId des Ordners abrufen und seine Berechtigungen in einer einzigen Anforderung überprüfen. Weitere Informationen finden Sie unten.

Wie überprüfe ich Ordnerberechtigungen?

Es gibt mehrere Möglichkeiten, um zu überprüfen, ob ein Benutzer über die Berechtigung für den Zugriff auf einen bestimmten Ordner verfügt. Wie Sie Berechtigungen überprüfen, hängt davon ab, ob Sie den Benutzernamen (nicht die E-Mail-Adresse) des Benutzers kennen oder nicht.

Option 1 – Benutzername unbekannt

Diese Option gilt für Cloud Orchestrator-Instanzen sowie lokale Orchestrator-Instanzen, bei denen nur die E-Mail-Adresse des Benutzers bekannt ist.

Rufen Sie mit den eingegebenen Anmeldeinformationen die UserId des Benutzers ab, indem Sie eine GET-Anforderung an den GetCurrentUser- Endpunkt senden (z. B. {{base url}}/Users/Users_GetCurrentUser).
Senden Sie nach dem Abrufen der GET-Antwort, die die UserId enthält, eine GET-Anforderung an den GetUsersForFolder- Endpunkt, indem Sie den Ordnernamen und die BenutzerID als Eingabeparameter verwenden (z. B. {{base url}}/Folders/UiPath.Server.Configuration.OData.GetUsersForFolder(key={{*FolderOrganizationUnitId*}},includeInherited=true)?$filter=Id eq{{userId}}).

Option 2 – Benutzername bekannt

Diese Option gilt für Instanzen, in denen der Benutzername bekannt ist (normalerweise gilt dies nur für die lokalen Orchestrator-Instanzen).

Senden Sie mit dem eingegebenen Benutzernamen eine GET-Anforderung an den GetAllRolesForUserByUsernameAndSkipAndTake- Endpunkt (z. B. {{base url}}/Folders/UiPath.Server.Configuration.OData.GetAllRolesForUser(username='{{username}}',skip=0,take=0)).
- Die Antwort enthält alle Ordner, für die der Benutzer Zugriff hat. Durch Analysieren der Antwort können Sie überprüfen, ob sie den Ordnernamen , den der Benutzer eingegeben hat, und/oder die OrganizationUnitId enthält, die in einer vorherigen Anforderung abgerufen wurde.
- Der Vorteil dieser Option besteht darin, dass Sie die OrganizationUnitId des Ordners abrufen und Berechtigungen in einer einzigen Anforderung überprüfen können.

Mehrere Benutzer

Ein Connector kann mehrere authentifizierte Verbindungen mit demselben oder anderen Orchestrator-Mandanten haben. Der Zweck mehrerer Verbindungen besteht darin, mehreren Benutzern den Zugriff und die Verwendung der implementierten Connector-Funktionen zu ermöglichen (z. B. einen Auftrag starten, Warteschlangenelemente hinzufügen), ohne ihre Orchestrator-Anmeldeinformationen teilen zu müssen.