Directory API: Nutzeraliasse

Nutzeralias erstellen

Ein Nutzeralias ist eine alternative E-Mail-Adresse, die dasselbe Postfach wie die primäre E-Mail-Adresse des Nutzers verwendet. Ein Nutzeralias kann mit einer anderen Kontodomain als der Domain verknüpft werden, die von der primären E-Mail-Adresse des Nutzers verwendet wird. Innerhalb von 24 Stunden (häufig früher) erhält der Nutzer E-Mails, die an diese Adresse gesendet werden. Die API erfordert, dass die Inhaberschaft der Domain bestätigt wurde, bevor Sie den Nutzeralias erstellen können.

Verwenden Sie zum Erstellen eines Nutzeralias die folgende POST-Anfrage und fügen Sie die unter Anfragen autorisieren beschriebene Autorisierung ein. Bei userKey kann es sich um die primäre E-Mail-Adresse des Nutzers, den Nutzer id oder eine beliebige E-Mail-Adresse des Nutzeralias handeln. Informationen zu den Anfrage- und Antwortattributen finden Sie in der API-Referenz: 

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

JSON-Anfrage

Die folgende JSON-Anfrage zeigt eine Beispielanfrage zum Erstellen eines Nutzeralias. Der Nutzer ist liz@beispiel.de und das Alias lautet liz@beispiel.de: 

POST https://admin.googleapis.com/admin/directory/v1/users/liz@example.com/aliases
Der Anfragetext enthält die neuen Alias-Informationen: 
{  
 "alias": "chica@example.com"
}

Bei einer erfolgreichen Antwort wird der HTTP 201-Statuscode zurückgegeben. Zusammen mit dem Statuscode werden in der Antwort die Eigenschaften für den neuen Nutzeralias zurückgegeben.

Alle Aliasse eines Nutzers abrufen

Wenn Sie alle Aliasse eines Nutzers domainübergreifend abrufen möchten, verwenden Sie die folgende GET-Anfrage und fügen Sie die unter Anfragen autorisieren beschriebene Autorisierung ein. Bei userKey kann es sich um die primäre E-Mail-Adresse des Nutzers, den Nutzer id oder eine beliebige E-Mail-Adresse des Nutzeralias handeln. Informationen zu den Anfrage- und Antwortattributen finden Sie in der API-Referenz: 

GET https://admin.googleapis.com/admin/directory/v1/users/userKey/aliases
Der Anfrage-URI gibt beispielsweise alle Aliasse für den „userKey“ zurück, also liz@beispiel.de: 
GET https://admin.googleapis.com/admin/directory/v1/users/liz@example.com/aliases

Alle Nutzeraliasse werden in alphabetischer Reihenfolge zurückgegeben. Es gibt keine Seitengröße wie den Abfragestring maxResults und keine Paginierung, die für die Antwort „Alle Aliasse abrufen“ verwendet wird.

JSON-Antwort

Bei einer erfolgreichen Antwort wird der HTTP-Statuscode 200 zurückgegeben. Zusammen mit dem Statuscode werden in der Antwort die Aliase des Nutzers in alphabetischer Reihenfolge zurückgegeben. Diese Aliasdomains sind die primäre Domain und weitere Domains im Konto: 

{
"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"
 }
]
}

Nutzeralias löschen

Verwenden Sie zum Löschen eines Nutzeralias die folgende DELETE-Anfrage und fügen Sie die unter Anfragen autorisieren beschriebene Autorisierung ein. Es kann bis zu 24 Stunden dauern, bis der Alias entfernt wird. Bei userKey kann es sich um die primäre E-Mail-Adresse des Nutzers, den Nutzer id oder eine der E-Mail-Adressen des Nutzeralias handeln. Und aliasId ist die E-Mail-Adresse des Alias, die gelöscht wird. Informationen zu den Anfrage- und Antwortattributen finden Sie in der API-Referenz. 

DELETE https://admin.googleapis.com/admin/directory/v1/users/userKey/aliases/aliasId
Mit der folgenden DELETE-Anfrage wird z. B. das Alias schickea@beispiel.de für den userKey gelöscht, liz@beispiel.de: 
DELETE https://admin.googleapis.com/admin/directory/v1/users/liz@example.com/aliases/chica@example.com

Bei einer erfolgreichen Antwort wird der HTTP-Statuscode 200 zurückgegeben.