Autenticando

El sistema de autenticación para la API de UiPath Orchestrator utiliza un token de portador para los usuarios locales y autenticación NTLM para los usuarios del directorio.

Nota: de forma predeterminada, el token de portador caduca después de 30 minutos.

Importante:

Las instrucciones de esta página solo se aplican a la API de Orchestrator local. La autenticación básica para API no es compatible con los tenants de Automation Cloud Orchestrator.

Si estás usando el servicio de Orchestrator en Automation Cloud, utiliza en su lugar las instrucciones en Consuming Cloud API.

Autenticación de usuario local a través de un token al portador

1. Realiza una solicitud POST al punto final {OrchestratorURL}/api/account/authenticate con tus credenciales de inicio de sesión de Orchestrator, como en el siguiente ejemplo.
   POST {OrchestratorURL}/api/account/authenticate

   Request headers:

   Clave	Valor
   Autorización	Portador

   Request body:

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

   Código de respuesta: 200 Aceptar

   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. Copia la cadena en el parámetro de resultado de la respuesta HTTP en el portapapeles. Esto representa el token de portador y se puede utilizar en todas las solicitudes futuras de la siguiente manera:
   • Como encabezado de autorización con el valor Bearer xxxxxxxxxxxxx , donde xxxxxxxxxxxxx representa la cadena copiada previamente;
   • Si tu herramienta de prueba de API lo admite, selecciona el tipo de autorización de token de portador e introduce la cadena copiada previamente.

Autenticación de usuario de dominio mediante autenticación NTLM

Importante: para autenticar tus solicitudes utilizando credenciales de Windows, debes utilizar un cliente de API que admita la autenticación NTLM, como Postman.

1. Realiza una solicitud al punto final deseado especificando tus credenciales de Windows en el cliente API dedicado. Para cambiar un encabezado de autenticación NTLM en Postman, navega hasta la pestaña Autenticación , establece el Tipo en Autenticación NTLMy rellena los campos Nombre de usuario y Contraseña .
   
   

   

   
   
2. Si tu usuario existe en varios tenants, especifica el exacto usando el encabezado X-UIPATH-TenantName de lo contrario, la solicitud se realiza en el primer tenant en el que se ha aprovisionado el usuario. El siguiente ejemplo ilustra una solicitud GET {OrchestratorURL}/odata/Processes en el tenant de Finanzas.
   OBTENER {OrchestratorURL}/odata/Processes

   Request headers:

   Clave	Valor
   Autorización	Portador
   X-UIPATH-TenantName	El nombre del tenant. Por ejemplo, "Finanzas".

   Código de respuesta: 200 Aceptar

   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 está utilizando Swagger para probar nuestra API, simplemente inicie sesión en su instancia de Orchestrator en una pestaña separada.

Puedes acceder a la definición de Swagger de la API de Orchestrator añadiendo el sufijo /swagger/ui/index#/ a la URL de Orchestrator. Por ejemplo, https://myOrchestrator.com/swagger/ui/index#/.

Nota: La autenticación de Swagger caduca según los parámetros establecidos en tu instancia de Orchestrator. De forma predeterminada, está establecido en 30 minutos. Puedes cambiarlo modificando el valor del parámetro Auth.Cookie.Expire , en el archivo Web.config .