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 separada por vírgulas de nomes de esquemas. 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. É necessário informar o parâmetro customer ou domain.
domain

string

O nome de domínio. Use este 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. É preciso fornecer o parâmetro customer ou domain.
event

enum (Event)

Evento ao qual a assinatura se destina (se for assinante)
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 na lista
projection

enum (Projection)

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

string

String de consulta para pesquisar campos de 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)

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

enum (ViewType)

Se a visualização pública somente do administrador ou do domínio do usuário será buscada. Para mais informações, consulte Recuperar um usuário como um 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 em questão.
trigger_event

string

Evento que acionou esta resposta (usado somente no caso de resposta push)
etag

string

ETag do recurso.
users[]

object (User)

Uma lista de objetos de usuário.
nextPageToken

string

Token usado para acessar a próxima página deste resultado.

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 do evento de inscrição

Tipos enumerados
ADD Evento criado pelo usuário
DELETE Evento excluído pelo usuário
MAKE_ADMIN Evento de alteração de status do administrador do usuário
UNDELETE Evento de usuário cancelado por exclusão
UPDATE Evento atualizado pelo usuário

OrderBy

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

Projeção

Tipos enumerados
BASIC Não inclua campos personalizados para o usuário.
CUSTOM Inclua campos personalizados dos esquemas solicitados em customFieldMask.
FULL Inclua todos os campos associados a este usuário.

SortOrder

Tipos enumerados
ASCENDING Ordem crescente.
DESCENDING Ordem decrescente.

ViewType

Tipos enumerados
admin_view Os resultados incluem campos apenas de administrador e de domínio público para o usuário.
domain_public Os resultados incluem apenas os campos do usuário visíveis publicamente para outros usuários no domínio.