Requêtes relatives aux utilisateurs

Remarque :

• Les requêtes GET aux points de terminaison /odata/Users ou /odata/Users({}) renvoient un domaine vide pour les utilisateurs AD.
• Les requêtes GetOrganizationUnits(Id) et GetRoles(Id) ne renvoient que les dossiers et les rôles explicitement définis pour un utilisateur enregistré automatiquement. Ceux hérités de la configuration du groupe peuvent être récupérés via le point de terminaison /api/DirectoryService/GetDirectoryPermissions?userId={userId}.

Suppression d'un utilisateur

Supprimer (Delete)

https://{yourDomain}/odata/Users(446)

En-têtes de requête.

Clé (Key)	Valeur (Value)
Autorisation	Porteur

Codes de réponse

204 Aucun contenu

Modification de la langue

L'exemple suivant vous permet de remplacer la langue de l'utilisateur avec l'ID 749 par le japonais.

Publier

https://{yourDomain}/odata/Users(749)/UiPath.Server.Configuration.OData.ChangeUserCulture

En-têtes de requête.

Clé (Key)	Valeur (Value)
Autorisation	Porteur

Corps de la requête

{
    "culture": "ja"
}

Codes de réponse

200 OK

Approvisionnement d'un Robot pour un utilisateur

METTRE

https://{yourDomain}/odata/Users(13)

En-têtes de requête.

Clé (Key)	Valeur (Value)
Autorisation	Porteur

Corps de la requête

{
  "RobotProvision": {
     "UserName": "uipath\\john.smith",
     "RobotId": 53,
     "RobotType": "Development",
     "ExecutionSettings": {}
  }
}

Codes de réponse

200 OK

Attribution de rôles

Vous pouvez utiliser ce point de terminaison pour attribuer un ou plusieurs rôles à l'ID utilisateur spécifié, qui peut être l'ID d'un groupe, d'un compte d'utilisateur ou d'un compte de robot.

Publier

https://{yourDomain}/odata/Users(9)/UiPath.Server.Configuration.OData.AssignRoles

En-têtes de requête.

Clé (Key)	Valeur (Value)
Autorisation	Porteur

Corps de la requête

{
  "roleIds": [
    1,3
  ]
}

Exemple

La requête ci-dessous met à jour le compte ou le groupe avec l'ID utilisateur 9 en remplaçant les rôles qui lui sont attribués par les rôles qui ont les ID 1 et 3.

Rôles avant la demande	Rôles après demande	Modifications
Aucun rôle.	1 et 3	Les rôles avec les ID 1 et 3 ont été attribués.
Rôles avec les ID 1 et 2	1 et 3	Le rôle avec l'ID 2 a été supprimé et le rôle avec l'ID 3 a été attribué.
Rôle avec l'ID 2	1 et 3	Le rôle avec l'ID 2 a été supprimé et les rôles avec les ID 1 et 3 ont été attribués.

cURL

curl -X POST "https://{yourDomain}/odata/Users({key})/UiPath.Server.Configuration.OData.AssignRoles" -H "accept: application/json" -H "Content-Type: application/json" -d "{ \"roleIds\": [ {RoleID1},{RoleID2} ] }"

Swagger UI (disponible sur https://https://{yourDomain}/swagger)

Pas à pas

Voici un exemple de procédure expliquant comment attribuer des rôles à un compte :

1. Envoyez une requête GET à /odata/Roles pour récupérer la liste actuelle des rôles.

   Vous pouvez utiliser n'importe quel type de filtre pris en charge par OData, si nécessaire.

2. Notez les ID des rôles que vous souhaitez attribuer.
3. Envoyez une requête GET à /odata/Users pour récupérer la liste actuelle des rôles.

   La liste comprend des groupes, des comptes d'utilisateurs et des comptes de robot.

   Vous pouvez utiliser n'importe quel type de filtre pris en charge par OData, si nécessaire.

4. Notez les ID des comptes auxquels vous souhaitez attribuer des rôles.
5. Faites une requête POST à /odata/Users({key})/UiPath.Server.Configuration.OData.AssignRoles pour chaque compte auquel vous souhaitez attribuer des rôles.
   • {key} est un ID de compte unique pour le compte auquel vous souhaitez attribuer des rôles
   • {roleID} est un ID de rôle unique pour le rôle que vous souhaitez attribuer ; vous pouvez répertorier plusieurs ID, séparés par une virgule.