Method: users.get
Оптимизируйте свои подборки
Сохраняйте и классифицируйте контент в соответствии со своими настройками.
HTTP-запрос
GET https://admin.googleapis.com/admin/directory/v1/users/{userKey}
URL-адрес использует синтаксис транскодирования gRPC .
Параметры пути
| Параметры |
|---|
userKey | string Идентифицирует пользователя в запросе API. Значением может быть основной адрес электронной почты пользователя, псевдоним адреса электронной почты или уникальный идентификатор пользователя. |
Параметры запроса
| Параметры |
|---|
customFieldMask | string Список имен схем, разделенных запятыми. Все поля из этих схем извлекаются. Это значение следует устанавливать только в том случае, если projection=custom . |
projection | enum ( Projection ) Какое подмножество полей получить для этого пользователя. |
viewType | enum ( ViewType ) Следует ли получать общедоступное представление пользователя только для администратора или для всего домена. Дополнительные сведения см. в разделе Получение пользователя без прав администратора . |
Тело запроса
Тело запроса должно быть пустым.
Тело ответа
В случае успеха тело ответа содержит экземпляр User .
Области авторизации
Требуется одна из следующих областей OAuth:
-
https://www.googleapis.com/auth/admin.directory.user -
https://www.googleapis.com/auth/admin.directory.user.readonly
Дополнительную информацию см. в руководстве по авторизации .
Проекция
| Перечисления |
|---|
BASIC | Не включайте никаких настраиваемых полей для пользователя. |
CUSTOM | Включите настраиваемые поля из схем, запрошенных в customFieldMask . |
FULL | Включите все поля, связанные с этим пользователем. |
Тип просмотра
| Перечисления |
|---|
admin_view | Результаты включают как поля, доступные только администратору, так и общедоступные для домена поля пользователя. |
domain_public | Результаты включают только поля для пользователя, которые публично видны другим пользователям в домене. |
Если не указано иное, контент на этой странице предоставляется по лицензии Creative Commons "С указанием авторства 4.0", а примеры кода – по лицензии Apache 2.0. Подробнее об этом написано в правилах сайта. Java – это зарегистрированный товарный знак корпорации Oracle и ее аффилированных лиц.
Последнее обновление: 2025-07-25 UTC.
[null,null,["Последнее обновление: 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. |"]]
