Ruft alle Gruppen einer Domain oder eines Nutzers mit einem userKey (paginiert) ab.
HTTP-Anfrage
GET https://admin.googleapis.com/admin/directory/v1/groups
Die URL verwendet die Syntax der gRPC-Transcodierung.
Abfrageparameter
Parameter | |
---|---|
customer |
Die eindeutige ID des Google Workspace-Kontos des Kunden. Bei einem Konto mit mehreren Domains können Sie dieses Feld anstelle von |
domain |
Der Domainname. Verwenden Sie dieses Feld, um Gruppen aus nur einer Domain abzurufen. Wenn alle Domains für ein Kundenkonto zurückgegeben werden sollen, verwenden Sie stattdessen den Abfrageparameter |
maxResults |
Maximale Anzahl der zurückzugebenden Ergebnisse; Der maximal zulässige Wert ist 200. |
orderBy |
Spalte zum Sortieren der Ergebnisse |
pageToken |
Token zur Angabe der nächsten Seite in der Liste |
query |
Suche nach Abfragezeichenfolge. Muss das Format „ |
sortOrder |
Gibt an, ob Ergebnisse in aufsteigender oder absteigender Reihenfolge zurückgegeben werden sollen. Nur zu verwenden, wenn auch „orderBy“ verwendet wird |
userKey |
E-Mail-Adresse oder unveränderliche ID des Nutzers, wenn nur die Gruppen aufgelistet werden sollen, in denen der jeweilige Nutzer Mitglied ist. Wenn es sich um eine ID handelt, muss sie mit der ID des Nutzerobjekts übereinstimmen. |
Anfragetext
Der Anfragetext muss leer sein.
Antworttext
Wenn der Vorgang erfolgreich ist, enthält der Antworttext Daten mit folgender Struktur:
JSON-Darstellung |
---|
{
"kind": string,
"etag": string,
"groups": [
{
object ( |
Felder | |
---|---|
kind |
Der Ressourcentyp. |
etag |
ETag der Ressource. |
groups[] |
Eine Liste von Gruppenobjekten. |
nextPageToken |
Token für den Zugriff auf die nächste Seite dieses Ergebnisses. |
Autorisierungsbereiche
Erfordert einen der folgenden OAuth-Bereiche:
https://apps-apis.google.com/a/feeds/groups/
https://www.googleapis.com/auth/admin.directory.group
https://www.googleapis.com/auth/admin.directory.group.readonly
Weitere Informationen finden Sie im Leitfaden zur Autorisierung.
OrderBy
Enums | |
---|---|
EMAIL |
E-Mail-Adresse der Gruppe. |
SortOrder
Enums | |
---|---|
ASCENDING |
Aufsteigende Reihenfolge. |
DESCENDING |
Absteigende Reihenfolge. |