API Directory: alias utente

Creare un alias utente

L'alias di un utente è un indirizzo email alternativo che utilizza la stessa casella di posta utilizzata dall'indirizzo email principale dell'utente. Un alias utente può essere associato a un dominio dell'account diverso da quello dominio utilizzato dall'indirizzo email principale dell'utente. Entro 24 ore (spesso prima), l'utente inizia a ricevere le email inviate a questo indirizzo. L'API richiede che la proprietà del dominio sia confermata prima di poter creare l'alias utente. Gli alias non sono supportati per gli utenti ospiti.

Per creare un alias utente, utilizza la seguente richiesta POST e includi l'autorizzazione descritta nell'articolo relativo all'autorizzazione delle richieste. userKey può essere l'indirizzo email principale dell'utente, l'id utente o uno qualsiasi degli indirizzi email degli alias utente. Per le proprietà della richiesta e della 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 è liz@example.com e l'alias è chica@example.com:

POST https://admin.googleapis.com/admin/directory/v1/users/liz@example.com/aliases
Il corpo della richiesta contiene le nuove informazioni sull'alias:
{  
 "alias": "chica@example.com"
}

Una risposta riuscita restituisce un codice di stato HTTP 201. Oltre al codice di stato, la risposta restituisce le proprietà del nuovo alias 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'id utente o uno qualsiasi degli indirizzi email degli alias utente. Per le proprietà della richiesta e della risposta, consulta il Riferimento API:

GET https://admin.googleapis.com/admin/directory/v1/users/userKey/aliases
Ad esempio, questo URI della richiesta restituisce tutti gli alias per userKey, liz@example.com:
GET https://admin.googleapis.com/admin/directory/v1/users/liz@example.com/aliases

Tutti gli alias utente vengono restituiti in ordine alfabetico. Non esiste una dimensione della pagina, come la stringa di query maxResults o la paginazione utilizzata per la risposta "Recupera 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 alias sono il dominio principale e altri domini multipli nell'account:

{
"kind": "directory#user#aliases",
"aliases": [
 {
  "kind": "directory#user#alias",
  "id": "the unique user id",
  "primary_email": "liz@example.com",
  "alias": "chica@example.com"
 },
 {
  "kind": "directory#user#alias",
  "id": "the unique user id",
  "primary_email": "liz@example.com",
  "alias": "support@example.com"
 },
 {
  "kind": "directory#user#alias",
  "id": "the unique user id",
  "primary_email": "liz@example.com",
  "alias": "help@hr.example.com"
 },
 {
  "kind": "directory#user#alias",
  "id": "the unique user id",
  "primary_email": "liz@example.com",
  "alias": "tickets@jumboinc.com"
 }
]
}

Eliminare l'alias di un utente

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

DELETE https://admin.googleapis.com/admin/directory/v1/users/userKey/aliases/aliasId
Ad esempio, questa richiesta DELETE elimina l'alias chica@example.com per userKey, liz@example.com:
DELETE https://admin.googleapis.com/admin/directory/v1/users/liz@example.com/aliases/chica@example.com

Una risposta riuscita restituisce un codice di stato HTTP 200.