automation-suite
2024.10
false
Automation Suite API-Handbuch
- Erste Schritte
- Authentication
- Scopes und Berechtigungen
- Plattformverwaltungs-APIs
- Alle Gruppen abrufen
- Bestimmte Gruppe abrufen
- Eine bestimmte Gruppe löschen
- Neue lokale Gruppe erstellen
- Update Group
Wichtig :
Bitte beachten Sie, dass dieser Inhalt teilweise mithilfe von maschineller Übersetzung lokalisiert wurde.
Es kann 1–2 Wochen dauern, bis die Lokalisierung neu veröffentlichter Inhalte verfügbar ist.
Gibt Informationen zu einer Gruppe basierend auf der Organisations- und Gruppen-ID zurück.
API-Endpunkt
GET https://{yourDomain}/{organizationName}/identity_/api/Group/{partitionGlobalId}/{groupId}
Scopes
Folgende Scopes sind erforderlich:
PM.GroupPM.Group.Read
Anforderungsheader
--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'
--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'
Hinweis:
Um das {access_token} zu erhalten, müssen Sie sich mit einer der unter Authentifizierungsmethoden beschriebenen Methoden authentifizieren.
Pfadparameter
| Parameter | Datentyp | Beschreibung |
|---|---|---|
partitionGlobalId | String | Erforderlich. Die ID der Organisation, die die gewünschte Gruppe enthält. |
groupID | String | Erforderlich. Die ID der Gruppe, die Sie abfragen möchten. |
Antworten
200 OK
Die angegebenen Gruppeninformationen werden zurückgegeben.
Beispielanforderung
Angenommen, Sie haben alle Informationen gesammelt, die zum Erstellen des API-Aufrufs erforderlich sind.
- Ihre
{baseURL}ist:https://{yourDomain}/{organizationName}/{tenantName}/ - Ihre
{access_token}ist:1234(aus Gründen der Länge). - Die
{partitionGlobalId}lautet:magic-7 - Die
{groupID}lautet:2512
Der Aufruf sollte dem folgenden Beispiel ähneln (cURL):
curl --location --request GET 'https://{yourDomain}/{organizationName}/{tenantName}/identity_/api/Group/magic-7/2512' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json'
curl --location --request GET 'https://{yourDomain}/{organizationName}/{tenantName}/identity_/api/Group/magic-7/2512' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json'
Hier ist der Antworttext für einen erfolgreichen Aufruf:
{
"id": "2512",
"name": "Automation Developers",
"displayName": "Automation Developers",
"type": 0,
"creationTime": "2021-10-19T14:25:01.6574988",
"lastModificationTime": "2021-10-19T14:25:01.6574988",
"members": [
{
"objectType": "DirectoryUser",
"firstName": "Albus",
"lastName": "D",
"jobTitle": "master",
"companyName": "Hogwarts",
"city": "London",
"department": "magic",
"displayName": "Albus D",
"source": "local",
"identifier": "1787ef38-5933-4f2c-a67a-9c22cdb8e6a2",
"name": "albus",
"email": "albus@hogwarts.com"
}
]
}
{
"id": "2512",
"name": "Automation Developers",
"displayName": "Automation Developers",
"type": 0,
"creationTime": "2021-10-19T14:25:01.6574988",
"lastModificationTime": "2021-10-19T14:25:01.6574988",
"members": [
{
"objectType": "DirectoryUser",
"firstName": "Albus",
"lastName": "D",
"jobTitle": "master",
"companyName": "Hogwarts",
"city": "London",
"department": "magic",
"displayName": "Albus D",
"source": "local",
"identifier": "1787ef38-5933-4f2c-a67a-9c22cdb8e6a2",
"name": "albus",
"email": "albus@hogwarts.com"
}
]
}