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 : par défaut, le jeton du porteur expire après 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.

Si vous utilisez le service Orchestrator dans Automation Cloud, suivez plutôt les instructions fournies dans Utilisation de l'API de cloud.

Authentification de l'utilisateur local via un jeton du porteur

1. Effectuez une requête POST au point de terminaison {OrchestratorURL}/api/account/authenticate avec vos identifiants de connexion Orchestrator, comme dans l'exemple ci-dessous.
   POST {OrchestratorURL}/api/account/authenticate

   Request headers:

   Clé (Key)	Valeur (Value)
   Autorisation	Porteur

   Request body:

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

   Code de réponse : 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. 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 :
   • comme un en-tête Authorization contenant la valeur Bearer xxxxxxxxxxxxx, où xxxxxxxxxxxxx représente la chaîne auparavant copiée ;
   • 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 : pour authentifier vos requêtes à l’aide d’informations d’identification Windows, vous devez utiliser un client API prenant en charge l’authentification NTLM, par exemple Postman.

1. Faites une demande au point de terminaison souhaité en spécifiant vos informations d'identification Windows dans le client API dédié. Pour modifier un en-tête d'authentification NTLM dans Postman, accédez à l'onglet Auth (Auth), définissez le type sur Authentification NTLMet remplissez les champs Nom d'utilisateur ( Username ) et Mot de passe (Password).
   
   

   

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

   Code de réponse : 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
               }
           }
       ]
   }

Swagger

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

La définition Swagger de l'API Orchestrator est accessible en ajoutant le suffixe /swagger/ui/index#/ à votre URL Orchestrator. Par exemple, https://myOrchestrator.com/swagger/ui/index#/.

Remarque : l'authentification Swagger expire en fonction des paramètres définis dans votre instance d'Orchestrator. Par défaut, il est configuré sur 30 minutes. Vous pouvez le changer en modifiant la valeur du paramètre Auth.Cookie.Expire , dans le fichier Web.config .