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 باستخدام "وحدة تحكّم المشرف في Google". يمكن لدور "المدير" تنفيذ جميع الإجراءات التي يمكن لدور "المالك" تنفيذها، باستثناء تحويل عضو إلى "مالك" أو حذف المجموعة. يمكن أن تضم المجموعة عدة أعضاء لديهم أذونات المالك والمدير.
  • 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.

عند حذف أحد الأعضاء:

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