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 adresiyle aynı posta kutusunu kullanan alternatif bir e-posta adresidir. Kullanıcı takma adı, kullanıcının birincil e-posta adresinin kullandığı alandan 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ı oluşturabilmeniz için alan adının sahipliğinin onaylanmasını gerektirir. Takma adlar, konuk kullanıcılar için desteklenmez.

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, kullanıcı id 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ğinde, kullanıcının takma adını oluşturmaya yönelik örnek bir istek gösterilmektedir. Kullanıcı adı 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ıyor:

{  
 "alias": "chica@example.com"
}

Başarılı bir yanıt, HTTP 201 durum kodu döndürü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 dahil edin. userKey, kullanıcının birincil e-posta adresi, kullanıcı id 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, userKey için tüm takma adları (liz@example.com) döndürür:

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

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

JSON yanıtı

Başarılı bir yanıt HTTP 200 durum kodu döndürür. Yanıt, durum koduyla birlikte kullanıcının diğer 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

Bir kullanıcı diğer 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, kullanıcı id veya kullanıcı takma adlarının e-posta adreslerinden herhangi biri olabilir. aliasId ise silinen takma adın 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, userKey için chica@example.com takma adını siler, liz@example.com:

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

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