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 |
Una lista de nombres de esquemas separados por comas. Se recuperan todos los campos de estos esquemas. Solo debe establecerse cuando |
customer |
Es 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 |
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 al que está destinado la suscripción (si se suscribió) |
maxResults |
Cantidad máxima de resultados que se mostrarán |
orderBy |
Propiedad que se usará para ordenar los resultados. |
pageToken |
Token para especificar la página siguiente en la lista |
projection |
El subconjunto de campos que se recuperará para este usuario. |
query |
Cadena de consulta para buscar campos de usuario Para obtener más información sobre la creación de consultas de los usuarios, consulte Búsqueda de usuarios. |
showDeleted |
Si se configura en |
sortOrder |
Indica si se muestran resultados en orden ascendente o descendente, sin distinguir entre mayúsculas y minúsculas. |
viewType |
Indica si se debe obtener una vista pública exclusiva del administrador o de todo el dominio del usuario. 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 |
Es el tipo de recurso. |
trigger_event |
Evento que activó esta respuesta (solo se usa en caso de una respuesta push) |
etag |
ETag del recurso. |
users[] |
Una lista de objetos de usuario |
nextPageToken |
Es el token que se usa para acceder a la siguiente página de este resultado. |
Permisos 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 eliminado por el usuario |
MAKE_ADMIN |
Evento de cambio de estado del administrador de usuarios |
UNDELETE |
Evento recuperado por el usuario |
UPDATE |
Evento actualizado por el usuario |
OrderBy
Enumeradores | |
---|---|
EMAIL |
Correo electrónico principal del usuario. |
FAMILY_NAME |
Apellido del usuario |
GIVEN_NAME |
Indica 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. |
Tipo de vista
Enumeradores | |
---|---|
admin_view |
Los resultados incluyen campos de administrador y de dominio público para el usuario. |
domain_public |
Los resultados solo incluyen campos para el usuario que son visibles de forma pública para otros usuarios del dominio. |