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": "GROUP"
   },
   {
    "kind": "directory#member",
    "id": "group member's unique ID",
    "email": "radhe@example.com",
    "role": "MANAGER",
    "type": "MEMBER"
   }
  ],
   "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.

عند حذف عضو:

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