Directory API: اعضای گروه

عضوی را به یک گروه اضافه کنید

برای افزودن یک عضو به یک گروه، از درخواست POST زیر استفاده کنید و مجوز شرح داده شده در درخواست‌های مجاز را اضافه کنید. یک عضو گروه می تواند کاربر یا گروه دیگری باشد. groupKey آدرس ایمیل گروه عضو جدید یا id منحصر به فرد گروه است. برای خواص درخواست و پاسخ، به مرجع API مراجعه کنید:

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

اگر گروهی را به عنوان عضوی از گروه دیگری اضافه کنید، ممکن است تا 10 دقیقه تأخیر پیش از ظاهر شدن اعضای گروه فرزند به عنوان اعضای گروه والدین وجود داشته باشد. علاوه بر این، API یک خطا را برای چرخه های عضویت گروه برمی گرداند. برای مثال، اگر گروه 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 با استفاده از کنسول Admin فعال باشد. یک نقش MANAGER می‌تواند همه کارهایی را که توسط یک نقش OWNER انجام می‌شود انجام دهد، به جز اینکه عضوی را به عنوان OWNER یا گروه را حذف کند. یک گروه می تواند چندین عضو OWNER و MANAGER داشته باشد.
  • 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 منحصر به فرد کاربر است. برای خواص درخواست و پاسخ، به مرجع API مراجعه کنید:

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

درخواست JSON

درخواست JSON زیر یک بدنه درخواست نمونه را نشان می دهد که تنظیمات عضویت گروه را به روز می کند. آدرس ایمیل اعضا liz@example.com است و نقش عضو در گروه از یک MEMBER به یک MANAGER تغییر می کند. groupKey درخواست PUT در این مثال NNNNN است. برای اطلاعات در مورد نقش‌های MEMBER، OWNER و MANAGER، به مرکز راهنمایی مدیریت مراجعه کنید: 

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 منحصر به فرد کاربر است. برای خواص درخواست و پاسخ، به مرجع API مراجعه کنید: 

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 ارائه شده است. برای خواص درخواست و پاسخ، به مرجع API مراجعه کنید. برای خوانایی، این مثال از بازگشت خط استفاده می کند:

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 منحصر به فرد کاربر حذف شده است. برای خواص درخواست و پاسخ، به مرجع API مراجعه کنید.:

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 را برمی گرداند.

هنگامی که یک عضو حذف می شود:

  • اعضایی که حذف می‌کنید دیگر ایمیلی به آدرس گروه دریافت نمی‌کنند.
  • حذف یک عضو از یک گروه، حساب کاربر را حذف نمی کند.
  • اگر مالک گروه را حذف کنید، گروه همچنان به طور عادی کار می کند. به عنوان یک سرپرست، می توانید گروه را مدیریت کنید یا مالکیت را به یکی دیگر از اعضای گروه واگذار کنید