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:

By default, the bearer token expires after 30 minutes.

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.

If you are using the Orchestrator service in Automation Cloud, use the instructions in Consuming Cloud API instead.

Lokale Benutzerauthentifizierung über ein Inhabertoken

1. Make a POST request to the {OrchestratorURL}/api/account/authenticate endpoint with your Orchestrator login credentials, as in the example below.

   POST {OrchestratorURL}/api/account/authenticate

   Request headers:

   Schlüssel	Wert
   Autorisierung	Inhaber

   Request body:

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

   Response code: 200 OK

   Response body:

   {
       "result": "<BEARER_TOKEN>",
       "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:

   • As an Authorization header with the Bearer xxxxxxxxxxxxx value, where xxxxxxxxxxxxx represents the string previously copied;
   • 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:

To authenticate your requests using Windows credentials you need to use an API client that supports NTLM authentication, such as Postman.

1. Make a request to the desired endpoint specifying your Windows credentials in the dedicated API client. To change an NTLM auth header in Postman, navigate to the Auth tab, set the Type to NTLM Authentication, and fill in the Username and Password fields.

   

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

   Response code: 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
               }
           }
       ]
   }
   

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

The Swagger authentication expires according to the parameters set in your Orchestrator instance. By default, it is set to 30 minutes. You can change it by modifying the value of the Auth.Cookie.Expire parameter, in the Web.config file.