Cómo autenticarse

La autenticación con la API de UiPath Orchestrator depende del tipo de instancia de Orchestrator a la que se está conectando. Hay dos tipos de instancias de Orchestrator, y ambas usan un token de portador para la autenticación: Cloud Orchestrator y Orchestrator local.

Puntos finales y entradas

Desde la perspectiva de la autenticación, existen dos diferencias principales entre los tipos de instancia. El primero es el punto final al que se envían las solicitudes y el segundo son las entradas necesarias para las solicitudes de autenticación.

La tabla a continuación muestra los diferentes puntos de conexión y entradas para cada tipo de instancia, así como los enlaces a la documentación de la API correspondiente.

	Orquestador en la nube	Orchestrator local
PuntoFinal	https://account.uipath.com/oauth/token	https://{{orchestrator-url}}/api/Account/Authenticate
Entradas	Nombre lógico de la cuenta Nombre lógico del tenant ID de cliente Clave de usuario Carpeta (opcional)	URL de Orchestrator Nombre del tenant de Orchestrator Correo electrónico o nombre de usuario Contraseña Carpeta (opcional)
Solicitud / respuesta	API Swagger Postman	API Swagger Postman

Nota: Cloud Orchestrator: para obtener más información sobre cómo un usuario puede localizar su ID de cliente, clave de usuario, nombre lógico de cuenta y nombre lógico de tenant, consulta Obtener información de acceso a la API en la documentación de la API de Orchestrator.

Carpetas

Ambos tipos de instancia incluyen una entrada de carpeta opcional. Las carpetas te permiten mantener un control detallado sobre las automatizaciones y sus entidades intrínsecas, y sobre el personal de toda la organización. Hay dos tipos de carpetas disponibles en Orchestrator: clásica y moderna. Las carpetas clásicas están habilitadas de forma predeterminada, mientras que el administrador del host o del tenant debe habilitar la funcionalidad de las carpetas modernas.

Si un usuario introduce un valor de Carpeta , necesitará recuperar el IdDeUnidadDeOrganización de la carpeta. Este identificador debe incluirse en el encabezado de todas las solicitudes de API posteriores una vez se complete la autenticación.

¿Cómo puedo obtener el valor de IdDeLaUnidadDeOrganización de la carpeta?

Para recuperar el OrganizationUnitId , debe tener el nombre de la carpeta y seguir las solicitudes de la API que se enumeran a continuación.

Usando el nombre de la carpeta como parámetro de entrada, envía una solicitud GET al punto final GetFolders (por ejemplo, {{base url}}/odata/Folders?$filter=FullyQualifiedName eq '{{FolderName}}').

Cuando se conoce el nombre de usuario del usuario, también puede recuperar el OrganizationUnitId de la carpeta y verificar sus permisos en una sola solicitud. Para más información, consulta a continuación.

¿Cómo verifico los permisos de las carpetas?

Hay varias formas de verificar si un usuario tiene permiso para acceder a una carpeta específica. La forma de verificar los permisos depende de si tiene o no el nombre de usuario (no el correo electrónico) del usuario.

Opción 1: nombre de usuario desconocido

Esta opción se aplica a las instancias de Cloud Orchestrator, así como a las instancias locales de Orchestrator donde solo se conoce el correo electrónico del usuario.

Utilizando las credenciales introducidas, recupera el UserId del usuario enviando una solicitud GET al punto final GetCurrentUser (por ejemplo, {{base url}}/Users/Users_GetCurrentUser).
Después de recuperar la respuesta GET que contiene el UserId, envía una solicitud GET al punto final GetUsersForFolder utilizando el nombre de la carpeta y el UserId como parámetros de entrada (por ejemplo, {{base url}}/Folders/UiPath.Server.Configuration.OData.GetUsersForFolder(key={{*FolderOrganizationUnitId*}},includeInherited=true)?$filter=Id eq{{userId}}).

Opción 2: nombre de usuario conocido

Esta opción se aplica a instancias en las que se conoce el nombre de usuario (normalmente esto solo se aplicará a las instancias locales de Orchestrator).

Con el nombre de usuario introducido, envía una solicitud GET al punto final GetAllRolesForUserByUsernameAndSkipYTake (por ejemplo, {{base url}}/Folders/UiPath.Server.Configuration.OData.GetAllRolesForUser(username='{{username}}',skip=0,take=0)).
- La respuesta incluye todas las carpetas para las que el usuario tiene permiso. Al analizar la respuesta, puedes verificar que incluye el Nombre de carpeta que introdujo el usuario y / o el IdDeUnidadDeOrganización que se recuperó en una solicitud anterior.
- La ventaja de usar esta opción es que puedes obtener el OrganizationUnitId de la carpeta y verificar los permisos en una sola solicitud.

Varios usuarios

Un conector puede tener varias conexiones autenticadas al mismo tenant de Orchestrator o a uno diferente. El propósito de varias conexiones es permitir que más de un usuario acceda y utilice las características del conector implementadas (por ejemplo, iniciar un trabajo, agregar elementos de la cola) sin compartir sus credenciales de Orchestrator.

Ejemplos

Esta sección proporciona enlaces a interfaces de usuario de conector de ejemplo y las solicitudes de la API de Orchestrator correspondientes para cada campo de entrada.