Directory API: Grup Üyeleri

Gruba üye ekleme

Bir gruba üye eklemek için aşağıdaki POST isteğini kullanın ve İstekleri yetkilendirme bölümünde açıklanan yetkilendirmeyi dahil edin. Grup üyesi, bir kullanıcı veya başka bir grup olabilir. groupKey, yeni üyenin grup e-posta adresi veya grubun benzersiz id adresidir. İstek ve yanıt özellikleri için API Referansı'na bakın: 

POST https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members

Bir grubu başka bir grubun üyesi olarak eklerseniz alt grubun üyelerinin üst grubun üyeleri olarak görünmesi 10 dakikayı bulabilir. Ayrıca API, grup üyeliklerindeki döngüler için bir hata döndürür. Örneğin, grup1 grup2'nin üyesiyse grup2, grup1'in üyesi olamaz.

JSON isteği

Aşağıdaki JSON isteğinde, grup üyesi oluşturan örnek bir istek gövdesi gösterilmektedir. Üyenin e-posta adresi liz@example.com şeklindedir ve üyenin gruptaki rolü MEMBER şeklindedir. POST isteği, groupKey için NNNNN'yi kullanır: 

POST https://admin.googleapis.com/admin/directory/v1/groups/NNNNN/members

{
   "email": "liz@example.com",
    "role": "MEMBER"
}

Bir grup üyesinin role özelliği şunlar olabilir:

  • OWNER - Bu rol, gruba mesaj gönderme, üye ekleyip kaldırma, üye rollerini değiştirme, grubun ayarlarını ve grubu silme işlemlerini değiştirebilir. OWNER, grubun üyesi olmalıdır.
  • MANAGER - Bu rol yalnızca Google Workspace, Yönetici konsolu kullanılarak etkinleştirildiyse kullanılabilir. YÖNETİCİ rolü, bir üyeyi SAHİP YAPMA veya grubu silme hariç, SAHİP rolü tarafından yapılan tüm işlemleri gerçekleştirebilir. Bir grubun birden fazla OWNER ve MANAGER üyesi olabilir.
  • MEMBER - Bu rol bir gruba abone olabilir, tartışma arşivlerini görüntüleyebilir ve grubun üyelik listesini görüntüleyebilir. Üye rolleriyle ilgili daha fazla bilgi edinmek için yönetim yardım merkezini inceleyin.

JSON yanıtı

Başarılı bir yanıt, bir HTTP 200 durum kodu ve üyenin üyelik bilgilerini döndürür. id, üyenin benzersiz üyelik kimliğidir: 

{
   "kind": "directory#member",
   "id": "group member's unique ID",
   "email": "liz@example.com",
   "role": "MEMBER",
   "type": "GROUP"
  }

Bir grup üyesinin type özelliği şunlar olabilir:

  • GROUP – Üye başka bir gruptur.
  • MEMBER – Üye bir kullanıcıdır

Grup üyeliğini güncelleme

Bir grup üyeliğini güncellemek için aşağıdaki PUT isteğini kullanın ve İstekleri yetkilendirme bölümünde açıklanan yetkilendirmeyi dahil edin. groupKey grubun e-posta adresi veya grubun benzersiz id adresidir. memberKey ise kullanıcının veya grubun birincil e-posta adresi, kullanıcının takma ad e-posta adresi ya da benzersiz id adresidir. İstek ve yanıt özellikleri için API Referansı'na bakın: 

PUT https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members/memberKey

JSON isteği

Aşağıdaki JSON isteğinde, grup üyeliği ayarlarını güncelleyen örnek bir istek gövdesi gösterilmektedir. Üyenin e-posta adresi liz@example.com olur ve üyenin gruptaki MEMBER olan rolü MANAGER olarak değiştirilir. Bu örnekte, PUT isteğinin groupKey özelliği NNNNN'dir. MEMBER, OWNER ve MANAGER rolleri hakkında bilgi edinmek için yönetim yardım merkezine bakın: 

PUT https://admin.googleapis.com/admin/directory/v1/groups/NNNNN/members/liz@example.com
{
   "email": "liz@example.com",
    "role": "MANAGER"
}

JSON yanıtı

Başarılı bir yanıt, bir HTTP 200 durum kodu ve güncellenmiş üyelik bilgilerini döndürür. id, üyenin benzersiz üyelik kimliğidir: 

{
   "kind": "directory#member",
   "id": "group member's unique ID",
   "email": "liz@example.com",
   "role": "MANAGER",
   "type": "GROUP"
  }

Bir grubun üyesini alma

Bir grup üyeliğini almak için aşağıdaki GET isteğini kullanın ve İstekleri yetkilendirme bölümünde açıklanan yetkilendirmeyi dahil edin. groupKey grubun e-posta adresi veya grubun benzersiz id adresidir. memberKey ise kullanıcının veya grubun birincil e-posta adresi, kullanıcının takma ad e-posta adresi ya da benzersiz id adresidir. İstek ve yanıt özellikleri için API Referansı'na bakın: 

GET https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members/memberKey

JSON yanıtı

Başarılı bir yanıt, bir HTTP 200 durum kodu ve üyenin üyelik bilgilerini döndürür. id, üyenin benzersiz üyelik kimliğidir: 

{
   "kind": "directory#member",
   "id": "group member's unique ID",
   "email": "liz@example.com",
   "role": "MANAGER",
   "type": "GROUP"
  }

Tüm grup üyelerini al

Tüm grup üyelerini almak için aşağıdaki GET isteğini kullanın ve İstekleri yetkilendirme bölümünde açıklanan yetkilendirmeyi dahil edin. groupKey, grubun e-posta adresi veya grubun benzersiz id adresidir. İsteğe bağlı roles sorgu dizesi, grup üyelerini role göre almanıza olanak tanıyan bir filtredir. Elde edilen rol koleksiyonları roles filtresinde belirtilen sıradadır. İstek ve yanıt özellikleri için API Referansı'na bakın. Okunabilirlik için bu örnekte satır sonuçları kullanılmaktadır: 

GET https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members
?pageToken=pagination token
&roles=one or more of OWNER,MANAGER,MEMBER separated by a comma
&maxResults=maximum results per response page

Tüm üyeler, üyelerin e-posta adreslerine göre alfabetik sırayla geri gönderilir. Çok sayıda üyesi olan yanıtlar için pageToken sorgu dizesini kullanın. Sayfalara ayırma söz konusu olduğunda yanıt, sonraki yanıt sonuçları sayfası için jetonu olan nextPageToken özelliğini döndürür. Bir sonraki isteğiniz, pageToken sorgu dize değeri olarak bu jetonu kullanır.

JSON yanıtı

Başarılı bir yanıt, bir HTTP 200 durum kodu ve üye bilgilerinin listesini döndürür. id, üyenin benzersiz üyelik kimliğidir. Bu yanıttaki grup üyelerinin takip listesi için bir nextPageToken mevcut: 

{
   "kind": "directory#members",
   "members": [
   {
    "kind": "directory#member",
    "id": "group member's unique ID",
    "email": "liz@example.com",
    "role": "MANAGER",
    "type": "GROUP"
   },
   {
    "kind": "directory#member",
    "id": "group member's unique ID",
    "email": "radhe@example.com",
    "role": "MANAGER",
    "type": "MEMBER"
   }
  ],
   "nextPageToken": "NNNNN"
}

Grup üyeliğini silme

Bir üyenin gruptaki üyeliğini silmek için aşağıdaki DELETE isteğini kullanın ve İstekleri yetkilendirme bölümünde açıklanan yetkilendirmeyi dahil edin. groupKey, grubun benzersiz id adresidir. memberKey ise silinen kullanıcı veya grup üyesinin birincil e-posta adresi ya da kullanıcının benzersiz id adresidir. İstek ve yanıt özellikleri için API Referansı'na bakın. 

DELETE https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members/memberKey
Örneğin, bu DELETE isteği, groupKey nnn ve memberKey adresi de kullanıcının birincil e-posta adresi olan liz@example.com olan üyeyi siler: 
DELETE https://admin.googleapis.com/admin/directory/v1/groups/nnnn/members/liz@example.com

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

Bir üye silindiğinde:

  • Kaldırdığınız üyeler artık gruba gönderilen e-postaları alamaz.
  • Gruptan bir üyenin kaldırılması, kullanıcının hesabının silinmesine neden olmaz.
  • Grup sahibini silseniz bile grup normal şekilde çalışmaya devam eder. Yönetici olarak grubu yönetebilir veya grubun sahipliğini başka bir grup üyesine atayabilirsiniz