Method: users.list

Recupera uma lista paginada de usuários excluídos ou de todos os usuários em um domínio.

Solicitação HTTP

GET https://admin.googleapis.com/admin/directory/v1/users

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

Parâmetros de consulta

Parâmetros
customFieldMask

string

Uma lista de nomes de esquemas separados por vírgulas. Todos os campos desses esquemas são buscados. Ele só precisa ser definido quando projection=custom.
customer

string

O ID exclusivo da conta do Google Workspace do cliente. No caso de uma conta com vários domínios, para buscar todos os usuários de um cliente, use este campo em vez de domain. Também é possível usar o alias my_customer para representar o customerId da sua conta. O customerId também é retornado como parte do recurso Users. Forneça o parâmetro customer ou domain.
domain

string

O nome do domínio. Use esse campo para receber usuários de apenas um domínio. Para retornar todos os domínios de uma conta de cliente, use o parâmetro de consulta customer. É necessário fornecer o parâmetro customer ou domain.
event

enum (Event)

Evento em que a assinatura é destinada (se for uma assinatura)
maxResults

integer

Número máximo de resultados a serem retornados.
orderBy

enum (OrderBy)

Propriedade a ser usada para classificar os resultados.
pageToken

string

Token para especificar a próxima página da lista. O token da página é válido por apenas três dias.
projection

enum (Projection)

Qual subconjunto de campos buscar para esse usuário.
query

string

String de consulta para pesquisar campos do usuário. Para mais informações sobre como criar consultas de usuários, consulte Pesquisar usuários.
showDeleted

string

Se definido como true, recupera a lista de usuários excluídos. (Padrão: false)
sortOrder

enum (SortOrder)

Se os resultados serão retornados em ordem crescente ou decrescente, ignorando maiúsculas e minúsculas.
viewType

enum (ViewType)

Indica se a visualização pública do usuário é somente para administradores ou para todo o domínio. Para mais informações, consulte Recuperar um usuário como não administrador.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Se bem-sucedido, o corpo da resposta exibirá os dados com a seguinte estrutura:

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

string

Tipo de recurso.
trigger_event

string

Evento que acionou essa resposta (usado apenas no caso de resposta push)
etag

string

ETag do recurso.
users[]

object (User)

Uma lista de objetos do usuário.
nextPageToken

string

Token usado para acessar a próxima página desse resultado. O token da página é válido por apenas três dias.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/admin.directory.user
  • https://www.googleapis.com/auth/admin.directory.user.readonly
  • https://www.googleapis.com/auth/cloud-platform

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

Evento

Tipo de evento de assinatura

Enums
ADD Evento criado pelo usuário
DELETE Evento de exclusão de usuário
MAKE_ADMIN Evento de mudança de status de administrador do usuário
UNDELETE Evento de restauração de exclusão do usuário
UPDATE Evento de atualização do usuário

OrderBy

Enums
EMAIL E-mail principal do usuário.
FAMILY_NAME Sobrenome do usuário.
GIVEN_NAME Nome do usuário.

Projeção

Enums
BASIC Não inclua campos personalizados para o usuário.
CUSTOM Incluir campos personalizados de esquemas solicitados em customFieldMask.
FULL Inclua todos os campos associados a esse usuário.

SortOrder

Enums
ASCENDING Ordem crescente.
DESCENDING Ordem decrescente.

ViewType

Enums
admin_view Os resultados incluem campos somente para administradores e públicos do domínio para o usuário.
domain_public Os resultados incluem apenas os campos do usuário que são visíveis publicamente para outros usuários no domínio.