Method: users.list

Zadbaj o dobrą organizację dzięki kolekcji Zapisuj i kategoryzuj treści zgodnie ze swoimi preferencjami.

Pobiera treści podzielonej na strony z usuniętymi lub wszystkimi kontami 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 oddzielonych przecinkami. Wszystkie pola z tych schematów są pobierane. Należy ją ustawić tylko wtedy, gdy projection=custom.

customer

string

Unikalny identyfikator konta Google Workspace klienta. W przypadku konta z wieloma domenami do pobierania wszystkich grup klienta użyj tego pola zamiast domain. Możesz też użyć aliasu my_customer, aby określić customerId swojego konta. customerId jest też zwracana jako część zasobu Users (Użytkownicy). Musisz podać parametr customer lub domain.

domain

string

Nazwa domeny. Użyj tego pola, aby otrzymywać grupy tylko z jednej domeny. Aby wyświetlić wszystkie domeny konta klienta, użyj parametru zapytania customer. Musisz podać parametr customer lub domain.

event

enum (Event)

Wydarzenie, na które chcesz wykupić subskrypcję (jeśli ją subskrybujesz)

maxResults

integer

Maksymalna liczba wyników do zwrócenia.

orderBy

enum (OrderBy)

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

pageToken

string

Token określający następną stronę na liście

projection

enum (Projection)

Podzbiór pól do pobrania dla tego użytkownika.

query

string

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

showDeleted

string

Jeśli jest ustawiona na true, pobiera listę usuniętych użytkowników. (domyślnie: false)

sortOrder

enum (SortOrder)

Określa, czy wyniki mają być rosnące czy malejąco, bez względu na wielkość liter.

viewType

enum (ViewType)

Określa, czy pobierać tylko publiczny widok użytkownika czy użytkowników z całej domeny. Więcej informacji znajdziesz w artykule Pobieranie konta użytkownika 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

To rodzaj zasobu.

trigger_event

string

Zdarzenie, które uruchomiło tę odpowiedź (używane tylko w 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 tego wyniku.

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 omówieniu protokołu OAuth 2.0.

Zdarzenie

Typ zdarzenia Subskrypcja

Wartości w polu enum
ADD Zdarzenie utworzone przez użytkownika
DELETE Zdarzenie usunięte przez użytkownika
MAKE_ADMIN Zdarzenie zmiany stanu administratora użytkownika
UNDELETE Wydarzenie użytkownika zostało przywrócone
UPDATE Zdarzenie zaktualizowane przez użytkownika

W kolejności

Wartości w polu enum
EMAIL Główny adres e-mail użytkownika.
FAMILY_NAME Nazwisko użytkownika.
GIVEN_NAME Nazwa użytkownika.

Prognoza

Wartości w polu enum
BASIC Nie dodawaj żadnych pól niestandardowych dla użytkownika.
CUSTOM Dołącz pola niestandardowe ze schematów, o które prosisz w polu customFieldMask.
FULL Uwzględnij wszystkie pola powiązane z tym użytkownikiem.

SortOrder

Wartości w polu enum
ASCENDING W kolejności rosnącej.
DESCENDING W porządku malejącym.

Typ widoku danych

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