Method: users.list

Pobiera pogrupowaną listę usuniętych użytkowników lub wszystkich użytkowników w domenie.

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry zapytania

Parametry
customFieldMask

string

Lista nazw schematów rozdzielona przecinkami. Pobierane są wszystkie pola z tych schematów. Ta opcja powinna być ustawiona tylko wtedy, gdy projection=custom.
customer

string

Unikalny identyfikator konta Google Workspace klienta. W przypadku konta obejmującego wiele domen, aby pobrać wszystkich użytkowników klienta, użyj tego pola zamiast pola domain. Możesz też użyć aliasu my_customer, aby reprezentować customerId na swoim koncie. Wartość customerId jest też zwracana jako część zasobu Users. Musisz podać parametr customer lub domain.
domain

string

nazwę domeny; Użyj tego pola, aby pobrać użytkowników tylko z jednej domeny. Aby zwrócić wszystkie domeny na koncie klienta, użyj parametru zapytania customer. Musisz podać parametr customer lub domain.
event

enum (Event)

Zdarzenie, na które ma być nałożona subskrypcja (jeśli subskrypcja jest płatna)
maxResults

integer

Maksymalna liczba wyników do zwrócenia.
orderBy

enum (OrderBy)

Właściwość używana do sortowania wyników.
pageToken

string

Token do określenia następnej strony na liście. Token strony jest ważny tylko przez 3 dni.
projection

enum (Projection)

Który podzbiór pól ma zostać pobrany dla tego użytkownika.
query

string

Ciąg zapytania do wyszukiwania pól użytkownika. Więcej informacji o tworzenie zapytań dotyczących użytkowników znajdziesz w artykule Wyszukiwanie użytkowników.
showDeleted

string

Jeśli ma wartość true, pobiera listę usuniętych użytkowników. (wartość domyślna: false)
sortOrder

enum (SortOrder)

Określa, czy wyniki mają zostać zwrócone w kolejności rosnącej czy malejącej, z uwzględnieniem wielkości liter.
viewType

enum (ViewType)

Określa, czy należy pobrać widok użytkownika tylko dla administratora czy widok publiczny dla całej domeny. Więcej informacji znajdziesz w artykule Pobieranie użytkownika jako użytkownik bez uprawnień administratora.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "kind": string,
  "trigger_event": string,
  "etag": string,
  "users": [
    {
      object (User)
    }
  ],
  "nextPageToken": string
}
Pola
kind

string

Rodzaj zasobu.
trigger_event

string

Zdarzenie, które spowodowało tę odpowiedź (używane tylko w przypadku odpowiedzi push).
etag

string

ETag zasobu.
users[]

object (User)

Lista obiektów użytkownika.
nextPageToken

string

Token używany do uzyskiwania dostępu do następnej strony z tymi wynikami. Token strony jest ważny tylko przez 3 dni.

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

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

Więcej informacji znajdziesz w przewodniku dotyczącym autoryzacji.

Zdarzenie

Typ zdarzenia subskrypcji

Wartości w polu enum
ADD Zdarzenie utworzone przez użytkownika
DELETE Zdarzenie usunięcia użytkownika
MAKE_ADMIN Zdarzenie zmiany stanu administratora użytkownika
UNDELETE Zdarzenie nieusunięcia użytkownika
UPDATE Zdarzenie aktualizacji użytkownika

OrderBy

Wartości w polu enum
EMAIL Podstawowy adres e-mail użytkownika.
FAMILY_NAME Nazwisko użytkownika.
GIVEN_NAME Imię użytkownika.

Odwzorowanie

Wartości w polu enum
BASIC Nie uwzględniaj żadnych pól niestandardowych dotyczących użytkownika.
CUSTOM Uwzględnij pola niestandardowe ze schematów podanych w pliku customFieldMask.
FULL Uwzględnij wszystkie pola powiązane z tym użytkownikiem.

SortOrder

Wartości w polu enum
ASCENDING rosnąco;
DESCENDING w kolejności malejącej.

ViewType

Wartości w polu enum
admin_view Wyniki obejmują pola użytkownika zarówno tylko dla administratora, jak i publiczne w domenie.
domain_public Wyniki obejmują tylko pola użytkownika, które są publicznie widoczne dla innych użytkowników w domenie.