Directory API: أعضاء المجموعات

إضافة عضو إلى مجموعة

لإضافة عضو إلى مجموعة، استخدِم طلب POST التالي وأدرِج التفويض الموضّح في تفويض الطلبات. يمكن أن يكون عضو المجموعة مستخدمًا أو مجموعة أخرى. groupKey هو عنوان البريد الإلكتروني لمجموعة العضو الجديد أو id الفريد للمجموعة. بالنسبة إلى خصائص الطلب والاستجابة، يُرجى الاطّلاع على مرجع واجهة برمجة التطبيقات: 

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

إذا أضفت مجموعة كعضو في مجموعة أخرى، قد يحدث تأخير لمدة تصل إلى 10 دقائق قبل أن يظهر أعضاء المجموعة الفرعية كأعضاء في المجموعة الرئيسية. بالإضافة إلى ذلك، تعرض واجهة برمجة التطبيقات رسالة خطأ لدورات الانتساب في المجموعة. على سبيل المثال، إذا كانت المجموعة 1 عضوًا في المجموعة 2، لا يمكن أن تكون المجموعة 2 عضوًا فيها.

طلب 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.

عند حذف عضو:

  • لم يعد الأعضاء الذين تزيلهم يتلقى رسائل البريد الإلكتروني الموجهة إلى المجموعة.
  • لا تؤدي إزالة عضو من المجموعة إلى حذف حساب المستخدم.
  • إذا حذفت مالك المجموعة، ستظل المجموعة تعمل بشكل طبيعي. بصفتك مشرفًا، يمكنك إدارة المجموعة أو نقل ملكيتها إلى عضو آخر فيها.