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 de grup1'in üyesi olamaz.

JSON isteği

Aşağıdaki JSON isteği, grup üyesi oluşturan örnek bir istek gövdesini gösterir. Üyenin e-posta adresi lez@example.com ve üyenin gruptaki rolü MEMBER rolüne sahip. POST isteği, groupKey için NNNNN 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 şunlardan biri olabilir:

  • OWNER - Bu rol, gruba ileti gönderme, üye ekleyip kaldırma, üye rollerini değiştirme, grubun ayarlarını değiştirme 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 dışında SAHİP rolü tarafından yapılan tüm işlemleri yapabilir. Bir grubun birden fazla OWNER ve MANAGER ü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 edinmek için yönetim yardım merkezine göz atın.

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 şunlardan biri 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 başlıklı makalede 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 veya kullanıcının 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ği, grup üyeliği ayarlarını güncelleyen örnek bir istek gövdesini gösterir. Üyenin e-posta adresi lez@example.com ve üyenin gruptaki rolü MEMBER iken MANAGER olarak değiştirildi. Bu örnekte PUT isteğinin groupKey değeri NNNNN'dir. ÜYE, SAHİP ve YÖNETİCİ 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ı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"
  }

Grup üyesini alma

Grup üyeliği almak için aşağıdaki GET isteğini kullanın ve İstekleri yetkilendirme başlıklı makalede açıklanan yetkilendirmeyi ekleyin. 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 veya kullanıcının 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 geri 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 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. Bu örnekte okunabilirlik için satır sonları 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 alfabetik sırasına sokularak döndürülür. e-posta adresleri Ayrıca çok sayıda üye içeren yanıtlar için pageToken sorgu dizesini kullanın. Sayfalara ayırma durumunda yanıt, bir sonraki yanıt sonuçları sayfası için jetonu olan nextPageToken özelliğini döndürür. Bir sonraki isteğiniz, bu jetonu pageToken sorgu dizesi değeri olarak 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 edilen listesi için bir nextPageToken var: 

{
   "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 bir 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 değeridir. 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 adlı kullanıcının nnn ve memberKey'i kullanıcının birincil e-posta adresi olan liz@example.com adlı ü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 artık gruba gönderilen e-postaları almaz.
  • Gruptan bir üye kaldırıldığında kullanıcının hesabı silinmez.
  • 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