API Directory: alias utente

Mantieni tutto organizzato con le raccolte Salva e classifica i contenuti in base alle tue preferenze.

Creare un alias utente

L'alias di un utente è un indirizzo email alternativo che utilizza la stessa cassetta postale dell'indirizzo email principale dell'utente. Un alias utente può essere associato a un dominio dell'account diverso da quello utilizzato dall'indirizzo email principale dell'utente. Entro 24 ore (spesso prima), l'utente inizia a ricevere email inviate a questo indirizzo. L'API richiede che la proprietà del dominio sia confermata prima che tu possa creare l'alias utente.

Per creare un alias utente, utilizza la seguente richiesta POST e includi l'autorizzazione descritta nell'articolo Autorizzare le richieste. userKey può essere l'indirizzo email principale dell'utente, l'utente id o uno degli indirizzi email degli alias dell'utente. Per le proprietà di richiesta e risposta, consulta il riferimento API:

POST https://admin.googleapis.com/admin/directory/v1/users/userKey/aliases

Richiesta JSON

La seguente richiesta JSON mostra una richiesta di esempio per creare l'alias di un utente. L'utente è [email protected] e l'alias è [email protected]:

POST https://admin.googleapis.com/admin/directory/v1/users/[email protected]/aliases

{  
 "alias": "[email protected]"
}

Una risposta riuscita restituisce un codice di stato HTTP 201. Oltre al codice di stato, la risposta restituisce le proprietà dell'alias del nuovo utente.

Recuperare tutti gli alias di un utente

Per recuperare tutti gli alias di un utente in tutti i domini, utilizza la seguente richiesta GET e includi l'autorizzazione descritta nell'articolo relativo all'autorizzazione delle richieste. userKey può essere l'indirizzo email principale dell'utente, l'utente id o uno degli indirizzi email degli alias dell'utente. Per le proprietà di richiesta e risposta, consulta il riferimento API:

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

GET https://admin.googleapis.com/admin/directory/v1/users/[email protected]/aliases

Tutti gli alias utente vengono restituiti in ordine alfabetico. Non sono presenti dimensioni di pagina, come la stringa di query maxResults o la paginazione, utilizzate per la risposta "Recupero di tutti gli alias".

Risposta JSON

Una risposta riuscita restituisce un codice di stato HTTP 200. Oltre al codice di stato, la risposta restituisce gli alias dell'utente in ordine alfabetico. Questi domini di alias sono il dominio principale e altri domini nell'account:

{
"kind": "directory#user#aliases",
"aliases": [
 {
  "kind": "directory#user#alias",
  "id": "the unique user id",
  "primary_email": "[email protected]",
  "alias": "[email protected]"
 },
 {
  "kind": "directory#user#alias",
  "id": "the unique user id",
  "primary_email": "[email protected]",
  "alias": "[email protected]"
 },
 {
  "kind": "directory#user#alias",
  "id": "the unique user id",
  "primary_email": "[email protected]",
  "alias": "[email protected]"
 },
 {
  "kind": "directory#user#alias",
  "id": "the unique user id",
  "primary_email": "[email protected]",
  "alias": "[email protected]"
 }
]
}

Eliminare l'alias di un utente

Per eliminare un alias utente, utilizza la seguente richiesta DELETE e includi l'autorizzazione descritta nell'articolo Autorizzare le richieste. L'eliminazione di un alias può richiedere fino a 24 ore. userKey può essere l'indirizzo email principale dell'utente, l'utente id o qualsiasi email degli alias dell'utente. aliasId è l'indirizzo email dell'alias che viene eliminato. Per le proprietà di richiesta e risposta, consulta il riferimento API.

DELETE https://admin.googleapis.com/admin/directory/v1/users/userKey/aliases/aliasId

DELETE https://admin.googleapis.com/admin/directory/v1/users/[email protected]/aliases/[email protected]

Una risposta riuscita restituisce un codice di stato HTTP 200.