Method: roles.list

لاسترداد قائمة مقسّمة على صفحات لجميع الأدوار في نطاق.

طلب HTTP

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

يستخدِم عنوان URL بنية تحويل ترميز gRPC.

مَعلمات المسار

المَعلمات
customer

string

المعرّف الفريد لحساب العميل على Google Workspace في حال كان الحساب متعدّد النطاقات، استخدِم هذا الحقل بدلاً من domain لجلب جميع المجموعات لعميل. يمكنك أيضًا استخدام العنوان البديل للبريد الإلكتروني my_customer لتمثيل customerId في حسابك. يتم أيضًا عرض customerId كجزء من مورد Users. يجب تقديم المعلَمة customer أو domain.

معلمات طلب البحث

المَعلمات
maxResults

integer

الحد الأقصى لعدد النتائج المطلوب عرضها.
pageToken

string

رمز مميز لتحديد الصفحة التالية في القائمة

نص الطلب

يجب أن يكون نص الطلب فارغًا.

نص الاستجابة

إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:

تمثيل JSON 
{
  "kind": string,
  "etag": string,
  "items": [
    {
      object (Role)
    }
  ],
  "nextPageToken": string
}
الحقول
kind

string

نوع مورد واجهة برمجة التطبيقات. دائمًا ما تكون 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

لمزيد من المعلومات، راجِع دليل التفويض.