- Démarrage
- Authentification
- Étendues et autorisations
- API de gestion de plate-forme
Point de terminaison d'API qui recherche dans le répertoire les utilisateurs, les groupes ou les applications correspondant à une chaîne de préfixe au sein d'une organisation.
Recherche dans le répertoire les entités (utilisateurs, groupes ou applications) correspondant à une chaîne de préfixe, en fonction de l’ID de l’organisation.
Point de terminaison de l’API
GET {accessURL}/{organizationName}/identity_/api/Directory/Search/{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 la recherche doit être effectuée. |
Paramètres de requête
| Paramètre de requête | Type de données | Description |
|---|---|---|
startsWith (requis) | Chaîne de caractères (string) | La chaîne de préfixe à rechercher. Les résultats correspondront aux entités dont le nom, l’e-mail ou le nom complet commence par cette valeur. |
entityType (facultatif) | Chaîne de caractères (string) | Le type d'entité de répertoire à rechercher. Valeurs valides: User, Group, Application. Ne peut pas être utilisé avec sourceFilter. |
sourceFilter (facultatif) | Tableau de chaînes | Filtre les résultats par source. Valeurs valides: LocalUsers, DirectoryUsers, LocalGroups, DirectoryGroups, RobotAccounts, Applications. Ne peut pas être utilisé avec entityType. |
scope (facultatif) | Chaîne de caractères (string) | Étendue facultative utilisée pour les entités d'Active Directory. |
Réponses
200 OK
Renvoie une liste d’entités d’annuaire correspondant aux critères de recherche.
[
{
"source": "aad",
"identifier": "aad|a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"identityName": "john.doe@example.com",
"displayName": "John Doe",
"email": "john.doe@example.com",
"type": "User",
"objectType": "DirectoryUser"
},
{
"source": "aad",
"identifier": "aad|b2c3d4e5-f6a7-8901-bcde-f12345678901",
"identityName": "Engineering Team",
"displayName": "Engineering Team",
"email": null,
"type": "Group",
"objectType": "DirectoryGroup"
}
]
[
{
"source": "aad",
"identifier": "aad|a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"identityName": "john.doe@example.com",
"displayName": "John Doe",
"email": "john.doe@example.com",
"type": "User",
"objectType": "DirectoryUser"
},
{
"source": "aad",
"identifier": "aad|b2c3d4e5-f6a7-8901-bcde-f12345678901",
"identityName": "Engineering Team",
"displayName": "Engineering Team",
"email": null,
"type": "Group",
"objectType": "DirectoryGroup"
}
]
400 Requête incorrecte
Renvoyé lorsque les paramètres entityType et sourceFilter sont fournis, ou lorsque des paramètres requis sont manquants.
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 rechercher des utilisateurs dont le nom commence par « john».
L’appel doit ressembler à l’exemple suivant (cURL) :
curl --location --request GET 'https://cloud.uipath.com/{organizationName}/identity_/api/Directory/Search/3fa85f64-5717-4562-b3fc-2c963f66afa6?startsWith=john&entityType=User' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json'
curl --location --request GET 'https://cloud.uipath.com/{organizationName}/identity_/api/Directory/Search/3fa85f64-5717-4562-b3fc-2c963f66afa6?startsWith=john&entityType=User' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json'
Voici la réponse pour un appel réussi :
[
{
"source": "aad",
"identifier": "aad|a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"identityName": "john.doe@example.com",
"displayName": "John Doe",
"email": "john.doe@example.com",
"type": "User",
"objectType": "DirectoryUser"
}
]
[
{
"source": "aad",
"identifier": "aad|a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"identityName": "john.doe@example.com",
"displayName": "John Doe",
"email": "john.doe@example.com",
"type": "User",
"objectType": "DirectoryUser"
}
]