Authentification

Le système d'authentification de l'API UiPath Orchestrator utilise un jeton de porteur pour les utilisateurs locaux et l'authentification NTLM pour les utilisateurs d'annuaire.

Remarque :

By default, the bearer token expires after 30 minutes.

Important :

Les instructions de cette page s'appliquent uniquement à l'API Orchestrator locale. L'authentification de base pour l'API n'est pas prise en charge pour les locataires Automation Cloud Orchestrator.

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

Authentification de l'utilisateur local via un jeton du porteur

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:

   Clé (Key)	Valeur (Value)
   Autorisation	Porteur

   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. Copiez la chaîne dans le paramètre de résultat de la réponse HTTP dans le Presse-papiers. Cela représente le jeton du porteur et peut être utilisé dans toutes les futures requêtes comme suit :

   • As an Authorization header with the Bearer xxxxxxxxxxxxx value, where xxxxxxxxxxxxx represents the string previously copied;
   • Si votre outil de test d'API le prend en charge, sélectionnez le type d'autorisation par jeton du porteur et entrez la chaîne précédemment copiée.

Authentification de l'utilisateur du domaine via l'authentification NTLM

Important :

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. Si votre utilisateur existe dans plusieurs locataires, spécifiez celui exact à l'aide de l'en-tête X-UIPATH-TenantName , sinon la requête est effectuée dans le premier locataire dans lequel l'utilisateur a été enregistré. L'exemple suivant illustre une requête GET adressée au point de terminaison {OrchestratorURL}/odata/Processes dans le locataire Finance.

   LIRE {OrchestratorURL}/odata/Processes

   Request headers:

   Clé (Key)	Valeur (Value)
   Autorisation	Porteur
   X-UIPATH-TenantName	Le nom du locataire. Par exemple, « Finances ».

   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

Si vous utilisez Swagger pour tester notre API, il suffit de vous connecter à Orchestrator dans un onglet distinct.

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#/.

Remarque :

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.