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 önce alanı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 dahil edin. userKey; kullanıcının birincil e-posta adresi, id kullanıcısı veya kullanıcı takma adlarından herhangi biri e-posta adresi 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ı takma adı oluşturmaya yönelik örnek bir istek gösterilmektedir. Kullanıcı liz@example.com'dur ve takma ad da chia@example.com'dur:

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

Başarılı bir yanıt, bir HTTP 201 durum kodu döndürür. Yanıt, durum koduyla birlikte yeni kullanıcı takma adına ilişkin özellikleri döndürür.

Kullanıcının tüm takma adlarını al

Tüm alan adlarında kullanıcının takma adlarının tamamı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, id kullanıcısı veya kullanıcı takma adlarından herhangi biri e-posta adresi 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, şu istek URI'si liz@example.com adlı userKey için tüm takma adları 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ırada 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, bir HTTP 200 durum kodu döndürür. Yanıt, durum koduyla birlikte, kullanıcının takma adlarını alfabetik sırada döndürür. Aşağıdaki alan takma adları, birincil alan ve hesaptaki diğer birden çok alan adıdı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ı takma adını silmek için aşağıdaki DELETE isteğini kullanın ve İstekleri yetkilendirme bölümünde açıklanan yetkilendirmeyi dahil edin. 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ından herhangi biri e-posta adresi olabilir. Ayrıca aliasId, takma adın silinmekte olan 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 chia@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ıt, bir HTTP 200 durum kodu döndürür.