Method: groups.list

Ruft alle Gruppen einer Domain oder eines Nutzers mit einem Nutzerschlüssel ab (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. Wenn Sie bei einem mehrdomänenfähigen Konto alle Gruppen für einen Kunden abrufen möchten, verwenden Sie dieses Feld anstelle von domain. Sie können auch den Alias my_customer verwenden, um die customerId Ihres Kontos zu repräsentieren. Die customerId wird auch als Teil der Ressource Nutzer zurückgegeben. Sie müssen entweder den Parameter customer oder den Parameter domain angeben.
domain

string

Der Domainname. Verwenden Sie dieses Feld, um Gruppen nur aus 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 ist 200.
orderBy

enum (OrderBy)

Spalte, die zum Sortieren der Ergebnisse verwendet werden soll
pageToken

string

Token, um die nächste Seite in der Liste anzugeben
query

string

Abfragestring-Suche Muss das Format „“ haben. Die vollständige Dokumentation finden Sie unter https: //developers.google.com/workspace/admin/directory/v1/guides/search-groups.
sortOrder

enum (SortOrder)

Ob die Ergebnisse in aufsteigender oder absteigender Reihenfolge zurückgegeben werden sollen. Nur sinnvoll, 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 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, mit dem auf die nächste Seite dieses Ergebnisses zugegriffen wird.

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.