Method: users.list

Ruft eine paginierte Liste von gelöschten Nutzern oder allen Nutzern 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 der Schemanamen. Alle Felder aus diesen Schemas werden abgerufen. Dieser Wert sollte nur festgelegt werden, wenn projection=custom.

customer

string

Die eindeutige ID für das Google Workspace-Konto des Kunden. Bei Konten 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 zu repräsentieren. customerId wird auch als Teil der Ressource Users zurückgegeben. Du musst entweder den customer- oder den domain-Parameter 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. Es muss entweder der Parameter customer oder domain angegeben werden.

event

enum (Event)

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

maxResults

integer

Maximale Anzahl der zurückzugebenden Ergebnisse;

orderBy

enum (OrderBy)

Attribut, das zum Sortieren der Ergebnisse verwendet werden soll.

pageToken

string

Token zur Angabe der nächsten Seite in der Liste

projection

enum (Projection)

Welche Teilmenge der Felder für diesen Nutzer abzurufen ist.

query

string

Abfragestring für die Suche nach 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 (Groß- und Kleinschreibung ignorieren).

viewType

enum (ViewType)

Gibt an, ob die öffentliche Ansicht mit Administratorzugriff oder die gesamte Domain des Nutzers abgerufen werden soll. Weitere Informationen finden Sie im Hilfeartikel Nutzer als Nicht-Administrator 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

Dies ist die Art der Ressource.

trigger_event

string

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

etag

string

ETag der Ressource.

users[]

object (User)

Eine Liste der Nutzerobjekte.

nextPageToken

string

Token, mit dem auf die nächste Seite dieses Ergebnisses zugegriffen wird.

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.

Veranstaltung

Typ des Aboereignisses

Enums
ADD Vom Nutzer erstelltes Ereignis
DELETE Ereignis gelöscht
MAKE_ADMIN Änderungsereignis des Nutzeradministratorstatus
UNDELETE Nutzer hat Ereignis wiederhergestellt
UPDATE Ereignis „Nutzer aktualisiert“

OrderBy

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

Projektion

Enums
BASIC Fügen Sie keine benutzerdefinierten Felder für den Nutzer ein.
CUSTOM Benutzerdefinierte Felder aus Schemas einschließen, die in customFieldMask angefordert wurden.
FULL Alle mit diesem Nutzer verknüpften Felder einschließen.

SortOrder

Enums
ASCENDING Aufsteigende Reihenfolge.
DESCENDING Absteigend.

Ansichtstyp

Enums
admin_view Die Ergebnisse umfassen sowohl Felder, die nur für Administratoren und für öffentliche Domains verfügbar sind, für den Nutzer.
domain_public Die Ergebnisse enthalten nur Felder für den Nutzer, die für andere Nutzer in der Domain öffentlich sichtbar sind.