- Démarrage
- Authentification
- Étendues et autorisations
- API de gestion de plate-forme
Guide de l'API Test Cloud
Renvoie une liste pages de membres appartenant à un groupe local spécifique, en fonction de l'organisation, de l'ID de groupe et des paramètres de pagination facultatifs.
Point de terminaison de l’API
GET {accessURL}/{organizationName}/identity_/api/Group/{partitionGlobalId}/{groupId}/Members
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 |
|---|---|
| Test Cloud | https://cloud.uipath.com/ |
| Test Cloud Secteur Public | https://govcloud.uipath.us/ |
| Test Cloud dédié | https://{customURL}.dedicated.uipath.com/ |
Étendues
Nécessite les étendues suivantes :
- PM.Group
- PM.Group.Read
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 de caractères (string) | L'ID de l'organisation contenant le groupe souhaité. |
groupId (requis) | Chaîne de caractères (string) | L'ID du groupe dont vous souhaitez récupérer les membres. |
Paramètres de requête
| Paramètre de requête | Type de données | Description |
|---|---|---|
top | Entier | Le nombre d'enregistrements à renvoyer. La valeur par défaut est 10. La plage est de 0 à 1000. |
skip | Entier | Le nombre d'enregistrements à ignorer. La valeur par défaut est 0. |
Réponses
200 OK
Une liste pages de membres du groupe est renvoyée, avec le nombre total.
Erreur 404 - Page introuvable
Le groupe spécifié est introuvable dans l’organisation donnée.
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 - Le
{groupId}est :2512
L’appel doit ressembler à l’exemple suivant (cURL) :
curl --location --request GET 'https://cloud.uipath.com/{organizationName}/identity_/api/Group/3fa85f64-5717-4562-b3fc-2c963f66afa6/2512/Members?top=10&skip=0' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json'
curl --location --request GET 'https://cloud.uipath.com/{organizationName}/identity_/api/Group/3fa85f64-5717-4562-b3fc-2c963f66afa6/2512/Members?top=10&skip=0' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json'
Voici la réponse pour un appel réussi :
{
"totalCount": 2,
"results": [
{
"id": "1787ef38-5933-4f2c-a67a-9c22cdb8e6a2",
"type": 0
},
{
"id": "a4c2e8b1-7d3f-4a91-b5e2-6f8d9c0e1a3b",
"type": 0
}
]
}
{
"totalCount": 2,
"results": [
{
"id": "1787ef38-5933-4f2c-a67a-9c22cdb8e6a2",
"type": 0
},
{
"id": "a4c2e8b1-7d3f-4a91-b5e2-6f8d9c0e1a3b",
"type": 0
}
]
}