Recupera uma lista paginada de usuários excluídos ou 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 |
Uma lista separada por vírgulas de nomes de esquema. Todos os campos desses esquemas são buscados. Isso só deve ser definido quando |
customer |
O ID exclusivo da conta do Google Workspace do cliente. No caso de uma conta com vários domínios, use este campo em vez de |
domain |
O nome do domínio. Use este campo para ver grupos de apenas um domínio. Para retornar todos os domínios de uma conta de cliente, use o parâmetro de consulta |
event |
Evento sobre o qual a assinatura se destina (se for uma assinatura) |
maxResults |
Número máximo de resultados a serem retornados. |
orderBy |
Propriedade a ser usada para classificar resultados. |
pageToken |
Token para especificar a próxima página na lista |
projection |
O subconjunto de campos a ser buscado para este usuário. |
query |
String de consulta para pesquisar campos de usuário. Para mais informações sobre a criação de consultas de usuários, consulte Pesquisar usuários. |
showDeleted |
Se definido como |
sortOrder |
Se os resultados serão retornados em ordem crescente ou decrescente, ignorando maiúsculas e minúsculas. |
viewType |
Se deve buscar a visualização pública somente de administrador ou de todo o domínio do usuário. 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 ( |
Campos | |
---|---|
kind |
Tipo de recurso em questão. |
trigger_event |
Evento que acionou essa resposta (usado apenas no caso de resposta push) |
etag |
ETag do recurso. |
users[] |
Uma lista de objetos do usuário. |
nextPageToken |
Token usado para acessar a próxima página desse resultado. |
Escopos de autorização
Requer um dos seguintes escopos de 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
Enums | |
---|---|
ADD |
Evento criado por usuário |
DELETE |
Evento excluído pelo usuário |
MAKE_ADMIN |
Evento de alteração de status de administrador de usuário |
UNDELETE |
Evento não excluído do usuário |
UPDATE |
Evento atualizado pelo 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 |
Inclua campos personalizados dos esquemas solicitados em customFieldMask . |
FULL |
Inclua todos os campos associados a este usuário. |
SortOrder
Enums | |
---|---|
ASCENDING |
Ordem crescente. |
DESCENDING |
Ordem decrescente. |
Tipo de visualização
Enums | |
---|---|
admin_view |
Os resultados incluem campos apenas do administrador e de domínio público do usuário. |
domain_public |
Os resultados incluem apenas campos do usuário visíveis publicamente para outros usuários no domínio. |