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. 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. El customerId también se muestra como parte del recurso Users. Debes proporcionar el parámetro customer o domain.
domain

string

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 consulta customer. Se debe proporcionar uno de los parámetros customer o domain.
event

enum (Event)

Es el evento para el que se diseñó la suscripción (si se suscribe).
maxResults

integer

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

enum (OrderBy)

Es la propiedad que se usará para ordenar los resultados.
pageToken

string

Es un token para especificar la página siguiente de la lista. El token de página solo es válido por tres días.
projection

enum (Projection)

Es el subconjunto de campos que se recuperarán para este usuario.
query

string

Cadena de consulta para buscar campos de usuario. Para obtener más información sobre la construcción de consultas de usuarios, consulta Cómo buscar usuarios.
showDeleted

string

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

enum (SortOrder)

Si se devuelven resultados en orden ascendente o descendente, sin tener en cuenta mayúsculas o minúsculas.
viewType

enum (ViewType)

Indica si se debe recuperar la vista pública del usuario solo para administradores o para todo el dominio. Para obtener más información, consulta Cómo recuperar 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

Indica el tipo de recurso.
trigger_event

string

Es el evento que activó esta respuesta (solo se usa en el caso de la 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 siguiente página de este resultado. El token de página solo es válido por tres días.

Permisos 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 de evento de Subscription

Enumeraciones
ADD Evento creado por el usuario
DELETE Evento de eliminación de usuario
MAKE_ADMIN Evento de cambio de estado de administrador de usuarios
UNDELETE Evento de recuperación de usuario
UPDATE Evento de actualización del usuario

OrderBy

Enumeraciones
EMAIL Es el correo electrónico principal del usuario.
FAMILY_NAME Es el 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 de solo administrador para el usuario.
domain_public Los resultados solo incluyen campos del usuario que son visibles públicamente para otros usuarios del dominio.