Method: roles.list

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

درخواست HTTP

GET https://admin.googleapis.com/admin/directory/v1/customer/{customer}/roles

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

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

پارامترها
customer

string

شناسه منحصر به فرد برای حساب Google Workspace مشتری. در مورد حساب چند دامنه ای، برای واکشی همه گروه ها برای مشتری، به جای domain از این فیلد استفاده کنید. همچنین می توانید از نام مستعار my_customer برای نشان دادن customerId حساب خود استفاده کنید. customerId نیز به عنوان بخشی از منبع کاربران بازگردانده می شود. شما باید یا customer یا پارامتر domain را ارائه دهید.

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

پارامترها
maxResults

integer

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

pageToken

string

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

درخواست بدن

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

بدن پاسخگو

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

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

string

نوع منبع API. این همیشه admin#directory#roles است.

etag

string

ETag منبع

items[]

object ( Role )

فهرستی از منابع نقش

nextPageToken

string

محدوده مجوز

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

  • https://www.googleapis.com/auth/admin.directory.rolemanagement
  • https://www.googleapis.com/auth/admin.directory.rolemanagement.readonly

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