Authentifizierung

Das Authentifizierungssystem für die UiPath Orchestrator-API verwendet ein Bearer-Token für lokale Benutzer und die NTLM-Authentifizierung für Verzeichnisbenutzer.

Hinweis: Standardmäßig läuft das Inhabertoken nach 30 Minuten ab.

Wichtig:

Die Anweisungen auf dieser Seite gelten nur für die lokale Orchestrator-API. Die Standardauthentifizierung für die API wird für Automation Cloud Orchestrator-Mandanten nicht unterstützt.

Wenn Sie den Orchestrator-Dienst in der Automation Cloud verwenden, verwenden Sie stattdessen die Anweisungen in Consuming Cloud API .

Lokale Benutzerauthentifizierung über ein Inhabertoken

1. Stellen Sie mit Ihren Orchestrator-Anmeldeinformationen eine POST- Anforderung an den Endpunkt {OrchestratorURL}/api/account/authenticate , wie im folgenden Beispiel gezeigt.
   POST {OrchestratorURL}/api/account/authenticate

   Request headers:

   Schlüssel	Wert
   Autorisierung	Inhaber

   Request body:

   {
       "tenancyName" : "Documentation",
       "usernameOrEmailAddress" : "Documentation",
       "password" : "DocumentationAPItest"
   }

   Antwortcode: 200 OK

   Response body:

   {
       "result": "Rr22VaC0D6MkzFShb0gKqaw3vYUJSMmo4jJWk5crDYtSbZkxPFuOC9ApMEnug2q8WxEGPkVwmNoaSXzxOBwia1Ecrldg5BUXXErU_VNOo_yt7X_GDF8sMTyErSqO9Gfe7RSinIueQU6Q_axlY4jDnCP5r2LHrAJVdyM8Tg9x3WHnR8MOgeOl290uTsSOM1ezGG-OmFarRqFUPiN2-iE_mo1KNW-9AmT87-p1-ZYTusLaGyTS9jKVGtRhMjjB0l9VyOFvINhjptq8zotCo5cOOVWJeuvh-307ZdcUWHxkFTwoGDS_DpC4D7JrKfp4oWeSkA0SSy95RfzT8KRTmsJGQV0k8VD6HE3aa_7c-FGrCDjRVtDSkTgpQcQFrIXD8kT4P52a_18doKaSB-asQ8scYe_o73fCL4VtqLDb2ZWlAwEChVmorcFjbXnejxuAubjoKaoJH10gzc5_IiCPI8pM-Zm09Z5D1ljsNjWJ_LrmOR3dijuuKUGvCDtyCCCU_JrPRxmdYSXZmHHx_3joAux0-A",
       "targetUrl": null,
       "success": true,
       "error": null,
       "unAuthorizedRequest": false,
       "__abp": true
   }

2. Kopieren Sie die Zeichenfolge im Ergebnisparameter der HTTP-Antwort in die Zwischenablage. Dies stellt ein Bearer-Token dar und kann in allen weiteren Abfragen folgendermaßen verwendet werden:
   • Als Kopfzeile einer Autorisierung mit dem Wert Bearer xxxxxxxxxxxxx, wobei xxxxxxxxxxxxx die zuvor kopierte Zeichenfolge darstellt.
   • Wenn Ihr API-Test-Tool dies unterstützt, wählen Sie den Genehmigungstyp des Bearer-Tokens und geben Sie die zuvor kopierte Zeichenfolge ein.

Domänenbenutzerauthentifizierung über NTLM-Authentifizierung

Wichtig: Um Ihre Anforderungen mit Windows-Anmeldeinformationen zu authentifizieren, müssen Sie einen API-Client verwenden, der die NTLM-Authentifizierung unterstützt, z. B. Postman.

1. Stellen Sie eine Anforderung an den gewünschten Endpunkt und geben Sie Ihre Windows-Anmeldeinformationen im dedizierten API-Client an. Um einen NTLM-Authentifizierungsheader in Postman zu ändern, navigieren Sie zur Registerkarte Auth , legen Sie den Typ auf NTLM-Authentifizierungfest und füllen Sie die Felder Benutzername und Kennwort aus.
   
   

   

   
   
2. Wenn Ihr Benutzer in mehreren Mandanten vorhanden ist, geben Sie den genauen Mandanten mithilfe des X-UIPATH-TenantName -Headers an. Andernfalls wird die Anforderung im ersten Mandanten ausgeführt, in dem der Benutzer bereitgestellt wurde. Das folgende Beispiel veranschaulicht eine GET -Anforderung an den {OrchestratorURL}/odata/Processes -Endpunkt im Finance-Mandanten.
   GET {OrchestratorURL}/odata/Processes

   Request headers:

   Schlüssel	Wert
   Autorisierung	Inhaber
   X-UIPATH-TenantName	Der Name des Mandanten. Beispiel: „Finanzen“.

   Antwortcode: 200 OK

   Response body:

   {
       "@odata.context": "{OrchestratorURL}/odata/$metadata#Processes",
       "@odata.count": 2,
       "value": [
           {
               "IsActive": false,
               "SupportsMultipleEntryPoints": false,
               "RequiresUserInteraction": true,
               "Title": null,
               "Version": "1.0.6981.35861",
               "Key": "QueueItemsProcessing:1.0.6981.35861",
               "Description": "Process items from an Orchestrator queue.",
               "Published": "2020-10-17T14:22:11.0566667Z",
               "IsLatestVersion": false,
               "OldVersion": null,
               "ReleaseNotes": null,
               "Authors": "petrina.smith",
               "ProjectType": "Undefined",
               "Id": "QueueItemsProcessing",
               "Arguments": {
                   "Input": "[{\"name\":\"argument1\",\"type\":\"System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\"required\":false,\"hasDefault\":true},{\"name\":\"argument2\",\"type\":\"System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\"required\":false,\"hasDefault\":false},{\"name\":\"argument3\",\"type\":\"System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\"required\":false,\"hasDefault\":true}]",
                   "Output": null
               }
           },
           {
               "IsActive": false,
               "SupportsMultipleEntryPoints": false,
               "RequiresUserInteraction": false,
               "Title": "TestingSequence",
               "Version": "4.0.6",
               "Key": "TestingSequence:4.0.6",
               "Description": "Blank Process",
               "Published": "2020-10-17T13:04:06.6766667Z",
               "IsLatestVersion": false,
               "OldVersion": null,
               "ReleaseNotes": "Invoke WF Action Generator",
               "Authors": "petrina.smith",
               "ProjectType": "Process",
               "Id": "TestingSequence",
               "Arguments": {
                   "Input": "[{\"name\":\"Name\",\"type\":\"System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\"required\":false,\"hasDefault\":false},{\"name\":\"Email\",\"type\":\"System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\"required\":false,\"hasDefault\":false},{\"name\":\"Product\",\"type\":\"System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\"required\":false,\"hasDefault\":false}]",
                   "Output": null
               }
           }
       ]
   }

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, {baseURL2} /swagger/ui/index#/.

Hinweis: Die Swagger-Authentifizierung erlischt gemäß dem Parametersatz in Ihrer Orchestrator-Instanz. Standardmäßig ist dieser Wert auf 30 Minuten festgelegt. Um ihn zu ändern, müssen Sie den Wert des Parameters Auth.Cookie.Expire in Datei Web.config ändern.