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 di transcodifica gRPC.

Parametri di ricerca

Parametri
customFieldMask

string

Un elenco di nomi di schemi separati da virgole. Vengono recuperati tutti i campi di questi schemi. Deve essere impostato soltanto quando projection=custom.
customer

string

L'ID univoco dell'account Google Workspace del cliente. Nel caso di un account con più domini, per recuperare tutti i gruppi per un cliente utilizza questo campo anziché domain. Puoi utilizzare l'alias my_customer anche per rappresentare i dati customerId del tuo account. customerId viene restituito anche come parte della risorsa Users. Devi fornire il parametro customer o domain.
domain

string

Il nome di 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 query customer. È necessario specificare il parametro customer o domain.
event

enum (Event)

Evento a cui è destinato l'abbonamento (se ti abboni)
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)

Quale sottoinsieme di campi recuperare per questo utente.
query

string

Stringa di query per la ricerca nei campi utente. Per ulteriori informazioni sulla creazione di query utente, consulta Ricerca di utenti.
showDeleted

string

Se impostato su true, consente di recuperare l'elenco degli utenti eliminati. (valore predefinito: false)
sortOrder

enum (SortOrder)

Indica se restituire i risultati in ordine crescente o decrescente, ignorando le maiuscole.
viewType

enum (ViewType)

Indica se recuperare la visualizzazione pubblica dell'utente riservata all'amministratore o a livello di dominio. Per maggiori 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

Il 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 ulteriori informazioni, consulta la guida all'autorizzazione.

Evento

Tipo di evento Abbonamento

Enum
ADD Evento creato dall'utente
DELETE Evento eliminato dall'utente
MAKE_ADMIN Evento di modifica stato amministratore utente
UNDELETE Evento utente non eliminato
UPDATE Evento aggiornato dall'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 campi personalizzati degli schemi richiesti in customFieldMask.
FULL Includi tutti i campi associati a questo utente.

SortOrder

Enum
ASCENDING Ordine crescente.
DESCENDING Ordine decrescente.

ViewType

Enum
admin_view I risultati includono i campi solo amministratore e pubblico per l'utente.
domain_public I risultati includono solo i campi dell'utente visibili pubblicamente ad altri utenti del dominio.