Verwalten externer OAuth-Anwendungen

Mit dem OAuth-Framework können Administratoren die Autorisierung an externe Anwendungen delegieren. Nach der Registrierung können diese Anwendungen API-Aufrufe an UiPath-Anwendungen oder -Ressourcen im Scope Ihrer angegebenen APIs ausführen.

Überblick

Unterstützte Anwendungstypen und Zugriffsbereich

Sie können Anwendungen als einen der folgenden Typen registrieren:

• Vertrauliche Anwendungen: Anwendungen, die den nach der Registrierung generierten geheimen Anwendungsschlüssel sicher speichern können; z. B. Webanwendungen und S2S-Anwendungen (Service-to-Service).
• Nicht vertrauliche Anwendungen: Anwendungen, die die sichere Speicherung des geheimen Anwendungsschlüssels nicht gewährleisten können, weshalb keiner erstellt wird; z. B. Desktop- oder native mobile Anwendungen.

Der Anwendungstyp definiert den Typ der Autorisierungserteilung, der für die Autorisierung der Anwendung zulässig ist. Vertrauliche Anwendungen sind auf die Benutzerebene und/oder anwendungsspezifische APIs beschränkt. Nicht vertrauliche Anwendungen können nur Anforderungen für den Benutzerscope senden, was bedeutet, dass sich ein Benutzer anmelden muss, um die Anforderung für die Anwendung zu autorisieren.

Verfügbare UiPath-Ressourcen

Bei der Registrierung der externen Anwendung gewähren Sie ihr über die API einer UiPath-Anwendung Zugriff auf eine oder mehrere UiPath-Ressourcen.

Die folgenden APIs sind verfügbar:

• Orchestrator-API

• Test Manager API

• Plattformverwaltung API

Drei Teile zur Autorisierung externer Anwendungen

Damit eine externe Anwendung auf Ihre UiPath-Ressourcen über OAuth zugreifen kann, sind drei Schritte erforderlich:

Schritt	Wer	Was	Details
1	Administrator der Organisation	Externe Anwendung in der Automation Suite registrieren	Registrieren externer Anwendungen
2	Administrator der Organisation	Stellen Sie dem Entwickler die Anwendungsregistrierungsdetails bereit.	Bereitstellung von Details für Entwickler
2	Entwickler (Developer)	Einrichten der externen Anwendung zur Verwendung des entsprechenden Gewährungstyps für den Zugriff auf Ihre UiPath-Ressourcen	Zugriff auf UiPath-Ressourcen mithilfe externer Anwendungen

Registrieren externer Anwendungen

So registrieren Sie eine externe Anwendung, damit sie OAuth verwenden kann, um auf die UiPath-Ressourcen in Ihrer Organisation zuzugreifen:

1. Wechseln Sie in der Automation Suite zu Admin > Externe Anwendungen, und klicken Sie rechts oben auf Anwendung hinzufügen.

   Die Seite Anwendung hinzufügen wird geöffnet, auf der Sie eine externe Anwendung registrieren können.

2. Füllen Sie das Feld Anwendungsname aus.
3. Wählen Sie eine Option für Anwendungstyp aus.

   Wenn Sie Vertrauliche Anwendung auswählen, erhalten Sie am Ende der App-Erstellung einen geheimen App-Schlüssel, also stellen Sie sicher, dass Ihre Anwendung ihn sicher speichern kann. Wenn dies nicht der Fall ist, wählen Sie die Option Nicht vertrauliche Anwendung aus.

4. Klicken Sie unter Ressourcen auf Scopes hinzufügen.

   Das Panel Ressource bearbeiten wird rechts geöffnet, wo Sie die Ressourcen auswählen können, auf die die Anwendung Zugriff haben soll.

5. Wählen Sie von der Dropdownliste Ressource die UiPath-API aus, welche die Anwendung verwenden kann.
   Hinweis: Sie können jeweils nur einen Scope für eine Ressource hinzufügen. Wenn Sie den Zugriff auf mehrere Ressourcen zulassen möchten, wiederholen Sie diesen Vorgang, um einen Scope für jede Ressource hinzuzufügen.
6. Aktivieren Sie auf der Registerkarte Benutzer-Scope(s) nach Bedarf die Kontrollkästchen für die logischen API-Berechtigungen, die Sie gewähren möchten.

   Die Erteilung von Berechtigungen unter dem Benutzer-Scope bedeutet, dass die externe Anwendung im Rahmen eines Benutzerkontexts auf diese Ressourcen zugreifen kann und ein Benutzer mit den entsprechenden Berechtigungen angemeldet sein muss.

7. Wenn es sich um eine vertrauliche Anwendung handelt, können Sie zur Registerkarte Anwendungs-Scope(s) wechseln, um nach Bedarf auch Berechtigungen auf Anwendungsebene für die ausgewählte Ressource zu erteilen.

   Mit Berechtigungen im Anwendungs-Scope hat die externe Anwendung Zugriff auf anwendungsweite Daten für die ausgewählten Scopes, ohne dass eine Benutzerinteraktion erforderlich ist.

   Nicht vertrauliche Anwendungen können nicht auf den Anwendungs-Scope zugreifen.

8. Klicken Sie auf Speichern.

   Der Bereich wird geschlossen und die ausgewählte Ressource und die Scopes werden der Tabelle Ressourcen im Formular hinzugefügt.

9. Wenn die externe Anwendung sie akzeptieren kann, können Sie eine URL im Feld Umleitungs-URL hinzufügen und die Autorisierungsantwort wird dorthin gesendet. Die Anwendung kann sie dann verwenden, um auf UiPath-Ressourcen zuzugreifen.
10. Klicken Sie auf Hinzufügen, um die Registrierung zu erstellen.

    Eine Bestätigungsmeldung wird geöffnet. Für vertrauliche Anwendungen enthält die Bestätigungsmeldung den geheimen App-Schlüssel, den die registrierte externe Anwendung verwenden kann, um eine Autorisierung anzufordern. Speichern Sie ihn an einem sicheren Ort, da er Ihnen nicht erneut angezeigt wird.

Ändern des Scope für eine vorhandene Anwendung

Scopes sind die Berechtigungen der externen Anwendung in Bezug auf Ihre UiPath-Ressourcen.

1. Wechseln Sie zu Admin > Externe Anwendungen.
2. Klicken Sie rechts neben der Anwendungszeile auf .
3. Ändern Sie den Scope, auf den die Anwendung Zugriff hat:
   • Verwenden Sie die Symbole rechts neben einer Ressourcenzeile, um einen vorhandenen Scope zu bearbeiten oder die Ressource zu löschen.
   • Klicken Sie auf Scopes hinzufügen, um eine zusätzliche Ressource hinzuzufügen, und wählen Sie dann Scopes dafür aus.
4. Klicken Sie auf Speichern.

Generieren eines neuen geheimen App-Schlüssels

Wenn Sie den geheimen Schlüssel nicht kennen, der für eine vertrauliche externe Anwendung generiert wurde, können Sie ihn nicht wiederherstellen. Sie können jedoch einen neuen generieren.

Hinweis: Wenn Sie einen neuen geheimen App-Schlüssel generieren, stellen Sie sicher, dass Sie ihn dem Entwickler mitteilen, der sich um die Integration mit der externen Anwendung kümmert. Der Entwickler muss den Authentifizierungsmechanismus anpassen, sonst funktioniert die vorhandene Integration nicht mehr.

So generieren Sie einen neuen geheimen App-Schlüssel:

1. Wechseln Sie zu Admin > Externe Anwendungen.
2. Klicken Sie rechts neben der Anwendungszeile auf .
3. Klicken Sie unter Geheimer App-Schlüssel auf Neu generieren.

   Ein neuer geheimer App-Schlüssel wird generiert und über der Schaltfläche angezeigt. Er bleibt sichtbar, bis Sie auf Abbrechen klicken, um die Seite zu schließen.

4. Kopieren Sie es und stellen Sie sicher, dass Sie es an einem sicheren Ort speichern.

Bereitstellung von Details für Entwickler

Nachdem Sie eine externe Anwendung registriert haben, muss ein Entwickler zudem die externe Anwendung so einrichten, dass sie sich korrekt authentifiziert, die Autorisierung vom UiPath Identity Server anfordert und dann auf die erlaubten UiPath-Ressourcen zugreift.

Um diese Aufgaben ausführen können, müssen Sie ihnen die folgenden Informationen zur Verfügung stellen:

• Anwendungstyp und Anwendungs-ID, die beide unter Admin > Seite Externe Anwendungen zu sehen sind
• die Scopes, die für jeden Scope-Typ hinzugefügt wurden Für einige Ressourcen wird derselbe Name sowohl unter Benutzer- als auch unter Anwendungs-Scopes verwendet, daher ist der Typ auch wichtig.

• Wenn es sich um eine vertrauliche Anwendung handelt, wurde der geheime Anwendungsschlüssel generiert, als Sie die externe Anwendung registriert haben.

  Hinweis: Wenn Sie den geheimen Schlüssel nicht mehr haben, generieren Sie einen neuen, wie zuvor beschrieben.

Weitere Informationen zum Authentifizieren und Autorisieren externer Apps als Entwickler finden Sie unter Externe Apps im API-Handbuch.