Method: users.list

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. Esto 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, para recuperar todos los usuarios 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. 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. Usa este campo para obtener usuarios de un solo dominio. Para mostrar todos los dominios de una cuenta de cliente, usa el parámetro de búsqueda customer en su lugar. Se debe proporcionar el parámetro customer o domain.
event

enum (Event)

Evento en el que está prevista la suscripción (si te suscribes)
maxResults

integer

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

enum (OrderBy)

Es la propiedad que se usa para ordenar los resultados.
pageToken

string

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

enum (Projection)

El subconjunto de campos que se debe 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, consulta Busca usuarios.
showDeleted

string

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

enum (SortOrder)

Indica si se deben mostrar los 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 el administrador o para todo el dominio. Para obtener más información, consulta Recupera 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 un tipo de recurso.
trigger_event

string

Evento que activó esta respuesta (solo se usa en caso de respuesta de envío)
etag

string

ETag del recurso.
users[]

object (User)

Una lista de objetos de usuario.
nextPageToken

string

Token utilizado para acceder a la página siguiente de este resultado.

Alcances de autorización

Se necesita uno de los siguientes permisos 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 Guía de autorización.

Evento

Tipo del evento de suscripción

Enumeraciones
ADD Evento creado por el usuario
DELETE Evento borrado por el usuario
MAKE_ADMIN Evento de cambio de estado de administrador del usuario
UNDELETE El usuario no borró el evento
UPDATE Evento actualizado por el usuario

OrderBy

Enumeraciones
EMAIL Es el correo electrónico principal del usuario.
FAMILY_NAME Apellido del usuario.
GIVEN_NAME Es el nombre del usuario.

Proyección

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

SortOrder

Enumeraciones
ASCENDING Orden ascendente.
DESCENDING Orden descendente.

ViewType

Enumeraciones
admin_view Los resultados incluyen campos públicos del dominio y exclusivos para el administrador para el usuario.
domain_public Los resultados solo incluyen campos del usuario que son visibles públicamente para otros usuarios en el dominio.