Method: users.get
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
Requête HTTP
GET https://admin.googleapis.com/admin/directory/v1/users/{userKey}
L'URL utilise la syntaxe de transcodage gRPC.
Paramètres de chemin d'accès
| Paramètres |
userKey |
string
Identifie l'utilisateur dans la requête API. La valeur peut être l'adresse e-mail principale, l'adresse e-mail d'alias ou l'ID utilisateur unique de l'utilisateur.
|
Paramètres de requête
| Paramètres |
customFieldMask |
string
Liste de noms de schémas séparés par une virgule. Tous les champs de ces schémas sont récupérés. Cette valeur ne doit être définie que lorsque projection=custom.
|
projection |
enum (Projection)
Sous-ensemble de champs à extraire pour cet utilisateur.
|
viewType |
enum (ViewType)
Indique si la vue publique de l'utilisateur doit être récupérée pour les administrateurs uniquement ou pour l'ensemble du domaine. Pour en savoir plus, consultez Récupérer un utilisateur en tant que non-administrateur.
|
Corps de la requête
Le corps de la requête doit être vide.
Corps de la réponse
Si la requête aboutit, le corps de la réponse contient une instance de User.
Champs d'application des autorisations
Nécessite l'un des champs d'application OAuth suivants :
https://www.googleapis.com/auth/admin.directory.user
https://www.googleapis.com/auth/admin.directory.user.readonly
Pour en savoir plus, consultez le guide d'autorisation.
Projection
| Enums |
BASIC |
N'incluez aucun champ personnalisé pour l'utilisateur. |
CUSTOM |
Incluez les champs personnalisés des schémas demandés dans customFieldMask. |
FULL |
Incluez tous les champs associés à cet utilisateur. |
ViewType
| Enums |
admin_view |
Les résultats incluent à la fois les champs réservés aux administrateurs et les champs publics du domaine pour l'utilisateur. |
domain_public |
Les résultats n'incluent que les champs de l'utilisateur qui sont visibles publiquement par les autres utilisateurs du domaine. |
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/07/25 (UTC).
[null,null,["Dernière mise à jour le 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. |"]]
