- Solicitação HTTP
- Parâmetros de consulta
- Corpo da solicitação
- Corpo da resposta
- Escopos de autorização
- Faça um teste
Fornece uma lista de perfis de domínio e contatos do domínio no diretório de domínio do usuário autenticado.
Quando
for especificado, os recursos excluídos desde a última sincronização serão retornados como uma pessoa com syncToken
definido como verdadeiro.PersonMetadata.deleted
Quando
ou pageToken
é especificado, todos os outros parâmetros de solicitação precisam corresponder à primeira chamada.syncToken
As gravações podem ter um atraso de propagação de vários minutos para solicitações de sincronização. As sincronizações incrementais não são destinadas a casos de uso de leitura após gravação.
Confira um exemplo de uso em Listar as pessoas do diretório que foram alteradas.
Solicitação HTTP
GET https://people.googleapis.com/v1/people:listDirectoryPeople
O URL usa a sintaxe de transcodificação gRPC.
Parâmetros de consulta
Parâmetros | |
---|---|
readMask |
Obrigatório. Uma máscara de campo para restringir quais campos de cada pessoa são retornados. É possível especificar vários campos separando-os com vírgulas. Os valores válidos são:
|
sources[] |
Obrigatório. Origens de diretório a serem retornadas. |
mergeSources[] |
Opcional. Dados extras que vão ser mesclados nas origens do diretório se estiverem conectados por chaves de mesclagem verificadas, como endereços de e-mail ou números de telefone. |
pageSize |
Opcional. O número de pessoas a serem incluídas na resposta. Os valores válidos estão entre 1 e 1.000, inclusive. O padrão é 100 se não for definido ou for definido como 0. |
pageToken |
Opcional. Um token de página, recebido de uma resposta anterior Ao paginar, todos os outros parâmetros fornecidos para |
requestSyncToken |
Opcional. Se a resposta precisa retornar Mais detalhes sobre o comportamento da sincronização em |
syncToken |
Opcional. Um token de sincronização recebido de uma resposta Ao sincronizar, todos os outros parâmetros fornecidos para Mais detalhes sobre o comportamento da sincronização em |
Corpo da solicitação
O corpo da solicitação precisa estar vazio.
Corpo da resposta
A resposta a uma solicitação para o diretório de domínio do usuário autenticado.
Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:
Representação JSON |
---|
{
"people": [
{
object ( |
Campos | |
---|---|
people[] |
A lista de pessoas no diretório do domínio. |
nextPageToken |
Um token, que pode ser enviado como |
nextSyncToken |
Um token, que pode ser enviado como |
Escopos de autorização
Requer o seguinte escopo OAuth:
https://www.googleapis.com/auth/directory.readonly
Para mais informações, consulte o Guia de autorização.