Method: users.list

Organiza tus páginas con colecciones Guarda y categoriza el contenido según tus preferencias.

Recupera una lista paginada de los usuarios borrados o de todos los usuarios de un dominio.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de consulta

Parámetros
customFieldMask

string

Una lista de nombres de esquemas separados por comas. Se recuperan todos los campos de estos esquemas. Solo se debe configurar cuando projection=custom.
customer

string

El ID único de la cuenta de Google Workspace del cliente. En el caso de una cuenta de varios dominios, a fin de recuperar todos los grupos de un cliente, usa este campo en lugar de domain. También puedes usar el alias my_customer para representar el customerId de tu cuenta. El customerId también se muestra como parte del recurso Users. Debes proporcionar el parámetro customer o domain.
domain

string

Es el nombre de dominio. Utilice este campo para obtener grupos de un solo dominio. Para mostrar todos los dominios de una cuenta de cliente, usa el parámetro de consulta customer en su lugar. Se debe proporcionar el parámetro customer o domain.
event

enum (Event)

Evento al que se orienta la suscripción (si tienes una suscripción)
maxResults

integer

Cantidad máxima de resultados que se mostrarán
orderBy

enum (OrderBy)

Propiedad que se usa para ordenar los resultados
pageToken

string

Token para especificar la página siguiente en la lista
projection

enum (Projection)

Subconjunto de campos que se recuperará para este usuario.
query

string

Cadena de consulta para buscar campos de usuario. Para obtener más información sobre cómo crear consultas de usuarios, visita Búsqueda de usuarios.
showDeleted

string

Si se configura como true, recupera la lista de usuarios borrados. (Valor predeterminado: false)
sortOrder

enum (SortOrder)

Si se muestran resultados en orden ascendente o descendente, sin distinguir entre mayúsculas y minúsculas.
viewType

enum (ViewType)

Indica si se debe recuperar la vista pública del usuario solo para administradores o de dominio. Para obtener más información, consulta Cómo recuperar a un usuario como no administrador.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Si el proceso es satisfactorio, el cuerpo de la respuesta contiene datos con la siguiente estructura:

Representación JSON 
{
  "kind": string,
  "trigger_event": string,
  "etag": string,
  "users": [
    {
      object (User)
    }
  ],
  "nextPageToken": string
}
Campos
kind

string

Este es el tipo de recurso.
trigger_event

string

Evento que activó esta respuesta (solo se usa en caso de una respuesta push)
etag

string

ETag del recurso.
users[]

object (User)

Una lista de objetos de usuario.
nextPageToken

string

Es el token que se usa para acceder a la página siguiente de este resultado.

Alcances de la autorización

Se necesita uno de los siguientes alcances 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 obtener más información, consulta la descripción general de OAuth 2.0.

Evento

Tipo de evento de suscripción

Enumeradores
ADD Evento creado por el usuario
DELETE Evento borrado por el usuario
MAKE_ADMIN Evento de cambio de estado del administrador de usuarios
UNDELETE Evento no eliminado del usuario
UPDATE Evento actualizado del usuario

OrderBy

Enumeradores
EMAIL Correo electrónico principal del usuario.
FAMILY_NAME Apellido del usuario.
GIVEN_NAME Nombre del usuario.

Proyección

Enumeradores
BASIC No incluyas ningún campo personalizado para el usuario.
CUSTOM Incluye los campos personalizados de los esquemas solicitados en customFieldMask.
FULL Incluye todos los campos asociados con este usuario.

SortOrder

Enumeradores
ASCENDING Orden ascendente
DESCENDING Orden descendente

Tipo de vista

Enumeradores
admin_view Los resultados incluyen campos exclusivos para administradores y campos públicos para el usuario.
domain_public Los resultados solo incluyen campos correspondientes al usuario que son visibles públicamente para otros usuarios del dominio.