Pobiera podzielony na strony listę usuniętych 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 |
Lista nazw schematów oddzielonych przecinkami. Wszystkie pola z tych schematów są pobierane. Należy go ustawić tylko wtedy, gdy |
customer |
Unikalny identyfikator konta Google Workspace klienta. W przypadku konta z wieloma domenami użyj tego pola zamiast |
domain |
Nazwa domeny. Korzystając z tego pola, możesz pobierać grupy tylko z jednej domeny. Aby zwrócić wszystkie domeny związane z kontem klienta, użyj parametru zapytania |
event |
Zdarzenie, na które jest przeznaczona subskrypcja (jeśli subskrybujesz) |
maxResults |
Maksymalna liczba wyników do zwrócenia. |
orderBy |
Właściwość używana do sortowania wyników. |
pageToken |
Token do określenia następnej strony na liście |
projection |
Podzbiór pól do pobrania dla tego użytkownika. |
query |
Ciąg zapytania umożliwiający wyszukiwanie pól użytkowników. Więcej informacji o tworzeniu zapytań użytkowników znajdziesz w artykule Wyszukiwanie użytkowników. |
showDeleted |
Jeśli ma wartość |
sortOrder |
Określa, czy funkcja ma zwrócić wyniki w kolejności rosnącej czy malejącej (bez rozróżniania wielkości liter). |
viewType |
Określa, czy chcesz pobierać publiczne dane użytkownika tylko dla administratora czy 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 ( |
Pola | |
---|---|
kind |
To rodzaj materiałów. |
trigger_event |
Zdarzenie, które wywołało tę odpowiedź (tylko w przypadku odpowiedzi push) |
etag |
ETag zasobu. |
users[] |
Lista obiektów użytkownika. |
nextPageToken |
Token użyty do uzyskania 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 przewodniku po autoryzacji.
Zdarzenie
Typ zdarzenia Subskrypcja
Wartości w polu enum | |
---|---|
ADD |
Zdarzenie utworzone przez użytkownika |
DELETE |
Wydarzenie usunięte przez użytkownika |
MAKE_ADMIN |
Zdarzenie zmiany stanu administratora |
UNDELETE |
Wydarzenie przywrócone przez użytkownika |
UPDATE |
Zdarzenie zaktualizowane przez użytkownika |
Według
Wartości w polu enum | |
---|---|
EMAIL |
Główny adres e-mail użytkownika. |
FAMILY_NAME |
Nazwisko użytkownika. |
GIVEN_NAME |
Imię użytkownika. |
Odwzorowanie
Wartości w polu enum | |
---|---|
BASIC |
Nie dodawaj żadnych pól niestandardowych dla użytkownika. |
CUSTOM |
Uwzględnij pola niestandardowe ze schematów wymaganych w customFieldMask . |
FULL |
Uwzględnij wszystkie pola powiązane z tym użytkownikiem. |
SortOrder
Wartości w polu enum | |
---|---|
ASCENDING |
Kolejność rosnąca. |
DESCENDING |
Malejąco. |
Typ widoku
Wartości w polu enum | |
---|---|
admin_view |
Wyniki obejmują zarówno pole przeznaczone tylko dla administratorów, jak i publiczne pola domeny dla użytkownika. |
domain_public |
Wyniki obejmują tylko pola użytkownika, które są widoczne publicznie dla innych użytkowników domeny. |