- Démarrage
- Lisez-moi
- À propos d'OData et des références
- URL d'Orchestrator
- Références d'API
- Ressources logiques et métadonnées
- Opérations disponibles
- Fichiers énumérés (Enumerated Files)
- Authentification
- Création des requêtes d'API
- Accèder aux ressources UiPath à l'aide d'applications externes
- Autorisations par point de terminaison
- Codes de réponse
- Points de terminaison de vérification de l'état
- Définition Swagger
- Exemples d'utilisation de l'API Orchestrator
- Demandes d'alertes
- Requêtes relatives aux actifs
- Requêtes de calendriers
- Requêtes relatives aux environnements
- Requêtes de dossiers
- Requêtes de tâches génériques
- Requêtes relatives aux tâches
- Requêtes relatives aux bibliothèques
- Requêtes relatives aux licences
- Requêtes relatives aux paquets (Packages Requests)
- Requêtes relatives aux autorisations
- Demandes d'espaces de travail personnels
- Requêtes relatives aux processus
- Demandes d'éléments de la file d'attente
- Requêtes relatives aux Robots
- Requêtes relatives aux rôles (Roles Requests)
- Requêtes relatives aux planifications
- Requêtes relatives aux paramètres
- Requêtes de tâches
- Demandes de catalogues de tâches
- Demandes de formulaires de tâches
- Requêtes relatives aux locataires
- Requêtes relatives aux transactions
- Requêtes relatives aux utilisateurs
- Requêtes relatives aux Webhooks
- API de gestion de plate-forme
- Gestion des utilisateurs
- Gestion des licences
Gestion des utilisateurs
Les API Gestion de la plate-forme (Platform Management) exposent les fonctionnalités de plate-forme suivantes :
|
Scénarios de gestion |
Méthodes d'authentification SQL |
|---|---|
|
Gestion des utilisateurs : créez, mettez à jour ou supprimez des utilisateurs ou des groupes, et gérez les paramètres de l'organisation |
Tous les appels d'API de gestion de la plate-forme (Platform Management) sont effectués à l'aide de méthodes HTTP vers l'URL de base.
https.
-
Pour les déploiements d'Automation Cloud et d'Automation Suite, toutes les URL d'Identity Server contiennent le segment
/identity_. -
Pour les déploiements autonomes, toutes les URL d'Identity Server contiennent le segment
/identity.
Les API Gestion de la plate-forme (Platform Management) permettent à votre application de contrôler les ressources suivantes :
Audit
- GET
{BaseURL}/identity/api/AuditQuery/{organizationId}: récupère les journaux d'audit pour l'ID d'organisation spécifié. {BaseURL}/identity/api/AuditQuery/{organizationId}/download: Télécharge les journaux d'audit pour l'ID d'organisation spécifié.
Groupe
- GET
{BaseURL}/identity/api/Group/{partitionGlobalId}: récupère tous les groupes locaux et intégrés de l'ID de partition spécifié (organisation ou locataire). - GET
{BaseURL}/identity/api/Group/{partitionGlobalId}/{groupId}- Récupère le groupe local ou intégré spécifié dans l'ID de partition spécifié. - POST
{BaseURL}/identity/api/Group- Crée un nouveau groupe local. - PUT
{BaseURL}/identity/api/Group/{groupId}: met à jour les informations d'un groupe local. - DELETE
{BaseURL}/identity/api/Group/{partitionGlobalId}: supprime tous les groupes locaux de l'ID de partition spécifié (organisation ou locataire). - DELETE
{BaseURL}/identity/api/Group/{partitionGlobalId}/{groupId}: supprime le groupe local spécifié.
MessageTemplate
- GET
{BaseURL}/identity/api/MessageTemplate: récupère un modèle de message à l'aide du filtre fourni. - GET
{BaseURL}/identity/api/MessageTemplate/{templateId}- Récupère le modèle de message spécifié. {BaseURL}/identity/api/MessageTemplate/{templateId}: Met à jour le modèle de message spécifié.
Compte Robot
- GET
{BaseURL}/identity/api/RobotAccount/{partitionGlobalId}- Récupère tous les comptes Robot dans l'ID de partition spécifié (organisation ou locataire). - GET
{BaseURL}/identity/api/RobotAccount/{partitionGlobalId}/{robotAccountId}- Récupère le compte de robot spécifié dans l'ID de partition spécifié. - POST
{BaseURL}/identity/api/RobotAccount- Crée un nouveau compte de robot. - PUT
{BaseURL}/identity/api/RobotAccount/{robotAccountId}: met à jour les informations du compte de robot spécifié. {BaseURL}/identity/api/RobotAccount/{partitionGlobalId}/{robotAccountId}: Supprime le compte Robot spécifié- DELETE
{BaseURL}/identity/api/RobotAccount/{partitionGlobalId}: supprime tous les comptes de robot dans l'ID de partition spécifié.
Paramètre
- GET
{BaseURL}/identity/api/Setting: récupère les paramètres d'une application en fonction d'une liste de clés pour un locataire spécifique. - PUT
{BaseURL}/identity/api/Setting: met à jour ou crée de nouveaux paramètres dans un locataire spécifique.
Utilisateur (User)
- GET
{BaseURL}/identity/api/User/{userId}- Récupère les informations sur l'utilisateur spécifié. - POST
{BaseURL}/identity/api/User: crée un nouvel utilisateur. Ce point de terminaison est idempotent : toute tentative d'écrasement d'un utilisateur entraîne la suppression de celui qui existe déjà. - POST
{BaseURL}/identity/api/User/BulkCreate: crée des utilisateurs en bloc. - POST
{BaseURL}/identity/api/User/{userId}/changepassword - Met à jour le mot de passe de l'utilisateur spécifié. - PUT
{BaseURL}/identity/api/User/{userId}: met à jour les informations utilisateur spécifiées. - SUPPRIMER
{BaseURL}/identity/api/User: supprime tous les utilisateurs. - DELETE
{BaseURL}/identity/api/User/{userId}: supprime l'utilisateur spécifié.
UserLoginAttempt
{BaseURL}/identity/api/User/{userId}/loginAttempts: Récupère les tentatives de connexion de l'utilisateur spécifié.
Les étendues définissent le niveau d'accès de votre application aux ressources de Gestion de la plate-forme (Platform Management).
Par exemple, pour générer un jeton d'authentification pour votre application, vous transmettez plusieurs étendues. Lorsque votre application effectue un appel API pour accéder à une ressource, le jeton est validé par rapport aux étendues des ressources. Si la ressource est incluse dans les étendues que vous avez transmises lors de la demande de jeton, l'appel aboutit et vérifie les autorisations utilisateur par point de terminaison (autorisations de Lecture (Read) pour les demandes GET et autorisations d'Écriture (Write) pour les demandes POST, PUT ou DELETE). Sinon, le serveur rejette l'appel.
Les autorisations accordent aux utilisateurs de votre application l'accès à une fonctionnalité spécifique à l'intérieur d'une ressource. Chaque autorisation est liée à une étendue. Une fois que votre application a réussi à accéder à la ressource, le serveur vérifie si l'utilisateur authentifié dispose des autorisations appropriées pour la méthode correspondante du point de terminaison.
Par exemple, vous pouvez empêcher certains utilisateurs de supprimer ou de mettre à jour des groupes d'utilisateurs, mais ils peuvent toujours les afficher.
De manière générale, les méthodes GET nécessitent des autorisations de Lecture (Read), tandis que les méthodes POST, PUT et DELETE nécessitent des autorisations d'Écriture (Write).
La table ci-dessous résume les étendues et les autorisations requises pour effectuer une action spécifique :
|
Ressource |
Étendues |
Autorisations |
|---|---|---|
|
Requête d'audit |
PM.Audit |
PM.Audit.Read (pour les requêtes GET) |
|
Groupe |
PM.Group |
PM.Audit.Read (pour les requêtes GET) PM.Group.Write (pour les requêtes POST, PUT et DELETE) |
|
MessageTemplate |
PM.MessageTemplate |
PM.MessageTemplate.Read (pour les requêtes GET) PM.MessageTemplate.Write (for PUT requests) |
|
Compte Robot |
PM.RobotAccount |
PM.RobotAccount.Read (pour les requêtes GET) PM.Group.Write (pour les requêtes POST, PUT et DELETE) |
|
Paramètre |
PM.Setting |
PM.Audit.Read (pour les requêtes GET) PM.Setting.Write (pour les requêtes PUT) |
|
Utilisateur (User) |
PM.User |
PM.Audit.Read (pour les requêtes GET) PM.Group.Write (pour les requêtes POST, PUT et DELETE) |
|
UserLoginAttempt |
PM.UserLoginAttempt |
PM.UserLoginAttempt.Read (pour les requêtes GET) |
