Method: users.list

Ruft eine paginaierte Liste entweder gelöschter Nutzer oder aller Nutzer in einer Domain ab.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Abfrageparameter

Parameter
customFieldMask

string

Eine durch Kommas getrennte Liste von Schemanamen. Alle Felder aus diesen Schemas werden abgerufen. Dieser sollte nur festgelegt werden, wenn projection=custom.
customer

string

Die eindeutige ID für das Google Workspace-Konto des Kunden. Wenn es sich um ein Mehrfachdomainkonto handelt, verwenden Sie dieses Feld anstelle von domain, um alle Nutzer 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 entweder den Parameter customer oder den Parameter domain angeben.
domain

string

Der Domainname. Verwenden Sie dieses Feld, um nur Nutzer aus einer Domain abzurufen. Wenn Sie alle Domains für ein Kundenkonto zurückgeben möchten, verwenden Sie stattdessen den Abfrageparameter customer. Es muss entweder der Parameter customer oder der Parameter domain angegeben werden.
event

enum (Event)

Ereignis, für das das Abo bestimmt ist (falls Abo)
maxResults

integer

Maximale Anzahl der zurückzugebenden Ergebnisse.
orderBy

enum (OrderBy)

Property, nach der die Ergebnisse sortiert werden sollen.
pageToken

string

Token, um die nächste Seite in der Liste anzugeben. Das Seitentoken ist nur drei Tage lang gültig.
projection

enum (Projection)

Welche Teilmenge von Feldern für diesen Nutzer abgerufen werden soll.
query

string

Suchstring für die Suche in Nutzerfeldern. Weitere Informationen zum Erstellen von Nutzerabfragen finden Sie unter Nach Nutzern suchen.
showDeleted

string

Wenn true festgelegt ist, wird die Liste der gelöschten Nutzer abgerufen. (Standard: false)
sortOrder

enum (SortOrder)

Gibt an, ob die Ergebnisse in aufsteigender oder absteigender Reihenfolge zurückgegeben werden sollen, wobei die Groß- und Kleinschreibung ignoriert wird.
viewType

enum (ViewType)

Gibt an, ob die öffentliche Ansicht des Nutzers nur für Administratoren oder domainweit abgerufen werden soll. Weitere Informationen finden Sie im Hilfeartikel Nutzer als Nichtadministrator abrufen.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Wenn der Vorgang erfolgreich ist, enthält der Antworttext Daten mit folgender Struktur:

JSON-Darstellung 
{
  "kind": string,
  "trigger_event": string,
  "etag": string,
  "users": [
    {
      object (User)
    }
  ],
  "nextPageToken": string
}
Felder
kind

string

Art der Ressource.
trigger_event

string

Ereignis, das diese Antwort ausgelöst hat (nur bei Push-Antworten verwendet)
etag

string

ETag der Ressource.
users[]

object (User)

Eine Liste von Nutzerobjekten.
nextPageToken

string

Token, mit dem auf die nächste Seite dieses Ergebnisses zugegriffen wird. Das Seitentoken ist nur drei Tage lang gültig.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/admin.directory.user
  • https://www.googleapis.com/auth/admin.directory.user.readonly
  • https://www.googleapis.com/auth/cloud-platform

Weitere Informationen finden Sie im Leitfaden zur Autorisierung.

Ereignis

Typ des Aboereignisses

Enums
ADD Von Nutzern erstelltes Ereignis
DELETE Vom Nutzer gelöschtes Ereignis
MAKE_ADMIN Ereignis: Änderung des Admin-Status eines Nutzers
UNDELETE Ereignis: Nutzer wiederhergestellt
UPDATE Von Nutzern aktualisiertes Ereignis

OrderBy

Enums
EMAIL Primäre E-Mail-Adresse des Nutzers.
FAMILY_NAME Der Nachname des Nutzers.
GIVEN_NAME Der Vorname des Nutzers.

Projektion

Enums
BASIC Fügen Sie keine benutzerdefinierten Felder für den Nutzer hinzu.
CUSTOM Fügen Sie benutzerdefinierte Felder aus Schemas hinzu, die in customFieldMask angefordert wurden.
FULL Fügen Sie alle mit diesem Nutzer verknüpften Felder hinzu.

SortOrder

Enums
ASCENDING Aufsteigende Reihenfolge.
DESCENDING Absteigende Reihenfolge.

ViewType

Enums
admin_view Die Ergebnisse enthalten sowohl Felder, die nur für Administratoren sichtbar sind, als auch für alle Nutzer in der Domain.
domain_public Die Ergebnisse enthalten nur Felder für den Nutzer, die für andere Nutzer in der Domain öffentlich sichtbar sind.