Directory API: Kullanıcı Takma Adları

Kullanıcı takma adı oluşturma

Kullanıcının takma adı, kullanıcının birincil e-posta adresi tarafından kullanılan posta kutusunu kullanan alternatif bir e-posta adresidir. Kullanıcı takma adı, kullanıcının birincil e-posta adresi tarafından kullanılan alan adından farklı bir hesap alanıyla ilişkilendirilebilir. 24 saat içinde (genellikle daha kısa sürede) kullanıcı, bu adrese gönderilen e-postaları almaya başlar. API, kullanıcı takma adını oluşturabilmeniz için alan adının sahipliğinin onaylanmasını gerektirir.

Kullanıcı takma adı oluşturmak için aşağıdaki POST isteğini kullanın ve İstekleri yetkilendirme bölümünde açıklanan yetkilendirmeyi ekleyin. userKey, kullanıcının birincil e-posta adresi, id kullanıcısı veya kullanıcı takma adlarının e-posta adreslerinden herhangi biri olabilir. İstek ve yanıt özellikleri için API Referansı'na bakın:

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

JSON isteği

Aşağıdaki JSON isteği, kullanıcının takma adını oluşturmaya yönelik örnek bir isteği gösterir. Kullanıcı liz@example.com, takma ad ise chica@example.com:

POST https://admin.googleapis.com/admin/directory/v1/users/liz@example.com/aliases
İstek metninde yeni takma ad bilgileri yer alır:
{  
 "alias": "chica@example.com"
}

Başarılı bir yanıtta HTTP 201 durum kodu döndürülür. Yanıt, durum koduyla birlikte yeni kullanıcı takma adının özelliklerini döndürür.

Bir kullanıcının tüm takma adlarını alma

Bir kullanıcının tüm alanlardaki tüm takma adlarını almak için aşağıdaki GET isteğini kullanın ve İstekleri yetkilendirme bölümünde açıklanan yetkilendirmeyi ekleyin. userKey, kullanıcının birincil e-posta adresi, id kullanıcısı veya kullanıcı takma adlarının e-posta adreslerinden herhangi biri olabilir. İstek ve yanıt özellikleri için API Referansı'na bakın:

GET https://admin.googleapis.com/admin/directory/v1/users/userKey/aliases
Örneğin, bu istek URI'si, liz@example.com kullanıcı anahtarının tüm takma adlarını döndürür:
GET https://admin.googleapis.com/admin/directory/v1/users/liz@example.com/aliases

Tüm kullanıcı takma adları alfabetik olarak döndürülür. "Tüm takma adları al" yanıtı için kullanılan maxResults sorgu dizesi veya sayfalandırma gibi bir sayfa boyutu yoktur.

JSON yanıtı

Başarılı bir yanıtta HTTP 200 durum kodu döndürülür. Yanıt, durum koduyla birlikte kullanıcının takma adlarını alfabetik sırayla döndürür. Bu takma ad alanları, birincil alan ve hesaptaki diğer birden fazla alandır:

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

Kullanıcının takma adını silme

Kullanıcı takma adını silmek için aşağıdaki DELETE isteğini kullanın ve İstekleri yetkilendirme bölümünde açıklanan yetkilendirmeyi ekleyin. Takma adın kaldırılması 24 saati bulabilir. userKey, kullanıcının birincil e-posta adresi, id kullanıcısı veya kullanıcı takma adlarının e-posta adreslerinden herhangi biri olabilir. aliasId ise silinen takma ad e-posta adresidir. İstek ve yanıt özellikleri için API referansı'na bakın.

DELETE https://admin.googleapis.com/admin/directory/v1/users/userKey/aliases/aliasId
Örneğin, bu DELETE isteği liz@example.com kullanıcı anahtarı için chica@example.com takma adını siler:
DELETE https://admin.googleapis.com/admin/directory/v1/users/liz@example.com/aliases/chica@example.com

Başarılı bir yanıtta HTTP 200 durum kodu döndürülür.