UiPath Documentation
orchestrator
2021.10
false
Anleitung für die Orchestrator-API
  • Erste Schritte
    • Über OData und Referenzen
    • Aufgezählte Typen
    • Authentifizierung
    • Erstellen von API-Anfragen
    • Berechtigungen pro Endpunkt
    • Antwortcodes
    • Endpunkte zur Zustandsprüfung
  • Swagger-Definition
  • Orchestrator-APIs
Wichtig :
Bitte beachten Sie, dass dieser Inhalt teilweise mithilfe von maschineller Übersetzung lokalisiert wurde. Es kann 1–2 Wochen dauern, bis die Lokalisierung neu veröffentlichter Inhalte verfügbar ist.

Authentifizierung

Die API-Authentifizierung stellt sicher, dass nur autorisierte Parteien mit den verfügbaren Ressourcen interagieren und die erforderlichen Aktionen ausführen können. UiPath bietet mehrere Authentifizierungsmethoden für verschiedene Szenarien.

Lokale Benutzerauthentifizierung über ein Inhabertoken (ROPC-Authentifizierung)

Wichtig:

We support authentication through ROPC for backwards compatibility for Orchestrator instances that have been migrated from standalone to Automation Suite deployments.Only Host administrators should authenticate using the /api/account/authenticate/ endpoint.Business users should authenticate using External Applications.

Die Authentifizierungsmethode für die Kennwortanmeldeinformationen des Ressourcenbesitzers ist mandantenbezogen, daher kann sich eine externe Anwendung nicht mit dieser Methode authentifizieren, da eine externe App nicht auf Mandantenebene erstellt werden kann.

  1. Um das Zugriffstoken abzurufen, stellen Sie eine POST-Anforderung an den {OrchestratorURL}/api/account/authenticate -Endpunkt mit der folgenden Nutzlast:

    {
        "TenancyName": "{account_tenancy_name}",
        "UsernameOrEmailAddress": "{account_username}",
        "Password": "{account_password}"
    }
    {
        "TenancyName": "{account_tenancy_name}",
        "UsernameOrEmailAddress": "{account_username}",
        "Password": "{account_password}"
    }
    

    In der obigen Anfrage:

    • {account_tenancy_name}– ist die eindeutige Mandanten-ID in Ihrem Automation Suite-Konto
    • {account_username}– ist der Benutzername Ihres Automation Suite-Kontos
    • {account_password}– ist das Kennwort, das zum Anmelden bei Ihrem Automation Suite-Konto verwendet wird.
  2. Um den Wert TenancyName Ihrer Orchestrator-Instanz zu ermitteln, stellen Sie eine GET-Anforderung an den Endpunkt /odata/Users/UiPath.Server.Configuration.OData.GetCurrentUser .

    Der Antworttext gibt das Bearer-Token zurück, das von Ihrer Anwendung verwendet wird, um weitere API-Aufrufe zu autorisieren. Fügen Sie daher im Autorisierungsheader eines API-Aufrufs Bearer xxxx an und ersetzen Sie xxxx durch den Wert {access_token} (z. B. Authorization: Bearer eyJhbG ... LnVxjA).

    {
        "result": "{access_token}",
        "targetUrl": null,
        "success": true,
        "error": null,
        "unAuthorizedRequest": false,
        "__abp": true
    }
    {
        "result": "{access_token}",
        "targetUrl": null,
        "success": true,
        "error": null,
        "unAuthorizedRequest": false,
        "__abp": true
    }
    

    Standardmäßig ist das Zugriffstoken 30 Minuten lang gültig. Um einen neuen zu generieren, rufen Sie den api/account/authenticate -Endpunkt erneut auf.

    Wichtig:

    If your organization uses the Azure Active Directory model, you must register external applications in Orchestrator and use the OAuth flow.

Zugreifen auf Swagger

Wenn Sie Ihre API mit Swagger ausprobieren, brauchen Sie sich nur auf einer separaten Registerkarte bei Orchestrator anzumelden.

The Orchestrator API Swagger definition can be accessed by adding the /swagger/ui/index#/ suffix to your Orchestrator URL. For example, https://{yourDomain} /swagger/ui/index#/.

Domänenbenutzerauthentifizierung

Wichtig:

API access with Windows Auto-logon (NTLM authentication) has been removed, as indicated in the deprecation timeline.

Wir empfehlen, stattdessen den OAuth-Flow zu verwenden, der die Registrierung externer Anwendungen im Orchestrator erfordert.

If the external application is already registered, refer to Using OAuth for External Apps.

War diese Seite hilfreich?

Verbinden

Benötigen Sie Hilfe? Support

Möchten Sie lernen? UiPath Academy

Haben Sie Fragen? UiPath-Forum

Auf dem neuesten Stand bleiben