Risorsa: utente
L'API Directory consente di creare e gestire gli utenti, gli alias utente e le foto del profilo Google del tuo account. Per ulteriori informazioni sulle attività comuni, consulta la Guida per gli sviluppatori sugli account utente e la Guida per gli sviluppatori sugli alias utente.
Rappresentazione JSON |
---|
{
"id": string,
"primaryEmail": string,
"password": value,
"hashFunction": string,
"isAdmin": boolean,
"isDelegatedAdmin": boolean,
"agreedToTerms": boolean,
"suspended": boolean,
"changePasswordAtNextLogin": boolean,
"ipWhitelisted": boolean,
"name": {
object ( |
Campi | |||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id |
L'ID univoco dell'utente. Un utente |
||||||||||||||||||||||||||||||||||||||||||
primaryEmail |
L'indirizzo email principale dell'utente. Questa proprietà è obbligatoria in una richiesta per creare un account utente. |
||||||||||||||||||||||||||||||||||||||||||
password |
Memorizza la password per l'account utente. Il valore della password dell'utente è obbligatorio durante la creazione di un account utente. È facoltativo quando si aggiorna un utente e deve essere fornito solo se l'utente sta aggiornando la password del proprio account. Il valore della password non viene mai restituito nel corpo della risposta dell'API. |
||||||||||||||||||||||||||||||||||||||||||
hashFunction |
Memorizza il formato dell'hash della proprietà
Se i round sono specificati all'interno del prefisso, devono essere al massimo 10.000. |
||||||||||||||||||||||||||||||||||||||||||
isAdmin |
Solo output. Indica un utente con privilegi di super amministratore. La proprietà |
||||||||||||||||||||||||||||||||||||||||||
isDelegatedAdmin |
Solo output. Indica se l'utente è un utente con delega di amministratore. |
||||||||||||||||||||||||||||||||||||||||||
agreedToTerms |
Solo output. Questa proprietà è |
||||||||||||||||||||||||||||||||||||||||||
suspended |
Indica se l'utente è sospeso. |
||||||||||||||||||||||||||||||||||||||||||
changePasswordAtNextLogin |
Indica se l'utente è costretto a cambiare la password al successivo accesso. Questa impostazione non si applica se l'utente accede tramite un provider di identità di terze parti. |
||||||||||||||||||||||||||||||||||||||||||
ipWhitelisted |
Se |
||||||||||||||||||||||||||||||||||||||||||
name |
Contiene il nome e il cognome dell'utente e il valore di sola lettura |
||||||||||||||||||||||||||||||||||||||||||
kind |
Solo output. Il tipo di risorsa API. Per le risorse Utente, il valore è |
||||||||||||||||||||||||||||||||||||||||||
etag |
Solo output. ETag della risorsa. |
||||||||||||||||||||||||||||||||||||||||||
emails |
L'elenco degli indirizzi email dell'utente. La dimensione massima consentita dei dati è 10 kB.
|
||||||||||||||||||||||||||||||||||||||||||
externalIds |
L'elenco degli ID esterni dell'utente, ad esempio un ID dipendente o di rete. La dimensione massima consentita dei dati è 2 KB.
|
||||||||||||||||||||||||||||||||||||||||||
relations |
L'elenco dei rapporti dell'utente con altri utenti. La dimensione massima consentita per i dati di questo campo è 2 KB. Per ulteriori informazioni, consulta Gestire gli account utente.
|
||||||||||||||||||||||||||||||||||||||||||
aliases[] |
Solo output. L'elenco degli indirizzi email degli alias dell'utente. |
||||||||||||||||||||||||||||||||||||||||||
isMailboxSetup |
Solo output. Indica se la casella di posta Google dell'utente è stata creata. Questa proprietà è applicabile solo se all'utente è stata assegnata una licenza Gmail. |
||||||||||||||||||||||||||||||||||||||||||
customerId |
Solo output. L'ID cliente per recuperare tutti gli utenti dell'account. |
||||||||||||||||||||||||||||||||||||||||||
addresses |
L'elenco degli indirizzi dell'utente. La dimensione massima consentita dei dati è 10 KB.
|
||||||||||||||||||||||||||||||||||||||||||
organizations |
L'elenco delle organizzazioni a cui appartiene l'utente. La dimensione massima consentita dei dati è 10 kB.
|
||||||||||||||||||||||||||||||||||||||||||
lastLoginTime |
Solo output. L'ultima volta che l'utente ha eseguito l'accesso all'account. Il valore è nel formato di data e ora ISO 8601. L'ora è la data completa più ore, minuti e secondi nel modulo |
||||||||||||||||||||||||||||||||||||||||||
phones |
Un elenco dei numeri di telefono dell'utente. La dimensione massima consentita dei dati è 1 KB.
|
||||||||||||||||||||||||||||||||||||||||||
suspensionReason |
Solo output. Il motivo per cui un account utente è sospeso dall'amministratore o da Google al momento della sospensione. La proprietà viene restituita solo se la proprietà |
||||||||||||||||||||||||||||||||||||||||||
thumbnailPhotoUrl |
Solo output. L'URL della foto del profilo dell'utente. L'URL potrebbe essere temporaneo o privato. |
||||||||||||||||||||||||||||||||||||||||||
languages |
L'elenco delle lingue dell'utente. La dimensione massima consentita dei dati è 1 KB.
|
||||||||||||||||||||||||||||||||||||||||||
posixAccounts |
L'elenco dei dati dell'account POSIX dell'utente.
|
||||||||||||||||||||||||||||||||||||||||||
creationTime |
Solo output. L'ora in cui è stato creato l'account dell'utente. Il valore è nel formato data e ora ISO 8601. L'ora è la data completa più ore, minuti e secondi nel formato |
||||||||||||||||||||||||||||||||||||||||||
nonEditableAliases[] |
Solo output. L'elenco degli indirizzi email degli alias non modificabili dell'utente. In genere non appartengono al dominio principale o al sottodominio dell'account. |
||||||||||||||||||||||||||||||||||||||||||
sshPublicKeys |
Un elenco di chiavi pubbliche SSH.
|
||||||||||||||||||||||||||||||||||||||||||
notes |
Note per l'utente sotto forma di oggetto nidificato.
|
||||||||||||||||||||||||||||||||||||||||||
websites |
L'elenco dei siti web dell'utente.
|
||||||||||||||||||||||||||||||||||||||||||
locations |
L'elenco delle località dell'utente. La dimensione massima consentita dei dati è 10 KB.
|
||||||||||||||||||||||||||||||||||||||||||
includeInGlobalAddressList |
Indica se il profilo dell'utente è visibile nell'elenco indirizzi globale di Google Workspace quando la funzionalità di condivisione dei contatti è attivata per il dominio. Per ulteriori informazioni sull'esclusione di profili utente, consulta il Centro assistenza per l'amministrazione. |
||||||||||||||||||||||||||||||||||||||||||
keywords |
L'elenco delle parole chiave dell'utente. La dimensione massima consentita dei dati è 1 KB.
|
||||||||||||||||||||||||||||||||||||||||||
deletionTime |
Solo output. La data e l'ora in cui l'account dell'utente è stato eliminato. Il valore è nel formato data e ora ISO 8601. L'ora è la data completa più ore, minuti e secondi nel formato |
||||||||||||||||||||||||||||||||||||||||||
gender |
Un oggetto nidificato contenente il genere dell'utente. La dimensione massima consentita per i dati di questo campo è 1 KB.
|
||||||||||||||||||||||||||||||||||||||||||
thumbnailPhotoEtag |
Solo output. ETag della foto dell'utente (sola lettura) |
||||||||||||||||||||||||||||||||||||||||||
ims |
Gli account di messaggistica immediata (IM) dell'utente. Un account utente può avere più proprietà
|
||||||||||||||||||||||||||||||||||||||||||
customSchemas |
Campi personalizzati dell'utente. La chiave è
|
||||||||||||||||||||||||||||||||||||||||||
isEnrolledIn2Sv |
Solo output. È registrato per la verifica in due passaggi (sola lettura) |
||||||||||||||||||||||||||||||||||||||||||
isEnforcedIn2Sv |
Solo output. Verifica in due passaggi applicata (sola lettura) |
||||||||||||||||||||||||||||||||||||||||||
archived |
Indica se l'utente è archiviato. |
||||||||||||||||||||||||||||||||||||||||||
orgUnitPath |
Il percorso completo dell'organizzazione principale associata all'utente. Se l'organizzazione principale è di primo livello, è rappresentata da una barra ( |
||||||||||||||||||||||||||||||||||||||||||
recoveryEmail |
Email di recupero dell'utente. |
||||||||||||||||||||||||||||||||||||||||||
recoveryPhone |
Numero di telefono di recupero dell'utente. Il numero di telefono deve essere nel formato E.164 e deve iniziare con il segno più (+). Esempio: +16506661212. |
UserName
Rappresentazione JSON |
---|
{ "fullName": string, "familyName": string, "givenName": string, "displayName": string } |
Campi | |
---|---|
fullName |
Il nome completo dell'utente formato concatenando i valori del nome e del cognome. |
familyName |
Il cognome dell'utente. Obbligatorio per la creazione di un account utente. |
givenName |
Il nome dell'utente. Obbligatorio per la creazione di un account utente. |
displayName |
Il nome visualizzato dell'utente. Limite: 256 caratteri. |
Metodi |
|
---|---|
|
Elimina un utente. |
|
Recupera un utente. |
|
Crea un utente. |
|
Recupera un elenco paginato di utenti eliminati o di tutti gli utenti di un dominio. |
|
Imposta un utente come super amministratore. |
|
Aggiorna un utente utilizzando la semantica delle patch. |
|
Disconnette un utente da tutte le sessioni web e del dispositivo e reimposta i suoi cookie di accesso. |
|
Annullamento dell'eliminazione di un utente. |
|
Aggiorna un utente. |
|
Rileva le modifiche nell'elenco di utenti. |