Method: users.list

Recupera un elenco impaginato degli utenti eliminati o di tutti gli utenti di un dominio.

Richiesta HTTP

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

L'URL utilizza la sintassi gRPC Transcoding.

Parametri di ricerca

Parametri
customFieldMask

string

Un elenco di nomi di schema separati da virgole. Tutti i campi di questi schemi vengono recuperati. Deve essere impostato solo quando projection=custom.

customer

string

L'ID univoco dell'account Google Workspace del cliente. Nel caso di un account multidominio, per recuperare tutti i gruppi di un cliente, compila questo campo invece che il dominio. Puoi anche utilizzare l'alias my_customer per rappresentare customerId del tuo account. customerId viene restituito anche come parte della risorsa Utenti. È necessario specificare il parametro customer o domain.

domain

string

Il nome del dominio. Utilizza questo campo per recuperare i gruppi da un solo dominio. Per restituire tutti i domini per un account cliente, utilizza invece il parametro di ricerca customer. È necessario specificare il parametro customer o domain.

event

enum (Event)

Evento a cui è destinato l'abbonamento (in caso di iscrizione)

maxResults

integer

Numero massimo di risultati da restituire.

orderBy

enum (OrderBy)

Proprietà da utilizzare per ordinare i risultati.

pageToken

string

Token per specificare la pagina successiva nell'elenco

projection

enum (Projection)

Il sottoinsieme di campi da recuperare per questo utente.

query

string

Stringa di query per la ricerca nei campi utente. Per saperne di più sulla creazione di query utente, consulta la pagina Cercare utenti.

showDeleted

string

Se è impostato su true, recupera l'elenco degli utenti eliminati. (valore predefinito: false)

sortOrder

enum (SortOrder)

Indica se restituire risultati in ordine crescente o decrescente, ignorando maiuscole e minuscole.

viewType

enum (ViewType)

Indica se recuperare la visualizzazione pubblica a livello di dominio o solo dell'amministratore dell'utente. Per ulteriori informazioni, vedi Recuperare un utente come non amministratore.

Corpo della richiesta

Il corpo della richiesta deve essere vuoto.

Corpo della risposta

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Rappresentazione JSON
{
  "kind": string,
  "trigger_event": string,
  "etag": string,
  "users": [
    {
      object (User)
    }
  ],
  "nextPageToken": string
}
Campi
kind

string

Che tipo di risorsa è.

trigger_event

string

Evento che ha attivato questa risposta (utilizzato solo in caso di risposta push)

etag

string

ETag della risorsa.

users[]

object (User)

Un elenco di oggetti utente.

nextPageToken

string

Token utilizzato per accedere alla pagina successiva di questo risultato.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti 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

Per scoprire di più, consulta la Panoramica di OAuth 2.0.

Evento

Tipo dell'evento di abbonamento

Enum
ADD Evento creato dall'utente
DELETE Evento eliminato dall'utente
MAKE_ADMIN Evento modifica stato amministratore utente
UNDELETE Evento utente non eliminato
UPDATE Evento aggiornato utente

OrderBy

Enum
EMAIL Email principale dell'utente.
FAMILY_NAME Cognome dell'utente.
GIVEN_NAME Nome dell'utente.

Projection

Enum
BASIC Non includere campi personalizzati per l'utente.
CUSTOM Includi i campi personalizzati degli schemi richiesti in customFieldMask.
FULL Includi tutti i campi associati a questo utente.

SortOrder

Enum
ASCENDING Ordine crescente.
DESCENDING Ordine decrescente.

Tipo di vista

Enum
admin_view I risultati includono sia i campi solo amministratore sia il campo pubblico del dominio per l'utente.
domain_public I risultati includono solo i campi relativi all'utente visibili pubblicamente ad altri utenti del dominio.