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 üyesi, bir kullanıcı veya başka bir grup olabilir. groupKey, yeni üyenin grup e-posta adresi veya grubun benzersiz id'sidir. İ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 dakikaya kadar sürebilir. Ayrıca API, grup üyeliklerindeki döngüler için 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 ve gruptaki rolü MEMBER. POST isteğinde groupKey için NNNNN kullanılıyor: 

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

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

Grup üyelerinin role şu şekilde olabilir:

  • OWNER: Bu rol, gruba ileti gönderebilir, üye ekleyip kaldırabilir, üyelerin 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, Google 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 her şeyi yapabilir. Bir grubun 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önetim 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 şu şekilde olabilir:

  • GROUP: Üye başka bir gruptur.
  • MEMBER: Üye, 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 ekleyin. groupKey, grubun e-posta adresi veya grubun benzersiz id, memberKey ise kullanıcının ya da grubun birincil e-posta adresi, kullanıcının takma ad e-posta adresi veya kullanıcının benzersiz id'sidir. İ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 ve gruptaki rolü MEMBER olarak değiştirildi.MANAGER Bu örnekte PUT isteğinin groupKey değeri NNNNN'dir. 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üncellenen ü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"
  }

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, memberKey ise kullanıcının ya da grubun birincil e-posta adresi, kullanıcının takma ad e-posta adresi veya kullanıcının benzersiz id'sidir. İ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 dahil edin. groupKey, grubun e-posta adresi veya grubun benzersiz id'sidir. İsteğe bağlı roles sorgu dizesi, grup üyelerini role göre almanıza olanak tanıyan bir filtredir ve sonuçtaki rol koleksiyonları, roles filtresinde verilen sıradadır. İstek ve yanıt özellikleri için API Referansı'na bakın. Okunabilirliği artırmak açısından 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 üyesi olan yanıtlar için pageToken sorgu dizesini kullanın. Sayfalama durumunda yanıt, yanıt sonuçlarının sonraki sayfası için bir jeton içeren nextPageToken özelliğini döndürür. Bir 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ıttaki grup üyelerinin takip listesi için 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 gruptaki ü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, memberKey ise silinen kullanıcının veya grup üyesinin birincil e-posta adresi ya da kullanıcının benzersiz id'sidir. İ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 olan 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ıt HTTP 200 durum kodu döndürü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.