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 Kontodomäne verknüpft sein als die Domäne, die von der primären E-Mail-Adresse des Nutzers verwendet wird. Innerhalb von 24 Stunden (oft früher) erhält der Nutzer E-Mails, die an diese Adresse gesendet werden. Für die API muss die Inhaberschaft der Domain bestätigt werden bevor Sie das Nutzeralias erstellen können. Aliasse werden für Gastnutzer nicht unterstützt.

Verwenden Sie die folgende POST Anfrage, um ein Nutzeralias zu erstellen, und fügen Sie die in Anfragen autorisieren beschriebene Autorisierung ein. Der userKey kann die primäre E-Mail-Adresse des Nutzers, die id des Nutzers oder eine der E-Mail-Adressen der Nutzeraliasse sein. Die Anfrage- und Antwortattribute 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@example.com und das Alias ist chica@example.com:

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 Attribute für das neue Nutzeralias zurückgegeben.

Alle Aliasse eines Nutzers abrufen

Wenn Sie alle Aliasse 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. Der userKey kann die primäre E-Mail-Adresse des Nutzers, die id des Nutzers oder eine der E-Mail-Adressen der Nutzeraliasse sein. Die Anfrage- und Antwortattribute finden Sie in der API-Referenz:

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

Dieser Anfrage-URI gibt beispielsweise alle Aliasse für den userKey liz@example.com zurück:

GET https://admin.googleapis.com/admin/directory/v1/users/liz@example.com/aliases

Alle Nutzeraliasse werden in alphabetischer Reihenfolge zurückgegeben. Für die Antwort „Alle Aliasse abrufen“ wird keine Seitengröße wie der maxResults Abfragestring oder die Paginierung verwendet.

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

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

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

Diese DELETE-Anfrage löscht beispielsweise das Alias chica@example.com für den userKey liz@example.com:

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.