- Démarrage
- Authentification
- Étendues et autorisations
- API de gestion de plate-forme
Guide d'administration d'Automation Cloud
Résout plusieurs entités de répertoire par leurs noms dans une seule requête, en fonction de l'ID de l'organisation. Toutes les entités de la requête doivent être du même type.
Point de terminaison de l’API
POST {accessURL}/{organizationName}/identity_/api/Directory/BulkResolveByName/{partitionGlobalId}
Remplacez {accessURL} dans tous les chemins de point de terminaison par l'URL de base de votre plate-forme cloud :
| Cloud Platform | URL d'accès |
|---|---|
| Automation Cloud | https://cloud.uipath.com/ |
| Automation Cloud pour le Secteur public | https://govcloud.uipath.us/ |
| Cloud d'automatisation dédié | https://{customURL}.dedicated.uipath.com/ |
Étendues
Nécessite les étendues suivantes :
- PM.Répertoire
En-têtes de requête.
--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'
--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'
Pour obtenir le {access_token}, assurez-vous de vous authentifier via l'une des méthodes décrites ici.
Paramètres de chemin d'accès
| Paramètre du chemin d'accès | Type de données | Description |
|---|---|---|
partitionGlobalId (requis) | Chaîne (GUID) | L'ID de l'organisation au sein de laquelle résoudre les entités. |
Corps de la requête
Le corps de la requête spécifie les noms d'entité à résoudre. Contrairement à BulkResolution, toutes les entités doivent être du même type.
{
"entityNames": [
"john.doe@example.com",
"jane.smith@example.com"
],
"entityType": "User",
"scope": null
}
{
"entityNames": [
"john.doe@example.com",
"jane.smith@example.com"
],
"entityType": "User",
"scope": null
}
| Propriété | Type de données | Description |
|---|---|---|
entityNames (requis) | Tableau de chaînes | Les noms des entités de l'annuaire à résoudre (par exemple, adresses e-mail pour les utilisateurs, noms de groupe pour les groupes). |
entityType (requis) | Chaîne de caractères (string) | Type de toutes les entités de la requête. Valeurs valides: User, Group, Application. |
scope (facultatif) | Chaîne de caractères (string) | Étendue facultative pour les entités Active Directory. |
Réponses
200 OK
Renvoie un dictionnaire mappant chaque nom d'entité à son entité de répertoire résolue. Les entités qui n'ont pas pu être résolues sont renvoyées en tant que null.
{
"john.doe@example.com": {
"objectType": "DirectoryUser",
"source": "aad",
"identifier": "aad|a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"name": "john.doe@example.com",
"email": "john.doe@example.com",
"displayName": "John Doe",
"firstName": "John",
"lastName": "Doe"
},
"jane.smith@example.com": null
}
{
"john.doe@example.com": {
"objectType": "DirectoryUser",
"source": "aad",
"identifier": "aad|a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"name": "john.doe@example.com",
"email": "john.doe@example.com",
"displayName": "John Doe",
"firstName": "John",
"lastName": "Doe"
},
"jane.smith@example.com": null
}
400 Requête incorrecte
Renvoyé lorsque des paramètres requis sont manquants ou non valides.
Exemple de requête
Supposons que vous ayez rassemblé toutes les informations nécessaires pour créer l'appel d'API.
- Votre
{baseURL}est : https://cloud.uipath.com/{organizationName}/identity_ - Votre
{access_token}est :1234(pour des considérations de longueur). - Le
{partitionGlobalId}est :3fa85f64-5717-4562-b3fc-2c963f66afa6 - Vous souhaitez résoudre deux utilisateurs par leurs adresses e-mail.
L’appel doit ressembler à l’exemple suivant (cURL) :
curl --location --request POST 'https://cloud.uipath.com/{organizationName}/identity_/api/Directory/BulkResolveByName/3fa85f64-5717-4562-b3fc-2c963f66afa6' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json' \
--data-raw '{
"entityNames": [
"john.doe@example.com",
"jane.smith@example.com"
],
"entityType": "User"
}'
curl --location --request POST 'https://cloud.uipath.com/{organizationName}/identity_/api/Directory/BulkResolveByName/3fa85f64-5717-4562-b3fc-2c963f66afa6' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json' \
--data-raw '{
"entityNames": [
"john.doe@example.com",
"jane.smith@example.com"
],
"entityType": "User"
}'
Voici la réponse pour un appel réussi :
{
"john.doe@example.com": {
"objectType": "DirectoryUser",
"source": "aad",
"identifier": "aad|a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"name": "john.doe@example.com",
"email": "john.doe@example.com",
"displayName": "John Doe",
"firstName": "John",
"lastName": "Doe"
},
"jane.smith@example.com": null
}
{
"john.doe@example.com": {
"objectType": "DirectoryUser",
"source": "aad",
"identifier": "aad|a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"name": "john.doe@example.com",
"email": "john.doe@example.com",
"displayName": "John Doe",
"firstName": "John",
"lastName": "Doe"
},
"jane.smith@example.com": null
}