Recupera una lista paginada de 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 |
Una lista de nombres de esquema separados por comas. Se recuperan todos los campos de estos esquemas. Solo se debe configurar cuando |
customer |
El ID único de la cuenta de Google Workspace del cliente. En el caso de una cuenta de varios dominios, para recuperar todos los grupos de un cliente, usa este campo en lugar de |
domain |
Es el nombre de dominio. Usa este campo para obtener grupos de un solo dominio. Para mostrar todos los dominios de una cuenta de cliente, usa el parámetro de búsqueda |
event |
Evento en el que está prevista la suscripción (si se suscribe) |
maxResults |
Cantidad máxima de resultados que se mostrarán |
orderBy |
Es la propiedad que se usa para ordenar los resultados. |
pageToken |
Token para especificar la página siguiente en la lista |
projection |
El subconjunto de campos que se debe recuperar para este usuario. |
query |
Cadena de consulta para buscar campos de usuario Si deseas obtener más información para crear consultas de usuarios, lee el artículo Cómo buscar usuarios. |
showDeleted |
Si se configura como |
sortOrder |
Indica si se deben mostrar los resultados en orden ascendente o descendente, sin distinguir entre mayúsculas y minúsculas. |
viewType |
Indica si se debe recuperar la vista pública del usuario solo de administrador o de 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 ( |
Campos | |
---|---|
kind |
Este es el tipo de recurso. |
trigger_event |
Evento que activó esta respuesta (solo se usa en el caso de una respuesta de envío) |
etag |
ETag del recurso. |
users[] |
Una lista de objetos de usuario. |
nextPageToken |
El token se usa para acceder a la página siguiente de este resultado. |
Alcances de 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 guía de autorización.
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 del usuario |
UNDELETE |
Evento no borrado del usuario |
UPDATE |
Evento actualizado del usuario |
OrderBy
Enumeradores | |
---|---|
EMAIL |
Es el correo electrónico principal del usuario. |
FAMILY_NAME |
Apellido del usuario |
GIVEN_NAME |
Es el nombre del usuario. |
Proyección
Enumeradores | |
---|---|
BASIC |
No incluyas ningún campo personalizado para el usuario. |
CUSTOM |
Incluye campos personalizados de esquemas solicitados en customFieldMask . |
FULL |
Incluye todos los campos asociados con este usuario. |
SortOrder
Enumeradores | |
---|---|
ASCENDING |
Orden ascendente. |
DESCENDING |
Orden descendente. |
ViewType
Enumeradores | |
---|---|
admin_view |
Los resultados incluyen los campos solo para administrador y público del dominio para el usuario. |
domain_public |
Los resultados solo incluyen campos para el usuario que son visibles públicamente para otros usuarios del dominio. |