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.

عند حذف عضو:

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