Comment s'authentifier

L'authentification avec l'API UiPath Orchestrator dépend du type d'instance Orchestrator auquel vous vous connectez. Il existe deux types d'instances Orchestrator, qui utilisent tous deux un jeton de porteur pour l'authentification : Cloud Orchestrator et On-premise Orchestrator.

Points de terminaison et entrées

Du point de vue de l'authentification, il existe deux différences principales entre les types d'instances. Le premier est le point de terminaison auquel vous envoyez des demandes et le second les entrées requises pour les demandes d'authentification.

Le tableau ci-dessous affiche les différents points de terminaison et entrées pour chaque type d'instance, ainsi que des liens vers la documentation de l'API applicable.

	Cloud Orchestrator	On-Premise Orchestrator
Endpoint	https://account.uipath.com/oauth/token	https://{{orchestrator-url}}/api/Account/Authenticate
Entrées	Nom logique du compte Nom logique du locataire ID de client Clé d’utilisateur Dossier (facultatif)	URL d'Orchestrator Nom du locataire Orchestrator E-mail ou nom d'utilisateur Mot de passe (Password) Dossier (facultatif)
Requête/Réponse	API Swagger Facteur	API Swagger Facteur

Remarque : Cloud Orchestrator : pour plus d'informations sur la façon dont un utilisateur peut localiser son ID de client ( Client Id), sa clé utilisateur ( User Key), son nom logique de compte ( Account Logical Name) et son nom logique de locataire ( Tenant Logical Name), consultez la section Obtenir les informations d'accès à l'API ( Getting the API Access Information ) dans la documentation de l'API Orchestrator.

Dossiers

Les deux types d'instance incluent une entrée Dossier ( Folder) facultative. Les dossiers vous permettent de garder un contrôle précis sur les automatisations et leurs entités intrinsèques, ainsi que sur le personnel de l'ensemble de l'organisation. Deux types de dossiers sont disponibles dans Orchestrator : Classique et Moderne. Les dossiers classiques sont activés par défaut, tandis que la fonctionnalité de dossiers modernes doit être activée par l'administrateur d'hôte ou de locataire.

Si un utilisateur entre une valeur Dossier (Folder), vous devez récupérer l' IDUnitéOrganisation (OrganizationUnitId) du dossier. Cet identifiant doit être inclus dans l'en-tête de toutes les requêtes API ultérieures une fois l'authentification terminée.

Comment obtenir une valeur IDUnitéOrganisation (OrganizationUnitId) de dossier ?

Pour récupérer l' OrganizationUnitId, vous devez connaître le nom du dossier et suivre les requêtes de l'API répertoriées ci-dessous.

En utilisant le nom de dossier (Folder Name) comme paramètre d'entrée, envoyez une requête GET au point de terminaison GetFolders (par exemple, {{base url}}/odata/Folders?$filter=FullyQualifiedName eq '{{FolderName}}').

Lorsque le nom d’utilisateur de l’utilisateur est connu, vous pouvez également récupérer l’ OrganizationUnitId du dossier et vérifier ses autorisations en une seule requête. Pour plus d'informations, voir ci-dessous.

Comment vérifier les autorisations de dossier ?

Il existe plusieurs façons de vérifier si un utilisateur est autorisé à accéder à un dossier spécifique. La façon dont vous vérifiez les autorisations dépend de la possession ou non du nom d'utilisateur (pas de l'e-mail) de l'utilisateur.

Option 1 – nom d’utilisateur inconnu

Cette option s'applique aux instances Cloud Orchestrator, ainsi qu'aux instances On-premise Orchestrator où seul l'e-mail de l'utilisateur est connu.

À l'aide des informations d'identification saisies, récupérez le UserId de l'utilisateur en envoyant une requête GET au point de terminaison GetCurrentUser (par exemple, {{base url}}/Users/Users_GetCurrentUser).
Après avoir récupéré la réponse GET qui contient UserId, envoyez une requête GET au point de terminaison GetUsersForFolder en utilisant le nom de dossier et l' UserId comme paramètres d'entrée (par exemple, {{base url}}/Folders/UiPath.Server.Configuration.OData.GetUsersForFolder(key={{*FolderOrganizationUnitId*}},includeInherited=true)?$filter=Id eq{{userId}}).

Option 2 – nom d’utilisateur connu

Cette option s'applique aux instances pour lesquelles le nom d'utilisateur est connu (en général, cela ne s'applique qu'aux instances d'Orchestrator sur site).

À l'aide du nom d'utilisateur saisi, envoyez une requête GET au point de terminaison GetAllRolesForUserByUsernameAndSkipAndTake (par exemple, {{base url}}/Folders/UiPath.Server.Configuration.OData.GetAllRolesForUser(username='{{username}}',skip=0,take=0)).
- La réponse inclut tous les dossiers auxquels l'utilisateur est autorisé à accéder. En analysant la réponse, vous pouvez vérifier qu'elle inclut le nom de dossier saisi par l'utilisateur et/ou l' ID d'unité d' organisation (OrganizationUnitId) récupéré lors d'une requête précédente.
- L'avantage de cette option est que vous pouvez obtenir l' OrganizationUnitId du dossier et vérifier les autorisations en une seule requête.

Utilisateurs multiples

Un connecteur peut avoir plusieurs connexions authentifiées au même locataire Orchestrator ou à un autre locataire. Le but des connexions multiples est de permettre à plusieurs utilisateurs d'accéder aux fonctionnalités de connecteur implémentées et de les utiliser (par exemple, démarrer une tâche, ajouter des éléments de file d'attente) sans partager leurs informations d'identification Orchestrator.

Exemples

Cette section fournit des liens vers des exemples d'interfaces utilisateur de connecteur et les requêtes de l'API Orchestrator correspondantes pour chaque champ d'entrée.