Method: groups.list

Ruft alle Gruppen einer Domain oder eines Nutzers ab, wenn ein userKey angegeben ist (paginiert).

HTTP-Anfrage

GET https://admin.googleapis.com/admin/directory/v1/groups

Die URL verwendet die Syntax der gRPC-Transcodierung.

Abfrageparameter

Parameter
customer

string

Die eindeutige ID für das Google Workspace-Konto des Kunden. Bei einem Konto mit mehreren Domains verwenden Sie dieses Feld anstelle von domain, um alle Gruppen für einen Kunden abzurufen. Sie können auch den Alias my_customer verwenden, um die customerId Ihres Kontos darzustellen. Die customerId wird auch als Teil der Users-Ressource zurückgegeben. Sie müssen entweder den Parameter customer oder domain angeben.
domain

string

Der Domainname. Verwenden Sie dieses Feld, um Gruppen aus nur einer Domain abzurufen. Wenn Sie alle Domains für ein Kundenkonto zurückgeben möchten, verwenden Sie stattdessen den Abfrageparameter customer.
maxResults

integer

Maximale Anzahl der zurückzugebenden Ergebnisse. Der maximal zulässige Wert beträgt 200.
orderBy

enum (OrderBy)

Spalte, die zum Sortieren der Ergebnisse verwendet werden soll
pageToken

string

Token zum Angeben der nächsten Seite in der Liste
query

string

Suche nach Abfragestring. Enthält einen oder mehrere Suchbegriffe, die jeweils ein Feld, einen Operator und einen Wert enthalten. Die vollständige Dokumentation finden Sie unter Nach Gruppen suchen.
sortOrder

enum (SortOrder)

Gibt an, ob die Ergebnisse in aufsteigender oder absteigender Reihenfolge zurückgegeben werden sollen. Nur nützlich, wenn auch „orderBy“ verwendet wird
userKey

string

E‑Mail-Adresse oder unveränderliche ID des Nutzers, wenn nur die Gruppen aufgeführt werden sollen, in denen der angegebene Nutzer Mitglied ist. Wenn es sich um eine ID handelt, muss sie mit der ID des Nutzerobjekts übereinstimmen. Kann nicht mit dem Parameter customer verwendet werden.

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 (Group)
    }
  ],
  "nextPageToken": string
}
Felder
kind

string

Art der Ressource.
etag

string

ETag der Ressource.
groups[]

object (Group)

Eine Liste von Gruppenobjekten.
nextPageToken

string

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 Autorisierungsleitfaden.

OrderBy

Enums
EMAIL E‑Mail-Adresse der Gruppe.

SortOrder

Enums
ASCENDING Aufsteigende Reihenfolge.
DESCENDING Absteigende Reihenfolge.