Method: groups.list

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

string

Die eindeutige ID für das Google Workspace-Konto des Kunden. Verwenden Sie bei einem Konto mit mehreren Domains 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 zu repräsentieren. Die customerId wird auch als Teil der Ressource Nutzer zurückgegeben. Sie müssen 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 ist 200.
orderBy

enum (OrderBy)

Spalte zum Sortieren der Ergebnisse
pageToken

string

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

string

Suche in Abfragestrings. Muss das Format "" haben. Die vollständige Dokumentation finden Sie unter https: //developers.google.com/admin-sdk/directory/v1/guides/search-groups
sortOrder

enum (SortOrder)

Gibt an, ob Ergebnisse in aufsteigender oder absteigender Reihenfolge zurückgegeben werden. 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 zusammen 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

Der Ressourcentyp.
etag

string

ETag der Ressource.
groups[]

object (Group)

Eine Liste von Gruppenobjekten.
nextPageToken

string

Token, das für den Zugriff auf die nächste Seite dieses Ergebnisses verwendet 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.