- Solicitud HTTP
- Parámetros de búsqueda
- Cuerpo de la solicitud
- Cuerpo de la respuesta
- Alcances de la autorización
- Pruébala
Proporciona una lista de perfiles y contactos de dominio en el directorio de dominio del usuario autenticado.
Cuando se especifica el
, los recursos borrados desde la última sincronización se mostrarán como una persona con syncToken
establecido como verdadero.PersonMetadata.deleted
Cuando se especifica
o pageToken
, todos los demás parámetros de solicitud deben coincidir con la primera llamada.syncToken
Las operaciones de escritura pueden tener un retraso de propagación de varios minutos en las solicitudes de sincronización. Las sincronizaciones incrementales no están diseñadas para casos de uso de lectura después de escritura.
Consulta un ejemplo de uso en Enumera las personas del 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 |
Obligatorio. Una máscara de campo que restringe los campos que se muestran de cada persona. Se pueden especificar varios campos separándolos con comas. Estos son los valores válidos:
|
sources[] |
Obligatorio. Fuentes del directorio que se mostrarán. |
mergeSources[] |
Opcional. Datos adicionales que se combinarán en las fuentes del directorio si están conectadas mediante claves de unión verificadas, como direcciones de correo electrónico o números de teléfono. |
pageSize |
Opcional. Es la cantidad de personas que se deben incluir en la respuesta. Los valores válidos se encuentran entre 1 y 1,000, inclusive. El valor predeterminado es 100 si no se configura o se establece en 0. |
pageToken |
Opcional. Un token de página, recibido de un Cuando se utiliza la paginación, todos los demás parámetros proporcionados a |
requestSyncToken |
Opcional. Indica si la respuesta debe mostrar Obtén más información sobre el comportamiento de la sincronización en |
syncToken |
Opcional. Un token de sincronización recibido de una respuesta anterior Durante la sincronización, todos los demás parámetros proporcionados a Obtén más información sobre el comportamiento de la sincronización en |
Cuerpo de la solicitud
El cuerpo de la solicitud debe estar vacío.
Cuerpo de la respuesta
Es la respuesta a una solicitud del directorio del dominio del usuario autenticado.
Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:
Representación JSON |
---|
{
"people": [
{
object ( |
Campos | |
---|---|
people[] |
Es la lista de personas en el directorio del dominio. |
nextPageToken |
Un token, que se puede enviar como |
nextSyncToken |
Un token, que se puede enviar como |
Permisos de 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.