Directory API: Anggota Grup

Menambahkan anggota ke grup

Untuk menambahkan anggota ke grup, gunakan permintaan POST berikut dan sertakan otorisasi yang dijelaskan dalam Meminta otorisasi. Anggota grup dapat berupa pengguna atau grup lain. groupKey adalah alamat email grup anggota baru atau id unik grup. Untuk properti permintaan dan respons, lihat Referensi API: 

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

Jika Anda menambahkan grup sebagai anggota grup lain, mungkin ada penundaan hingga 10 menit sebelum anggota grup turunan muncul sebagai anggota grup induk. Selain itu, API menampilkan error untuk siklus dalam keanggotaan grup. Misalnya, jika group1 adalah anggota group2, group2 tidak boleh menjadi anggota group1.

Permintaan JSON

Permintaan JSON berikut menunjukkan contoh isi permintaan yang membuat anggota grup. Alamat email anggota adalah liz@example.com dan perannya dalam grup adalah sebagai MEMBER. Permintaan POST menggunakan NNNNN untuk groupKey: 

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

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

role anggota grup dapat berupa:

  • OWNER – Peran ini dapat mengubah pesan yang dikirim ke grup, menambahkan atau menghapus anggota, mengubah peran anggota, mengubah setelan grup, dan menghapus grup. OWNER harus merupakan anggota grup.
  • MANAGER – Peran ini hanya tersedia jika Google Workspace diaktifkan menggunakan konsol Admin. Peran PENGELOLA dapat melakukan semua tindakan yang dilakukan oleh peran PEMILIK, kecuali menjadikan anggota sebagai PEMILIK atau menghapus grup. Grup dapat memiliki beberapa anggota PEMILIK dan PENGELOLA.
  • MEMBER – Peran ini dapat berlangganan grup, melihat arsip diskusi, dan melihat daftar keanggotaan grup. Untuk informasi selengkapnya tentang peran anggota, lihat pusat bantuan administrasi.

Respons JSON

Respons yang berhasil akan menampilkan kode status HTTP 200 dan informasi keanggotaan pelanggan. id adalah ID keanggotaan unik anggota: 

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

type anggota grup dapat berupa:

  • GROUP – Anggota adalah grup lain.
  • MEMBER – Anggota adalah pengguna

Memperbarui keanggotaan grup

Untuk memperbarui keanggotaan grup, gunakan permintaan PUT berikut dan sertakan otorisasi yang dijelaskan dalam Meminta otorisasi. groupKey adalah alamat email grup atau id unik grup, dan memberKey adalah alamat email utama pengguna atau grup, alamat email alias pengguna, atau id unik pengguna. Untuk properti permintaan dan respons, lihat Referensi API: 

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

Permintaan JSON

Permintaan JSON berikut menunjukkan contoh isi permintaan yang memperbarui setelan keanggotaan grup. Alamat email anggota adalah liz@example.com dan peran anggota dalam grup diubah dari MEMBER menjadi MANAGER. groupKey permintaan PUT dalam contoh ini adalah NNNNN. Untuk informasi tentang peran MEMBER, OWNER, dan MANAGER, lihat pusat bantuan administrasi: 

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

Respons JSON

Respons yang berhasil akan menampilkan kode status HTTP 200 dan informasi langganan yang diperbarui. id adalah ID keanggotaan unik anggota: 

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

Mengambil anggota grup

Untuk mengambil keanggotaan grup, gunakan permintaan GET berikut dan sertakan otorisasi yang dijelaskan dalam Permintaan otorisasi. groupKey adalah alamat email grup atau id unik grup, dan memberKey adalah alamat email utama pengguna atau grup, alamat email alias pengguna, atau id unik pengguna. Untuk properti permintaan dan respons, lihat Referensi API: 

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

Respons JSON

Respons yang berhasil akan menampilkan kode status HTTP 200 dan informasi keanggotaan pelanggan. id adalah ID keanggotaan unik anggota: 

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

Mengambil semua anggota grup

Untuk mengambil semua anggota grup, gunakan permintaan GET berikut dan sertakan otorisasi yang dijelaskan dalam Meminta otorisasi. groupKey adalah alamat email grup atau id unik grup. String kueri roles opsional adalah filter yang memungkinkan Anda mengambil anggota grup berdasarkan peran dan koleksi peran yang dihasilkan akan diurutkan sesuai dengan urutan yang diberikan dalam filter roles. Untuk properti permintaan dan respons, lihat Referensi API. Agar mudah dibaca, contoh ini menggunakan pemisahan baris: 

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

Semua anggota ditampilkan dalam urutan abjad alamat email anggota. Dan gunakan string kueri pageToken untuk respons dengan jumlah anggota yang besar. Dalam hal penomoran halaman, respons akan menampilkan properti nextPageToken yang memiliki token untuk halaman hasil respons berikutnya. Permintaan Anda berikutnya akan menggunakan token ini sebagai nilai string kueri pageToken.

Respons JSON

Respons yang berhasil akan menampilkan kode status HTTP 200 dan daftar informasi anggota. id adalah ID keanggotaan unik anggota. Ada nextPageToken untuk daftar lanjutan anggota grup dalam respons ini: 

{
   "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"
}

Menghapus keanggotaan dalam grup

Untuk menghapus keanggotaan anggota dalam grup, gunakan permintaan DELETE berikut dan sertakan otorisasi yang dijelaskan dalam Meminta otorisasi. groupKey adalah id unik grup, dan memberKey adalah alamat email utama pengguna atau anggota grup yang dihapus atau id unik pengguna. Untuk properti permintaan dan respons, lihat Referensi API.: 

DELETE https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members/memberKey
 Misalnya, permintaan DELETE ini akan menghapus anggota yang groupKey-nya adalah nnn dan memberKey-nya adalah alamat email utama pengguna, liz@example.com: 
DELETE https://admin.googleapis.com/admin/directory/v1/groups/nnnn/members/liz@example.com

Respons yang berhasil akan menampilkan kode status HTTP 200.

Jika anggota dihapus:

  • Anggota yang Anda hapus tidak akan lagi menerima email yang dikirim ke grup.
  • Menghapus anggota dari grup tidak akan menghapus akun pengguna.
  • Jika Anda menghapus pemilik grup, grup akan tetap berfungsi seperti biasa. Sebagai administrator, Anda dapat mengelola grup atau menetapkan kepemilikan kepada anggota grup lain