Récupère une liste paginée des utilisateurs supprimés ou de tous les utilisateurs d'un domaine.
Requête HTTP
GET https://admin.googleapis.com/admin/directory/v1/users
L'URL utilise la syntaxe de transcodage gRPC.
Paramètres de requête
Paramètres | |
---|---|
customFieldMask |
Liste de noms de schémas séparés par une virgule. Tous les champs de ces schémas sont récupérés. Ne doit être défini que lorsque |
customer |
Identifiant unique du compte Google Workspace du client. Dans le cas d'un compte multidomaine, utilisez ce champ à la place de |
domain |
Nom de domaine. Ce champ vous permet d'obtenir les groupes d'un seul domaine. Pour renvoyer tous les domaines d'un compte client, utilisez plutôt le paramètre de requête |
event |
Événement concerné par l'abonnement (en cas d'abonnement) |
maxResults |
Nombre maximal de résultats sur une page. |
orderBy |
Propriété à utiliser pour trier les résultats. |
pageToken |
Jeton permettant de spécifier la page suivante dans la liste |
projection |
Sous-ensemble de champs à extraire pour cet utilisateur. |
query |
Chaîne de requête pour la recherche de champs utilisateur. Pour plus d'informations sur la création de requêtes utilisateur, consultez Rechercher des utilisateurs. |
showDeleted |
Si la valeur est |
sortOrder |
Indique si les résultats doivent être affichés dans l'ordre croissant ou décroissant, en ignorant la casse. |
viewType |
Permet d'extraire la vue publique de l'utilisateur réservée à l'administrateur ou à l'échelle 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 des données présentant la structure suivante :
Représentation JSON |
---|
{
"kind": string,
"trigger_event": string,
"etag": string,
"users": [
{
object ( |
Champs | |
---|---|
kind |
Type de ressource dont il s'agit. |
trigger_event |
Événement ayant déclenché cette réponse (uniquement utilisé dans le cas d'une réponse push) |
etag |
ETag de la ressource. |
users[] |
Une liste d'objets utilisateur |
nextPageToken |
Jeton utilisé pour accéder à la page suivante de ce résultat. |
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
https://www.googleapis.com/auth/cloud-platform
Pour en savoir plus, consultez le guide relatif aux autorisations.
Événement
Type d'événement d'abonnement
Enums | |
---|---|
ADD |
Événement créé par l'utilisateur |
DELETE |
Événement supprimé par un utilisateur |
MAKE_ADMIN |
Événement de changement de statut d'administrateur d'utilisateurs |
UNDELETE |
Événement annulé par un utilisateur |
UPDATE |
Événement mis à jour par l'utilisateur |
OrderBy
Enums | |
---|---|
EMAIL |
Adresse e-mail principale de l'utilisateur. |
FAMILY_NAME |
Nom de famille de l'utilisateur. |
GIVEN_NAME |
Prénom de l'utilisateur. |
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 |
Inclure tous les champs associés à cet utilisateur. |
SortOrder
Enums | |
---|---|
ASCENDING |
Ordre croissant. |
DESCENDING |
Ordre décroissant. |
ViewType
Enums | |
---|---|
admin_view |
Les résultats comprennent à la fois les champs administrateur uniquement et les champs publics du domaine pour l'utilisateur. |
domain_public |
Les résultats n'incluent que les champs de l'utilisateur visibles par les autres utilisateurs du domaine. |