Directory API: أعضاء المجموعة
تنظيم صفحاتك في مجموعات
يمكنك حفظ المحتوى وتصنيفه حسب إعداداتك المفضّلة.
إضافة عضو إلى مجموعة
لإضافة عضو إلى مجموعة، استخدِم طلب POST التالي وأضِف التفويض الموضّح في طلبات التفويض. يمكن أن يكون عضو المجموعة مستخدمًا أو مجموعة أخرى. groupKey هو عنوان البريد الإلكتروني للمجموعة الخاص بالعضو الجديد أو id الفريد للمجموعة. للاطّلاع على سمات الطلب والاستجابة، راجِع مرجع واجهة برمجة التطبيقات:
POST https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members
في حال إضافة مجموعة كعضو في مجموعة أخرى، قد يحدث تأخير يصل إلى 10 دقائق قبل ظهور أعضاء المجموعة الفرعية كأعضاء في المجموعة الرئيسية. بالإضافة إلى ذلك، تعرض واجهة برمجة التطبيقات خطأ في الدورات في عضويات المجموعات. على سبيل المثال، إذا كانت المجموعة 1 عضوًا في المجموعة 2، لا يمكن أن تكون المجموعة 2 عضوًا في المجموعة 1.
طلب JSON
يعرض طلب JSON التالي نموذجًا لنص الطلب الذي ينشئ عضوًا في مجموعة. عنوان البريد الإلكتروني للعضو هو liz@example.com، ودوره في المجموعة هو MEMBER. يستخدم طلب POST القيمة NNNNN للعنصر groupKey:
POST https://admin.googleapis.com/admin/directory/v1/groups/NNNNN/members
{
"email": "liz@example.com",
"role": "MEMBER"
}
يمكن أن يكون role الخاص بأحد أعضاء المجموعة:
OWNER – يمكن لهذا الدور تغيير إرسال الرسائل إلى المجموعة وإضافة أعضاء أو إزالتهم وتغيير أدوار الأعضاء وتغيير إعدادات المجموعة وحذفها. يجب أن يكون OWNER عضوًا في المجموعة.
MANAGER – لا يتوفّر هذا الدور إلا إذا كان Google Workspace مفعّلاً باستخدام "وحدة تحكّم المشرف". يمكن لدور "المدير" تنفيذ كل الإجراءات التي يؤديها دور "المالك" باستثناء تحويل عضو إلى "مالك" أو حذف المجموعة. يمكن أن تتضمّن المجموعة عدة أعضاء بصفتي "مالك" و"مدير".
MEMBER – يمكن لهذا الدور الاشتراك في مجموعة وعرض أرشيفات المناقشات وعرض قائمة أعضاء المجموعة. لمزيد من المعلومات عن أدوار الأعضاء، يُرجى الاطّلاع على مركز مساعدة الإدارة.
استجابة JSON
يعرض الاستجابة الناجحة رمز حالة HTTP 200 ومعلومات اشتراك المشترك. id هو رقم تعريف الاشتراك الفريد للمشترك:
{
"kind": "directory#member",
"id": "group member's unique ID",
"email": "liz@example.com",
"role": "MEMBER",
"type": "GROUP"
}
يمكن أن يكون type الخاص بأحد أعضاء المجموعة:
GROUP – العنصر هو مجموعة أخرى.MEMBER – العضو هو مستخدم
تعديل عضوية في مجموعة
لتعديل عضوية في مجموعة، استخدِم طلب PUT التالي وأضِف التفويض الموضّح في طلبات التفويض. groupKey هو عنوان البريد الإلكتروني للمجموعة أو id الفريد للمجموعة، وmemberKey هو عنوان البريد الإلكتروني الرئيسي للمستخدم أو المجموعة أو عنوان البريد الإلكتروني البديل للمستخدم أو id الفريد للمستخدم. للاطّلاع على سمات الطلب والاستجابة، راجِع مرجع واجهة برمجة التطبيقات:
PUT https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members/memberKey
طلب JSON
يعرض طلب JSON التالي نموذجًا لنص الطلب الذي يعدّل إعدادات عضوية المجموعة. عنوان البريد الإلكتروني للعضو هو liz@example.com وتم تغيير دور العضو في المجموعة من MEMBER إلى MANAGER. قيمة groupKey لطلب PUT في هذا المثال هي NNNNN. للحصول على معلومات عن أدوار "العضو" و"المالك" و"المدير"، يُرجى الاطّلاع على مركز مساعدة الإدارة:
PUT https://admin.googleapis.com/admin/directory/v1/groups/NNNNN/members/liz@example.com
{
"email": "liz@example.com",
"role": "MANAGER"
}
استجابة JSON
يعرض الردّ الناجح رمز حالة HTTP 200 ومعلومات الاشتراك المعدَّلة. id هو رقم تعريف الاشتراك الفريد للمشترك:
{
"kind": "directory#member",
"id": "group member's unique ID",
"email": "liz@example.com",
"role": "MANAGER",
"type": "GROUP"
}
استرداد عضو في مجموعة
لاسترداد عضوية في مجموعة، استخدِم طلب GET التالي وأضِف التفويض الموضّح في طلبات التفويض. groupKey هو عنوان البريد الإلكتروني للمجموعة أو id الفريد للمجموعة، وmemberKey هو عنوان البريد الإلكتروني الرئيسي للمستخدم أو المجموعة أو عنوان البريد الإلكتروني البديل للمستخدم أو id الفريد للمستخدم. للاطّلاع على سمات الطلب والاستجابة، راجِع مرجع واجهة برمجة التطبيقات:
GET https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members/memberKey
استجابة JSON
يعرض الاستجابة الناجحة رمز حالة HTTP 200 ومعلومات اشتراك المشترك. id هو رقم تعريف الاشتراك الفريد للمشترك:
{
"kind": "directory#member",
"id": "group member's unique ID",
"email": "liz@example.com",
"role": "MANAGER",
"type": "GROUP"
}
استرداد جميع أعضاء المجموعة
لاسترداد جميع أعضاء المجموعة، استخدِم طلب GET التالي وأضِف التفويض الموضّح في طلبات التفويض. groupKey هو عنوان البريد الإلكتروني للمجموعة أو id الفريد للمجموعة. سلسلة طلب البحث roles الاختيارية هي فلتر يتيح لك استرداد أعضاء المجموعة حسب الدور، وتكون مجموعات الأدوار الناتجة بالترتيب الوارد في فلتر roles. للاطّلاع على سمات الطلب والاستجابة، راجِع مرجع واجهة برمجة التطبيقات. بغرض سهولة القراءة، يستخدم هذا المثال أحرف الرجوع إلى أول السطر:
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
يتم عرض جميع الأعضاء بالترتيب الأبجدي لعناوين بريدهم الإلكتروني. استخدِم سلسلة طلب البحث pageToken للردود التي تتضمّن عددًا كبيرًا من الأعضاء. في حال استخدام تقسيم الصفحات، يعرض الردّ السمة nextPageToken التي تحتوي على رمز مميّز للصفحة التالية من نتائج الاستجابة. يستخدم طلبك التالي رمز المرور هذا كقيمة سلسلة طلب pageToken.
استجابة JSON
يعرض الاستجابة الناجحة رمز حالة HTTP 200 وقائمة بمعلومات الأعضاء. id هو رقم تعريف الاشتراك الفريد للمشترك. هناك رمز nextPageToken لقائمة متابعة أعضاء المجموعة في هذا الردّ:
{
"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"
}
حذف العضوية في مجموعة
لحذف عضوية أحد الأعضاء في مجموعة، استخدِم طلب DELETE التالي وأضِف التفويض الموضّح في طلبات التفويض. groupKey هو id الفريد للمجموعة، وmemberKey هو عنوان البريد الإلكتروني الأساسي للمستخدم أو العضو في المجموعة الذي تم حذفه أو id الفريد للمستخدم. للاطّلاع على سمات الطلب والاستجابة، راجِع مرجع واجهة برمجة التطبيقات:
DELETE https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members/memberKey
على سبيل المثال، يؤدي طلب DELETE هذا إلى حذف العضو الذي يكون groupKey له هو nnn وmemberKey هو عنوان البريد الإلكتروني الأساسي للمستخدم، liz@example.com:
DELETE https://admin.googleapis.com/admin/directory/v1/groups/nnnn/members/liz@example.com
يعرض الطلب الناجح رمز الحالة HTTP 200.
عند حذف عضو:
- لن يتلقّى الأعضاء الذين تتم إزالتهم بعد ذلك رسائل إلكترونية مُرسَلة إلى المجموعة.
- لا تؤدّي إزالة عضو من مجموعة إلى حذف حساب المستخدم.
- في حال حذف مالك المجموعة، ستظل المجموعة تعمل بشكل طبيعي. بصفتك مشرفًا، يمكنك إدارة المجموعة أو نقل ملكيتها إلى عضو آخر في المجموعة.
إنّ محتوى هذه الصفحة مرخّص بموجب ترخيص Creative Commons Attribution 4.0 ما لم يُنصّ على خلاف ذلك، ونماذج الرموز مرخّصة بموجب ترخيص Apache 2.0. للاطّلاع على التفاصيل، يُرجى مراجعة سياسات موقع Google Developers. إنّ Java هي علامة تجارية مسجَّلة لشركة Oracle و/أو شركائها التابعين.
تاريخ التعديل الأخير: 2025-08-29 (حسب التوقيت العالمي المتفَّق عليه)
[null,null,["تاريخ التعديل الأخير: 2025-08-29 (حسب التوقيت العالمي المتفَّق عليه)"],[],[],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"]]
