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 كجزء من مورد المستخدِمون. يجب تقديم المَعلمة 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

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