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
لمزيد من المعلومات، يمكنك الاطّلاع على دليل التفويض.
إنّ محتوى هذه الصفحة مرخّص بموجب ترخيص Creative Commons Attribution 4.0 ما لم يُنصّ على خلاف ذلك، ونماذج الرموز مرخّصة بموجب ترخيص Apache 2.0. للاطّلاع على التفاصيل، يُرجى مراجعة سياسات موقع Google Developers. إنّ Java هي علامة تجارية مسجَّلة لشركة Oracle و/أو شركائها التابعين.
تاريخ التعديل الأخير: 2025-07-25 (حسب التوقيت العالمي المتفَّق عليه)
[null,null,["تاريخ التعديل الأخير: 2025-07-25 (حسب التوقيت العالمي المتفَّق عليه)"],[],[],null,["# Method: roles.list\n\nRetrieves a paginated list of all the roles in a domain.\n\n### HTTP request\n\n`GET https://admin.googleapis.com/admin/directory/v1/customer/{customer}/roles`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `customer` | `string` The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](https://developers.google.com/workspace/admin/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter. |\n\n### Query parameters\n\n| Parameters ||\n|--------------|------------------------------------------------------|\n| `maxResults` | `integer` Maximum number of results to return. |\n| `pageToken` | `string` Token to specify the next page in the list. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|--------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"kind\": string, \"etag\": string, \"items\": [ { object (/workspace/admin/directory/reference/rest/v1/roles#Role) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|--------------------------------------------------------------------------------------------------------|\n| `kind` | `string` The type of the API resource. This is always `admin#directory#roles`. |\n| `etag` | `string` ETag of the resource. |\n| `items[]` | `object (`[Role](/workspace/admin/directory/reference/rest/v1/roles#Role)`)` A list of Role resources. |\n| `nextPageToken` | `string` |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/admin.directory.rolemanagement`\n- `\n https://www.googleapis.com/auth/admin.directory.rolemanagement.readonly`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]
