Method: users.get
Zadbaj o dobrą organizację dzięki kolekcji
Zapisuj i kategoryzuj treści zgodnie ze swoimi preferencjami.
Pobiera dane użytkownika.
Żądanie HTTP
GET https://admin.googleapis.com/admin/directory/v1/users/{userKey}
Adres URL używa składni transkodowania gRPC.
Parametry ścieżki
| Parametry |
userKey |
string
Identyfikuje użytkownika w żądaniu interfejsu API. Wartością może być podstawowy adres e-mail użytkownika, alias adresu e-mail lub unikalny identyfikator użytkownika.
|
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.
|
projection |
enum (Projection)
Który podzbiór pól ma zostać pobrany dla tego użytkownika.
|
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ść odpowiedzi obejmuje wystąpienie elementu User.
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
Więcej informacji znajdziesz w przewodniku dotyczącym autoryzacji.
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. |
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. |
O ile nie stwierdzono inaczej, treść tej strony jest objęta licencją Creative Commons – uznanie autorstwa 4.0, a fragmenty kodu są dostępne na licencji Apache 2.0. Szczegółowe informacje na ten temat zawierają zasady dotyczące witryny Google Developers. Java jest zastrzeżonym znakiem towarowym firmy Oracle i jej podmiotów stowarzyszonych.
Ostatnia aktualizacja: 2025-07-25 UTC.
[null,null,["Ostatnia aktualizacja: 2025-07-25 UTC."],[],[],null,["Retrieves a user.\n\nHTTP request\n\n`GET https://admin.googleapis.com/admin/directory/v1/users/{userKey}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\nPath parameters\n\n| Parameters ||\n|-----------|---------------------------------------------------------------------------------------------------------------------------------------------|\n| `userKey` | `string` Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID. |\n\nQuery parameters\n\n| Parameters ||\n|-------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `customFieldMask` | `string` A comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when `projection=custom`. |\n| `projection` | `enum (`[Projection](/workspace/admin/directory/reference/rest/v1/users/get#Projection)`)` What subset of fields to fetch for this user. |\n| `viewType` | `enum (`[ViewType](/workspace/admin/directory/reference/rest/v1/users/get#ViewType)`)` Whether to fetch the administrator-only or domain-wide public view of the user. For more information, see [Retrieve a user as a non-administrator](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users#retrieve_users_non_admin). |\n\nRequest body\n\nThe request body must be empty.\n\nResponse body\n\nIf successful, the response body contains an instance of [User](/workspace/admin/directory/reference/rest/v1/users#User).\n\nAuthorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/admin.directory.user`\n- `\n https://www.googleapis.com/auth/admin.directory.user.readonly`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent).\n\nProjection\n\n| Enums ||\n|----------|--------------------------------------------------------------------|\n| `BASIC` | Do not include any custom fields for the user. |\n| `CUSTOM` | Include custom fields from schemas requested in `customFieldMask`. |\n| `FULL` | Include all fields associated with this user. |\n\nViewType\n\n| Enums ||\n|-----------------|--------------------------------------------------------------------------------------------------|\n| `admin_view` | Results include both administrator-only and domain-public fields for the user. |\n| `domain_public` | Results only include fields for the user that are publicly visible to other users in the domain. |"]]
