Method: people.listDirectoryPeople

Fournit une liste des profils de domaine et des contacts de domaine dans l'annuaire de domaine de l'utilisateur authentifié.

Lorsque syncToken est spécifié, les ressources supprimées depuis la dernière synchronisation sont renvoyées en tant que personne avec PersonMetadata.deleted défini sur "true".

Lorsque pageToken ou syncToken est spécifié, tous les autres paramètres de requête doivent correspondre au premier appel.

Les écritures peuvent avoir un délai de propagation de plusieurs minutes pour les requêtes de synchronisation. Les synchronisations incrémentielles ne sont pas destinées aux cas d'utilisation de lecture après écriture.

Pour voir un exemple d'utilisation, consultez Lister les personnes du répertoire qui ont changé.

Requête HTTP

GET https://people.googleapis.com/v1/people:listDirectoryPeople

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de requête

Paramètres
readMask

string (FieldMask format)

Obligatoire. Masque de champ permettant de limiter les champs renvoyés pour chaque personne. Vous pouvez spécifier plusieurs champs en les séparant par des virgules. Les valeurs valides sont les suivantes :

  • addresses
  • ageRanges
  • biographies
  • anniversaires
  • calendarUrls
  • clientData
  • coverPhotos
  • emailAddresses
  • événements
  • externalIds
  • critères de sexe
  • imClients
  • centres d'intérêt
  • locales
  • zones géographiques
  • aux chaînes
  • métadonnées
  • miscKeywords
  • noms
  • surnoms
  • professions
  • organizations
  • phoneNumbers
  • photos
  • relations
  • sipAddresses
  • skills
  • URL
  • userDefined
sources[]

enum (DirectorySourceType)

Obligatoire. Sources de répertoires à afficher.
mergeSources[]

enum (DirectoryMergeSourceType)

Facultatif. Données supplémentaires à fusionner dans les sources d'annuaire si elles sont associées à l'aide de clés de jointure validées, telles que des adresses e-mail ou des numéros de téléphone.
pageSize

integer

Facultatif. Nombre de personnes à inclure dans la réponse. Les valeurs valides sont comprises entre 1 et 1 000 inclus. La valeur par défaut est 100 si elle n'est pas définie ou si elle est définie sur 0.
pageToken

string

Facultatif. Jeton de page, reçu d'une réponse précédente nextPageToken. Fournissez-le pour récupérer la page suivante.

Lors de la pagination, tous les autres paramètres fournis à people.listDirectoryPeople doivent correspondre au premier appel ayant fourni le jeton de page.
requestSyncToken

boolean

Facultatif. Indique si la réponse doit renvoyer nextSyncToken. Vous pouvez l'utiliser pour obtenir des modifications incrémentielles depuis la dernière requête en le définissant sur la requête syncToken.

Pour en savoir plus sur le comportement de synchronisation, consultez la page people.listDirectoryPeople.
syncToken

string

Facultatif. Jeton de synchronisation reçu d'une réponse nextSyncToken précédente. Fournissez-le pour ne récupérer que les ressources modifiées depuis la dernière requête.

Lors de la synchronisation, tous les autres paramètres fournis à people.listDirectoryPeople doivent correspondre au premier appel ayant fourni le jeton de synchronisation.

Pour en savoir plus sur le comportement de synchronisation, consultez la page people.listDirectoryPeople.

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

Réponse à une requête concernant l'annuaire du domaine de l'utilisateur authentifié.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON 
{
  "people": [
    {
      object (Person)
    }
  ],
  "nextPageToken": string,
  "nextSyncToken": string
}
Champs
people[]

object (Person)

Liste des personnes dans l'annuaire du domaine.
nextPageToken

string

Jeton pouvant être envoyé en tant que pageToken pour récupérer la page suivante. Si ce champ est omis, il n'y a pas d'autres pages.
nextSyncToken

string

Jeton pouvant être envoyé en tant que syncToken pour récupérer les modifications depuis la dernière requête. La requête doit définir requestSyncToken pour renvoyer le jeton de synchronisation.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/directory.readonly

Pour en savoir plus, consultez le guide d'autorisation.