Method: users.list

Recupera un elenco paginato di 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 query

Parametri
customFieldMask

string

Un elenco separato da virgole di nomi di schemi. Vengono recuperati tutti i campi di questi schemi. Questo valore deve essere impostato solo quando projection=custom.
customer

string

L'ID univoco dell'account Google Workspace del cliente. In caso di un account multidominio, per recuperare tutti gli utenti di un cliente, utilizza questo campo anziché domain. Puoi anche utilizzare l'alias my_customer per rappresentare il customerId del tuo account. customerId viene restituito anche all'interno della risorsa Utenti. Devi fornire il parametro customer o domain.
domain

string

Il nome di dominio. Utilizza questo campo per ottenere gli utenti di un solo dominio. Per restituire tutti i domini per un account cliente, utilizza il parametro di query customer. È necessario specificare il parametro customer o domain.
event

enum (Event)

Evento a cui si riferisce l'iscrizione (se presente)
maxResults

integer

Il 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. Il token pagina è valido solo per tre giorni.
projection

enum (Projection)

Il sottoinsieme di campi da recuperare per questo utente.
query

string

Stringa di query per la ricerca nei campi utente. Per ulteriori informazioni sulla creazione di query sugli utenti, vedi Cercare utenti.
showDeleted

string

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

enum (SortOrder)

Indica se i risultati devono essere restituiti in ordine crescente o decrescente, ignorando le maiuscole.
viewType

enum (ViewType)

Indica se recuperare la visualizzazione pubblica solo per gli amministratori o a livello di dominio dell'utente. Per saperne di più, vedi Recuperare un utente come utente 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. Il token pagina è valido solo per tre giorni.

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 Subscription

Enum
ADD Evento creato dall'utente
DELETE Evento utente eliminato
MAKE_ADMIN Evento di modifica dello stato amministratore utente
UNDELETE Evento di annullamento dell'eliminazione dell'utente
UPDATE Evento di aggiornamento utente

OrderBy

Enum
EMAIL Indirizzo email principale dell'utente.
FAMILY_NAME Il cognome dell'utente.
GIVEN_NAME Nome dell'utente.

Projection

Enum
BASIC Non includere campi personalizzati per l'utente.
CUSTOM Includi i campi personalizzati dagli 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 sia i campi riservati agli amministratori sia quelli pubblici del dominio per l'utente.
domain_public I risultati includono solo i campi per l'utente che sono visibili pubblicamente agli altri utenti del dominio.