Method: members.list

یک لیست صفحه بندی شده از همه اعضای یک گروه را بازیابی می کند. این روش پس از 60 دقیقه از بین می رود. برای اطلاعات بیشتر، عیب‌یابی کدهای خطا را ببینید.

درخواست HTTP

GET https://admin.googleapis.com/admin/directory/v1/groups/{groupKey}/members

URL از دستور GRPC Transcoding استفاده می کند.

پارامترهای مسیر

پارامترها
groupKey

string

گروه را در درخواست API شناسایی می کند. این مقدار می تواند آدرس ایمیل گروه، نام مستعار گروه یا شناسه منحصر به فرد گروه باشد.

پارامترهای پرس و جو

پارامترها
includeDerivedMembership

boolean

اینکه آیا عضویت های غیرمستقیم فهرست شود. پیش فرض: نادرست.

maxResults

integer

حداکثر تعداد نتایج برای بازگشت. حداکثر مقدار مجاز 200 است.

pageToken

string

رمزی برای تعیین صفحه بعدی در لیست.

roles

string

پارامتر roles query به شما امکان می دهد اعضای گروه را بر اساس نقش بازیابی کنید. مقادیر مجاز عبارتند از OWNER ، MANAGER و MEMBER .

درخواست بدن

بدنه درخواست باید خالی باشد.

بدن پاسخگو

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:

نمایندگی JSON 
{
  "kind": string,
  "etag": string,
  "members": [
    {
      object (Member)
    }
  ],
  "nextPageToken": string
}
فیلدها
kind

string

نوعی منبع این است.

etag

string

ETag منبع

members[]

object ( Member )

لیستی از اشیاء عضو

nextPageToken

string

رمز برای دسترسی به صفحه بعدی این نتیجه استفاده می شود.

محدوده مجوز

به یکی از حوزه های OAuth زیر نیاز دارد:

  • https://apps-apis.google.com/a/feeds/groups/
  • https://www.googleapis.com/auth/admin.directory.group
  • https://www.googleapis.com/auth/admin.directory.group.member
  • https://www.googleapis.com/auth/admin.directory.group.member.readonly
  • https://www.googleapis.com/auth/admin.directory.group.readonly

برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.