Directory API: Grup Üyeleri
Koleksiyonlar ile düzeninizi koruyun
İçeriği tercihlerinize göre kaydedin ve kategorilere ayırın.
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.
Aksi belirtilmediği sürece bu sayfanın içeriği Creative Commons Atıf 4.0 Lisansı altında ve kod örnekleri Apache 2.0 Lisansı altında lisanslanmıştır. Ayrıntılı bilgi için Google Developers Site Politikaları'na göz atın. Java, Oracle ve/veya satış ortaklarının tescilli ticari markasıdır.
Son güncelleme tarihi: 2025-08-29 UTC.
[null,null,["Son güncelleme tarihi: 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"]]
