Method: users.get

Récupère un utilisateur.

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.