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 – این نقش فقط در صورتی در دسترس است که فضای کاری گوگل با استفاده از کنسول مدیریت گوگل فعال شده باشد. یک نقش مدیر می‌تواند همه کارهایی را که توسط یک نقش مالک انجام می‌شود، انجام دهد، به جز اینکه یک عضو را مالک کند یا گروه را حذف کند. یک گروه می‌تواند چندین عضو مالک و مدیر داشته باشد.
  • 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 زیر استفاده کنید و مجوز شرح داده شده در درخواست‌های Authorize را نیز در آن بگنجانید. 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 را برمی‌گرداند.

وقتی عضوی حذف می‌شود:

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