- Démarrage
- Authentification
- Étendues et autorisations
- API de gestion de plate-forme
Guide d'administration d'Automation Cloud
Résout une entité d'annuaire unique par son nom et son type, en fonction de l'ID de l'organisation.
Point de terminaison de l’API
POST {accessURL}/{organizationName}/identity_/api/Directory/ResolveByName/{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 dans lequel résoudre l’entité. |
Corps de la requête
Le corps de la requête spécifie l’entité à résoudre par nom.
{
"entityName": "string",
"entityType": "User"
}
{
"entityName": "string",
"entityType": "User"
}
| Propriété | Type de données | Description |
|---|---|---|
entityName (requis) | Chaîne de caractères (string) | Le nom de l'entité de l'annuaire (par exemple, adresse e-mail pour les utilisateurs, nom de groupe pour les groupes). |
entityType (requis) | Chaîne de caractères (string) | Type d'entité d'annuaire. Valeurs valides: User, Group, Application. |
Réponses
200 OK
Renvoie l’entité de répertoire complète. La forme de la réponse est la même que celle du point de terminaison Résoudre (varie selon le type d'entité).
Erreur 404 - Page introuvable
Renvoyé lorsque l’entité ou la partition est introuvable.
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 un utilisateur par son e-mail
john.doe@example.com.
L’appel doit ressembler à l’exemple suivant (cURL) :
curl --location --request POST 'https://cloud.uipath.com/{organizationName}/identity_/api/Directory/ResolveByName/3fa85f64-5717-4562-b3fc-2c963f66afa6' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json' \
--data-raw '{
"entityName": "john.doe@example.com",
"entityType": "User"
}'
curl --location --request POST 'https://cloud.uipath.com/{organizationName}/identity_/api/Directory/ResolveByName/3fa85f64-5717-4562-b3fc-2c963f66afa6' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json' \
--data-raw '{
"entityName": "john.doe@example.com",
"entityType": "User"
}'
Voici la réponse pour un appel réussi :
{
"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",
"jobTitle": "Software Engineer",
"companyName": "Contoso",
"city": "Seattle",
"department": "Engineering",
"isActive": true,
"creationTime": "2025-01-15T10:30:00Z"
}
{
"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",
"jobTitle": "Software Engineer",
"companyName": "Contoso",
"city": "Seattle",
"department": "Engineering",
"isActive": true,
"creationTime": "2025-01-15T10:30:00Z"
}