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 extraits. Ce champ ne doit être défini que si |
customer |
Identifiant unique du compte Google Workspace du client. Dans le cas d'un compte multidomaine, utilisez ce champ au lieu de |
domain |
Nom du domaine. Ce champ 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 auquel l'abonnement est destiné (si vous êtes abonné) |
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 à récupérer pour cet utilisateur. |
query |
Chaîne de requête pour la recherche dans les champs utilisateur. Pour en savoir plus sur la création de requêtes utilisateur, consultez la section Rechercher des utilisateurs. |
showDeleted |
Si la valeur est |
sortOrder |
Renvoie les résultats par ordre croissant ou décroissant, en ignorant la casse. |
viewType |
Permet de récupérer la vue publique de l'utilisateur pour les administrateurs ou le domaine. Pour en savoir plus, consultez Récupérer un utilisateur en tant qu'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 concerné. |
trigger_event |
Événement ayant déclenché cette réponse (utilisé uniquement en cas de réponse push) |
etag |
ETag de la ressource. |
users[] |
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 sur les autorisations.
Événement
Type d'abonnement
Enums | |
---|---|
ADD |
Événement créé par l'utilisateur |
DELETE |
Événement supprimé par l'utilisateur |
MAKE_ADMIN |
Événement de changement de l'état d'administration de l'utilisateur |
UNDELETE |
Événement rétabli par l'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 |
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 |
Incluez tous les champs associés à cet utilisateur. |
SortOrder
Enums | |
---|---|
ASCENDING |
Ordre croissant. |
DESCENDING |
Ordre décroissant. |
Type de vue
Enums | |
---|---|
admin_view |
Les résultats incluent à la fois les champs d'administrateur et les domaines publics de l'utilisateur. |
domain_public |
Les résultats n'incluent que les champs de l'utilisateur visibles publiquement par les autres utilisateurs du domaine. |