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 |
Un elenco di nomi di schema separati da virgole. Tutti i campi di questi schemi vengono recuperati. Deve essere impostato solo quando |
customer |
L'ID univoco dell'account Google Workspace del cliente. Nel caso di un account multi-dominio, per recuperare tutti i gruppi per un cliente, utilizza questo campo anziché |
domain |
Il nome di dominio. Utilizza questo campo per ricevere gruppi da un solo dominio. Per restituire tutti i domini per un account cliente, utilizza invece il parametro di ricerca |
event |
Evento a cui si riferisce l'abbonamento (in caso di iscrizione) |
maxResults |
Numero massimo di risultati da restituire. |
orderBy |
Proprietà da utilizzare per ordinare i risultati. |
pageToken |
Token per specificare la pagina successiva nell'elenco |
projection |
Quale sottoinsieme di campi è stato recuperato da questo utente. |
query |
Stringa di query per la ricerca nei campi utente. Per saperne di più sulla creazione di query utente, consulta la sezione Cercare utenti. |
showDeleted |
Se viene impostato su |
sortOrder |
Indica se restituire i risultati in ordine crescente o decrescente, ignorando maiuscole e minuscole. |
viewType |
Indica se recuperare la visualizzazione pubblica a livello di amministratore o di dominio dell'utente. Per saperne di più, 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 ( |
Campi | |
---|---|
kind |
Tipo di risorsa. |
trigger_event |
Evento che ha attivato questa risposta (utilizzato solo in caso di risposta rapida) |
etag |
ETag della risorsa. |
users[] |
Un elenco di oggetti utente. |
nextPageToken |
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 alle autorizzazioni.
Evento
Tipo di evento di iscrizione
Enum | |
---|---|
ADD |
Evento creato dall'utente |
DELETE |
Evento eliminato dall'utente |
MAKE_ADMIN |
Evento modifica stato amministratore utente |
UNDELETE |
Evento non eliminato utente |
UPDATE |
Evento aggiornato utente |
OrderBy
Enum | |
---|---|
EMAIL |
L'indirizzo email principale dell'utente. |
FAMILY_NAME |
Cognome dell'utente. |
GIVEN_NAME |
Nome dell'utente. |
Proiezione
Enum | |
---|---|
BASIC |
Non includere alcun campo personalizzato 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 visualizzazione
Enum | |
---|---|
admin_view |
I risultati includono sia i campi solo amministratore sia il campo pubblico dell'utente. |
domain_public |
I risultati includono solo i campi relativi all'utente visibili pubblicamente ad altri utenti del dominio. |