Method: people.listDirectoryPeople

Proporciona una lista de perfiles de dominio y contactos de dominio en el directorio de dominio del usuario autenticado.

Cuando se especifica la syncToken, los recursos borrados desde la última sincronización se mostrarán como una persona con PersonMetadata.deleted configurado como verdadero.

Cuando se especifica pageToken o syncToken, todos los demás parámetros de solicitud deben coincidir con la primera llamada.

Las operaciones de escritura pueden tener una demora de propagación de varios minutos para las solicitudes de sincronización. Las sincronizaciones incrementales no están diseñadas para casos prácticos de lectura y escritura.

Consulta el ejemplo de uso en Enumerar el directorio que cambiaron.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de consulta

Parámetros
readMask

string (FieldMask format)

Obligatorio. Una máscara de campo que restringe los campos que se muestran en cada persona. Se pueden especificar varios campos separándolos con comas. A continuación, se indican los valores válidos:

  • addresses
  • Rangos de edad
  • biografías
  • cumpleaños
  • URL de calendario
  • datosdelcliente
  • fotos de portada
  • Direcciones de correo electrónico
  • eventos
  • ID externos
  • Sexos
  • clientes potenciales
  • Intereses
  • locales
  • ubicaciones
  • memberships
  • metadata
  • palabras clave varias
  • names
  • sobrenombres
  • profesiones
  • organizations
  • númerosdeteléfono
  • fotos
  • relaciones
  • direccionessip
  • skills
  • url
  • definido por el usuario
sources[]

enum (DirectorySourceType)

Obligatorio. Fuentes del directorio que se mostrarán.
mergeSources[]

enum (DirectoryMergeSourceType)

Opcional. Datos adicionales para combinar en las fuentes del directorio si están conectados mediante claves de unión verificadas, como direcciones de correo electrónico o números de teléfono.
pageSize

integer

Opcional. Es la cantidad de personas que se deben incluir en la respuesta. Los valores válidos deben estar entre 1 y 1,000, inclusive. El valor predeterminado es 100 si no se establece o se establece en 0.
pageToken

string

Opcional. Un token de página, recibido de un nextPageToken de respuesta anterior. Proporciona esto para recuperar la página siguiente.

Cuando realices la paginación, todos los demás parámetros proporcionados a people.listDirectoryPeople deben coincidir con la primera llamada que proporcionó el token de la página.
requestSyncToken

boolean

Opcional. Indica si la respuesta debe mostrar nextSyncToken. Se puede usar para obtener cambios incrementales desde la última solicitud si la configuras en la solicitud syncToken.

Obtén más información sobre el comportamiento de sincronización en people.listDirectoryPeople.
syncToken

string

Opcional. Un token de sincronización, recibido de una respuesta anterior nextSyncToken Proporciona esto para recuperar solo los recursos que cambiaron desde la última solicitud.

Durante la sincronización, todos los demás parámetros proporcionados a people.listDirectoryPeople deben coincidir con la primera llamada que proporcionó el token de sincronización.

Obtén más información sobre el comportamiento de sincronización en people.listDirectoryPeople.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:

Es la respuesta a una solicitud del directorio de dominio del usuario autenticado.

Representación JSON 
{
  "people": [
    {
      object (Person)
    }
  ],
  "nextPageToken": string,
  "nextSyncToken": string
}
Campos
people[]

object (Person)

La lista de personas en el directorio del dominio.
nextPageToken

string

Un token, que se puede enviar como pageToken para recuperar la página siguiente. Si se omite este campo, no habrá páginas siguientes.
nextSyncToken

string

Un token, que se puede enviar como syncToken para recuperar cambios desde la última solicitud. La solicitud debe configurar requestSyncToken para que muestre el token de sincronización.

Alcances de la autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la guía de autorización.