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 di account diverso da quello 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 venga confermata prima di poter creare l'alias utente.

Per creare un alias utente, utilizza la seguente richiesta POST e includi l'autorizzazione descritta in Autorizzare richieste. userKey può essere l'indirizzo email principale dell'utente, l'utente id o qualsiasi indirizzo email degli alias utente. Per le proprietà richiesta e risposta, consulta la documentazione di 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 informazioni sul nuovo alias:
{  
 "alias": "chica@example.com"
}

Una risposta corretta restituisce un codice di stato HTTP 201. Insieme al codice di stato, la risposta restituisce le proprietà per il 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 in Autorizzare le richieste. userKey può essere l'indirizzo email principale dell'utente, l'utente id o qualsiasi indirizzo email degli alias utente. Per le proprietà richiesta e risposta, consulta la documentazione di 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 esistono dimensioni di pagina come la stringa di query maxResults o l'impaginazione utilizzata per la risposta "Recupera tutti gli alias".

Risposta JSON

Una risposta corretta restituisce un codice di stato HTTP 200. Insieme 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 Autorizzare richieste. La rimozione dell'alias può richiedere fino a 24 ore. userKey può essere l'indirizzo email principale dell'utente, l'utente id o una qualsiasi delle email degli alias utente. E 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
Ad esempio, questa richiesta DELETE elimina l'alias chica@example.com per la chiave utente liz@example.com:
DELETE https://admin.googleapis.com/admin/directory/v1/users/liz@example.com/aliases/chica@example.com

Una risposta corretta restituisce un codice di stato HTTP 200.