Method: domains.users.list

Lista os usuários que têm acesso a um domínio.

Solicitação HTTP

GET https://gmailpostmastertools.googleapis.com/v2beta/{parent=domains/*}/users

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
parent

string

Obrigatório. O nome do recurso pai para listar usuários. Formato: domains/{domain}

Parâmetros de consulta

Parâmetros
pageSize

integer

Opcional. Tamanho da página solicitada. O servidor pode retornar menos usuários do que o solicitado. Se não for especificado, o valor padrão desse campo será 10. O valor máximo para esse campo é 200.

pageToken

string

Opcional. O valor nextPageToken retornado de uma solicitação de lista anterior, se houver.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Mensagem de resposta para "users.list".

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON
{
  "users": [
    {
      object (User)
    }
  ],
  "nextPageToken": string
}
Campos
users[]

object (User)

Os usuários que têm acesso ao domínio.

nextPageToken

string

Token para recuperar a próxima página de resultados ou um valor vazio se não houver mais resultados na lista.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/postmaster
  • https://www.googleapis.com/auth/postmaster.user

Para mais informações, consulte o guia de autorização.