Method: people.listDirectoryPeople

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

Lorsque le 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.

Un délai de propagation de plusieurs minutes peut être nécessaire pour les opérations d'écriture pour les requêtes de synchronisation. Les synchronisations incrémentielles ne sont pas destinées aux cas d'utilisation de type lecture après écriture.

Pour voir un exemple d'utilisation, consultez Répertorier les utilisateurs de l'annuaire 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 une virgule. Les valeurs possibles 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
  • emplacement
  • aux chaînes
  • métadonnées
  • miscKeywords
  • names
  • surnoms
  • professions
  • organizations
  • phoneNumbers
  • photos
  • relations
  • sipAddresses
  • skills
  • urls
  • userDefined
sources[]

enum (DirectorySourceType)

Obligatoire. Sources d'annuaire à afficher.
mergeSources[]

enum (DirectoryMergeSourceType)

Facultatif. Données supplémentaires à fusionner dans les sources d'annuaire si elles sont connectées via des 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. Un jeton de page, reçu à partir 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. Il peut être utilisé 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 people.listDirectoryPeople.
syncToken

string

Facultatif. Un jeton de synchronisation, reçu à partir d'une réponse précédente nextSyncToken. 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 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 de 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 membres de 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

Un jeton, qui peut être envoyé en tant que syncToken pour récupérer les modifications apportées 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 relatif aux autorisations.