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 ekleyin. Grup üyeleri kullanıcı veya başka bir grup olabilir. groupKey, yeni üyenin grup e-posta adresi veya grubun benzersiz id değeridir. İ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 hata döndürür. Örneğin, group1 grubu group2 grubunun üyesiyse group2 grubu group1 grubunun üyesi olamaz.

JSON isteği

Aşağıdaki JSON isteği, bir grup üyesi oluşturan örnek bir istek gövdesini göstermektedir. Üyenin e-posta adresi liz@example.com ve gruptaki rolü MEMBER. POST isteği, groupKey için NNNNN değerini kullanıyor: 

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

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

Grup üyelerinin role değeri şunlar olabilir:

  • OWNER: Bu rol, gruba mesaj gönderebilir, üye ekleyip kaldırabilir, üye rollerini değiştirebilir, grubun ayarlarını değiştirebilir ve grubu silebilir. 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 dışında SAHİP rolünün yapabileceği tüm işlemleri yapabilir. Bir grupta birden fazla SAHİP ve YÖNETİCİ üyesi olabilir.
  • MEMBER: Bu rol, bir gruba abone olabilir, tartışma arşivlerini ve grubun üyelik listesini görüntüleyebilir. Üye rolleri hakkında daha fazla bilgi için yönetici yardım merkezine göz atın.

JSON yanıtı

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

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

Grup üyelerinin type değeri şunlar olabilir:

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

Grup üyeliğini güncelleme

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 ekleyin. groupKey, grubun e-posta adresi veya grubun benzersiz id değeridir. memberKey ise kullanıcının veya grubun birincil e-posta adresi, kullanıcının takma ad e-posta adresi ya da kullanıcının benzersiz id değeridir. İ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ği, bir grup üyeliği ayarını güncelleyen örnek bir istek gövdesini göstermektedir. Üyenin e-posta adresi liz@example.com ve gruptaki rolü MEMBER yerine MANAGER olarak değiştirilir. Bu örnekte PUT isteğinin groupKey değeri NNNNN'dır. MEMBER, OWNER ve MANAGER rolleri hakkında bilgi edinmek için yönetim yardım merkezine göz atı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ıtta HTTP 200 durum kodu ve güncellenmiş üyelik bilgileri döndürülür. id, üyenin benzersiz üyelik kimliğidir: 

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

Grup üyelerini alma

Grup üyeliğini almak için aşağıdaki GET isteğini kullanın ve İstekleri yetkilendirme bölümünde açıklanan yetkilendirmeyi ekleyin. groupKey, grubun e-posta adresi veya grubun benzersiz id değeridir. memberKey ise kullanıcının veya grubun birincil e-posta adresi, kullanıcının takma ad e-posta adresi ya da kullanıcının benzersiz id değeridir. İ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ıtta HTTP 200 durum kodu ve üyenin üyelik bilgileri döndürülü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 alma

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 ekleyin. groupKey, grubun e-posta adresi veya grubun benzersiz id değeridir. İsteğe bağlı roles sorgu dizesi, grup üyelerini role göre almanıza olanak tanıyan bir filtredir ve elde edilen rol koleksiyonları, roles filtresinde belirtilen sıradadır. İstek ve yanıt özellikleri için API Referansı'na bakın. Okunabilirliği artırmak için bu örnekte satır sonları kullanılmıştı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, e-posta adreslerinin alfabetik sırasına göre döndürülür. Ayrıca, çok sayıda üye içeren yanıtlar için pageToken sorgu dizesini kullanın. Sayfalandırma durumunda yanıt, yanıt sonuçlarının bir sonraki sayfası için jeton içeren nextPageToken mülkünü döndürür. Sonraki isteğinizde bu jeton, pageToken sorgu dizesi değeri olarak kullanılır.

JSON yanıtı

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

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

Grup üyeliğini silme

Bir üyenin grup üyeliğini silmek için aşağıdaki DELETE isteğini kullanın ve İstekleri yetkilendirme bölümünde açıklanan yetkilendirmeyi ekleyin. groupKey, grubun benzersiz id değeridir. memberKey ise silinen kullanıcının veya grup üyesinin birincil e-posta adresi ya da benzersiz id değeridir. İ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 değeri nnn ve memberKey değeri 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ıtta HTTP 200 durum kodu döndürülür.

Bir üye silindiğinde:

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