Directory API: Nutzeraliasse

Nutzeralias erstellen

Der Alias eines Nutzers ist eine alternative E-Mail-Adresse, die dasselbe Postfach verwendet wie die primäre E-Mail-Adresse des Nutzers. Ein Nutzeralias kann mit einer anderen Kontodomain verknüpft sein als der Domain, die für die primäre E-Mail-Adresse des Nutzers verwendet wird. E-Mails werden innerhalb von 24 Stunden (oft auch schon früher) an die neu eingerichtete Adresse zugestellt. Die API erfordert, dass die Inhaberschaft der Domain bestätigt wird, bevor Sie den Nutzeralias erstellen können.

Wenn Sie einen Nutzeralias erstellen möchten, verwenden Sie die folgende POST-Anfrage und fügen Sie die in Anfragen autorisieren beschriebene Autorisierung ein. userKey kann die primäre E-Mail-Adresse des Nutzers, die E-Mail-Adresse des Nutzers id oder eine der E-Mail-Adressen der Nutzeraliasse sein. Informationen zu den Anfrage- und Antworteigenschaften finden Sie in der API-Referenz: 

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

JSON-Anfrage

Die folgende JSON-Anfrage ist ein Beispiel für eine Anfrage zum Erstellen des Alias eines Nutzers. Der Nutzer ist liz@beispiel.de und der Alias ist chica@beispiel.de: 

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

Bei einer erfolgreichen Antwort wird der HTTP-Statuscode 201 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 Aliase eines Nutzers in allen Domains abrufen möchten, verwenden Sie die folgende GET-Anfrage und fügen Sie die in Anfragen autorisieren beschriebene Autorisierung ein. userKey kann die primäre E-Mail-Adresse des Nutzers, die E-Mail-Adresse des Nutzers id oder eine der E-Mail-Adressen der Nutzeraliasse sein. Informationen zu den Anfrage- und Antworteigenschaften finden Sie in der API-Referenz: 

GET https://admin.googleapis.com/admin/directory/v1/users/userKey/aliases
 Mit diesem Anfrage-URI werden beispielsweise alle Aliasse für den Nutzerschlüssel liz@beispiel.de zurückgegeben: 
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 maxResults-Suchstring oder die Paginierung, die für die Antwort „Alle Aliase 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 Aliasse des Nutzers in alphabetischer Reihenfolge zurückgegeben. Diese Aliasdomains sind die primäre Domain und andere 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"
 }
]
}

Alias eines Nutzers löschen

Wenn Sie einen Nutzeralias löschen möchten, verwenden Sie die folgende DELETE-Anfrage und fügen Sie die in Anfragen autorisieren beschriebene Autorisierung ein. Es kann bis zu 24 Stunden dauern, bevor die Änderung wirksam wird. userKey kann die primäre E-Mail-Adresse des Nutzers, der Nutzer id oder eine der E-Mail-Adressen der Nutzeraliasse sein. aliasId ist die E-Mail-Adresse des Alias, der gelöscht wird. Informationen zu den Anfrage- und Antworteigenschaften finden Sie in der API-Referenz. 

DELETE https://admin.googleapis.com/admin/directory/v1/users/userKey/aliases/aliasId
 Mit dieser DELETE-Anfrage wird beispielsweise der Alias „chica@beispiel.de“ für den Nutzerschlüssel „liz@beispiel.de“ gelöscht: 
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.