- Erste Schritte
- Authentication
- Scopes und Berechtigungen
- Plattformverwaltungs-APIs
Test Cloud-API-Handbuch
Gibt eine Seitenliste mit Mitgliedern zurück, die zu einer bestimmten lokalen Gruppe gehören, basierend auf der Organisation, Gruppen-ID und optionalen Seitenparametern.
API-Endpunkt
GET {accessURL}/{organizationName}/identity_/api/Group/{partitionGlobalId}/{groupId}/Members
Ersetzen Sie {accessURL} in allen Endpunktpfaden durch die Basis-URL für Ihre Cloud-Plattform:
| Cloud Platform | Zugriffs-URL |
|---|---|
| Test Cloud | https://cloud.uipath.com/ |
| Test Cloud Public Sector | https://govcloud.uipath.us/ |
| Test Cloud Dedicated. | https://{customURL}.dedicated.uipath.com/ |
Scopes
Folgende Scopes sind erforderlich:
- PM.Group
- PM.Group.Read
Anforderungsheader
--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'
--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'
Um das {access_token} zu erhalten, müssen Sie sich mit einer der hier beschriebenen Methoden authentifizieren.
Pfadparameter
| Pfadparameter | Datentyp | Beschreibung |
|---|---|---|
partitionGlobalId (erforderlich) | String | Die ID der Organisation, die die gewünschte Gruppe enthält. |
groupId (erforderlich) | String | Die ID der Gruppe, deren Mitglieder Sie abrufen möchten. |
Abfrageparameter
| Abfrageparameter | Datentyp | Beschreibung |
|---|---|---|
top | Integer | Die Anzahl der zurückzugebenden Datensätze. Die Standardeinstellung ist 10. Bereich ist 0 bis 1000. |
skip | Integer | Die Anzahl der zu überspringenden Datensätze. Die Standardeinstellung ist 0. |
Antworten
200 OK
Eine Seitenliste der Gruppenmitglieder wird zusammen mit der Gesamtanzahl zurückgegeben.
404 Nicht gefunden
Die angegebene Gruppe wurde in der angegebenen Organisation nicht gefunden.
Beispielanforderung
Angenommen, Sie haben alle Informationen gesammelt, die zum Erstellen des API-Aufrufs erforderlich sind.
- Ihre
{baseURL}ist:https://cloud.uipath.com/{organizationName}/identity_ - Ihre
{access_token}ist:1234(aus Gründen der Länge). - Die
{partitionGlobalId}lautet:3fa85f64-5717-4562-b3fc-2c963f66afa6 - Die
{groupId}lautet:2512
Der Aufruf sollte dem folgenden Beispiel ähneln (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'
Hier ist der Antworttext für einen erfolgreichen Aufruf:
{
"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
}
]
}