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

لمزيد من المعلومات، يُرجى الاطّلاع على دليل التفويض.