Directory API: Anggota Grup
Tetap teratur dengan koleksi
Simpan dan kategorikan konten berdasarkan preferensi Anda.
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
Kecuali dinyatakan lain, konten di halaman ini dilisensikan berdasarkan Lisensi Creative Commons Attribution 4.0, sedangkan contoh kode dilisensikan berdasarkan Lisensi Apache 2.0. Untuk mengetahui informasi selengkapnya, lihat Kebijakan Situs Google Developers. Java adalah merek dagang terdaftar dari Oracle dan/atau afiliasinya.
Terakhir diperbarui pada 2025-08-29 UTC.
[null,null,["Terakhir diperbarui pada 2025-08-29 UTC."],[],[],null,["# Directory API: Group Members\n\n|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| 1. [Add a member to a group](#create_member) 2. [Update a group membership](#update_member) 3. [Retrieve a group's member](#get_member) 4. [Retrieve all group members](#get_all_members) 5. [Delete membership in a group](#delete_member) |\n\nAdd a member to a group\n-----------------------\n\nTo add a member to a group, use the following `POST` request and include the authorization described in [Authorize requests](/workspace/admin/directory/v1/guides/authorizing). A group member can be a user or another group. The `groupKey` is the new member's group email address or the group's unique `id`. For the request and response properties, see the [API Reference](/workspace/admin/directory/v1/reference/members/insert): \n\n```\nPOST https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members\n```\n\nIf you add a group as a member of another group, there may be a delay of up to 10 minutes before the child group's members appear as members of the parent group. In addtion, the API returns an error for cycles in group memberships. For example, if group1 is a member of group2, group2 cannot be a member of group1.\n\n### JSON request\n\nThe following JSON request shows a sample request body that creates a group member. The member's email address is liz@example.com and the member's role in the group is as a `MEMBER`. The `POST` request uses NNNNN for the `groupKey`: \n\n```\nPOST https://admin.googleapis.com/admin/directory/v1/groups/NNNNN/members\n``` \n\n```transact-sql\n{\n \"email\": \"liz@example.com\",\n \"role\": \"MEMBER\"\n}\n```\n\nA group member's `role` can be:\n\n- `OWNER` -- This role can change send messages to the group, add or remove members, change member roles, change group's settings, and delete the group. An `OWNER` must be a member of the group.\n- `MANAGER` -- This role is only available if the Google Workspace is enabled using the Admin console. A MANAGER role can do everything done by an OWNER role except make a member an OWNER or delete the group. A group can have multiple OWNER and MANAGER members.\n- `MEMBER` -- This role can subscribe to a group, view discussion archives, and view the group's membership list. For more information about member roles, see the [administration help center](http://support.google.com/a/bin/answer.py?answer=167094).\n\n\u003cbr /\u003e\n\n### JSON response\n\nA successful response returns an [HTTP 200 status code](http://wikipedia.org/wiki/List_of_HTTP_status_codes) and the member's membership information. The `id` is the member's unique membership ID: \n\n```carbon\n{\n \"kind\": \"directory#member\",\n \"id\": \"group member's unique ID\",\n \"email\": \"liz@example.com\",\n \"role\": \"MEMBER\",\n \"type\": \"GROUP\"\n }\n```\n\nA group member's `type` can be:\n\n- `GROUP` -- The member is another group.\n- `MEMBER` -- The member is a user\n\n\u003cbr /\u003e\n\nUpdate a group membership\n-------------------------\n\nTo update a group membership, use the following `PUT` request and include the authorization described in [Authorize requests](/workspace/admin/directory/v1/guides/authorizing). The `groupKey` is the group's email address or the group's unique `id`, and the `memberKey` is the user's or group's primary email address, a user's alias email address, or the user's unique `id`. For the request and response properties, see the [API Reference](/workspace/admin/directory/v1/reference/members/update): \n\n```\nPUT https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members/memberKey\n```\n| **Note:** The API also supports the [patch semantics](/workspace/admin/directory/v1/guides/performance#patch).\n\n### JSON request\n\nThe following JSON request shows a sample request body that updates a group membership settings. The member's email address is liz@example.com and the member's role in the group is changed from a `MEMBER` to a `MANAGER`. The `PUT` request's `groupKey` in this example is NNNNN. For information about the MEMBER, OWNER and MANAGER roles, see the [administration help center](http://support.google.com/a/bin/answer.py?answer=167094): \n\n```\nPUT https://admin.googleapis.com/admin/directory/v1/groups/NNNNN/members/liz@example.com\n``` \n\n```transact-sql\n{\n \"email\": \"liz@example.com\",\n \"role\": \"MANAGER\"\n}\n```\n\n### JSON response\n\nA successful response returns an [HTTP 200 status code](http://wikipedia.org/wiki/List_of_HTTP_status_codes) and the updated membership information. The `id` is the member's unique membership ID: \n\n```carbon\n{\n \"kind\": \"directory#member\",\n \"id\": \"group member's unique ID\",\n \"email\": \"liz@example.com\",\n \"role\": \"MANAGER\",\n \"type\": \"GROUP\"\n }\n```\n\nRetrieve a group's member\n-------------------------\n\nTo retrieve a group membership, use the following `GET` request and include the authorization described in [Authorize requests](/workspace/admin/directory/v1/guides/authorizing). The `groupKey` is the group's email address or the group's unique `id`, and the `memberKey` is the user's or group's primary email address, a user's alias email address, or the user's unique `id`. For the request and response properties, see the [API Reference](/workspace/admin/directory/v1/reference/members/get): \n\n```\nGET https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members/memberKey\n```\n\n### JSON response\n\nA successful response returns an [HTTP 200 status code](http://wikipedia.org/wiki/List_of_HTTP_status_codes) and the member's membership information. The `id` is the member's unique membership ID: \n\n```carbon\n{\n \"kind\": \"directory#member\",\n \"id\": \"group member's unique ID\",\n \"email\": \"liz@example.com\",\n \"role\": \"MANAGER\",\n \"type\": \"GROUP\"\n }\n```\n\nRetrieve all group members\n--------------------------\n\nTo retrieve all group members, use the following `GET` request and include the authorization described in [Authorize requests](/workspace/admin/directory/v1/guides/authorizing). The `groupKey` is the group's email address or the group's unique `id`. The optional `roles` query string is a filter allowing you to retrieve group members by role and the resulting role collections are in the order given in the `roles` filter. For the request and response properties, see the [API Reference](/workspace/admin/directory/v1/reference/members/list). For readability, this example uses line returns: \n\n```\nGET https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members\n?pageToken=pagination token\n&roles=one or more of OWNER,MANAGER,MEMBER separated by a comma\n&maxResults=maximum results per response page\n```\n\nAll members are returned in the alphabetical order of the members' email addresses. And use the `pageToken` query string for responses with large number of members. In the case of pagination, the response returns the `nextPageToken` property which has a token for the next page of response results. Your next request uses this token as the `pageToken` query string value.\n\n### JSON response\n\nA successful response returns an [HTTP 200 status code](http://wikipedia.org/wiki/List_of_HTTP_status_codes) and the list of member information. The `id` is the member's unique membership ID. There is a `nextPageToken` for the follow-on list of group members in this response: \n\n```carbon\n{\n \"kind\": \"directory#members\",\n \"members\": [\n {\n \"kind\": \"directory#member\",\n \"id\": \"group member's unique ID\",\n \"email\": \"liz@example.com\",\n \"role\": \"MANAGER\",\n \"type\": \"USER\"\n },\n {\n \"kind\": \"directory#member\",\n \"id\": \"group member's unique ID\",\n \"email\": \"radhe@example.com\",\n \"role\": \"MANAGER\",\n \"type\": \"USER\"\n }\n ],\n \"nextPageToken\": \"NNNNN\"\n}\n```\n\nDelete membership in a group\n----------------------------\n\nTo delete a member's membership in a group, use the following `DELETE` request and include the authorization described in [Authorize requests](/workspace/admin/directory/v1/guides/authorizing). The `groupKey` is the group's unique `id`, and `memberKey` is the deleted user or group member's primary email address or the user's unique `id`. For the request and response properties, see the [API Reference](/workspace/admin/directory/v1/reference/members/delete).: \n\n```\nDELETE https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members/memberKey\n```\nFor example, this `DELETE` request deletes the member whose `groupKey` is nnn and whose `memberKey` is the user's primary email address, liz@example.com: \n\n```\nDELETE https://admin.googleapis.com/admin/directory/v1/groups/nnnn/members/liz@example.com\n```\n\nA successful response returns an [HTTP 200 status code](http://wikipedia.org/wiki/List_of_HTTP_status_codes).\n\nWhen a member is deleted:\n\n- Members you remove no longer receive email addressed to the group.\n- Removing a member from a group does not delete the user's account.\n- If you delete the group owner, the group still works normally. As an administrator, you can manage the group or assign ownership to another group member\n\n\u003cbr /\u003e"]]
