Method: roleAssignments.list
קל לארגן דפים בעזרת אוספים
אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.
אחזור רשימה מחולקת לדפים של כל ה-roleAssignments.
בקשת HTTP
GET https://admin.googleapis.com/admin/directory/v1/customer/{customer}/roleassignments
כתובת ה-URL משתמשת בתחביר של Transcoding של gRPC.
פרמטרים של נתיב
| פרמטרים |
customer |
string
המזהה הייחודי של חשבון Google Workspace של הלקוח. בחשבון עם כמה דומיינים, כדי לאחזר את כל הקבוצות של לקוח, משתמשים בשדה הזה במקום ב-domain. אפשר גם להשתמש בכתובת החלופית my_customer כדי לייצג את customerId של החשבון. הערך customerId מוחזר גם כחלק מהמשאב Users. חובה לספק את הפרמטר customer או את הפרמטר domain.
|
פרמטרים של שאילתה
| פרמטרים |
maxResults |
integer
המספר המקסימלי של תוצאות להחזרה.
|
pageToken |
string
אסימון לציון הדף הבא ברשימה.
|
roleId |
string
מזהה קבוע של תפקיד. אם השדה הזה נכלל בבקשה, המערכת מחזירה רק הקצאות תפקידים שמכילות את מזהה התפקיד הזה.
|
userKey |
string
כתובת האימייל הראשית, כתובת האימייל החלופית או מזהה המשתמש או הקבוצה הייחודי. אם הפרמטר הזה נכלל בבקשה, המערכת מחזירה הקצאות תפקידים רק למשתמש או לקבוצה האלה.
|
includeIndirectRoleAssignments |
boolean
כשהערך מוגדר כ-true, מתבצעת אחזור של הקצאות תפקידים עקיפות (כלומר הקצאת תפקיד דרך קבוצה) וגם של הקצאות ישירות. ברירת המחדל היא false. חובה לציין את הערך userKey, אחרת הקצאות התפקידים העקיפות לא ייכללו.
|
גוף הבקשה
גוף הבקשה חייב להיות ריק.
גוף התשובה
אם הפעולה מצליחה, גוף התגובה מכיל נתונים במבנה הבא:
| ייצוג ב-JSON |
{
"kind": string,
"etag": string,
"items": [
{
object (RoleAssignment)
}
],
"nextPageToken": string
} |
| שדות |
kind |
string
הסוג של משאב ה-API. הערך הזה הוא תמיד admin#directory#roleAssignments.
|
etag |
string
ה-ETag של המשאב.
|
items[] |
object (RoleAssignment)
רשימה של משאבי RoleAssignment.
|
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 (שעון UTC).
[null,null,["עדכון אחרון: 2025-07-25 (שעון UTC)."],[],[],null,["# Method: roleAssignments.list\n\nRetrieves a paginated list of all roleAssignments.\n\n### HTTP request\n\n`GET https://admin.googleapis.com/admin/directory/v1/customer/{customer}/roleassignments`\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| `roleId` | `string` Immutable ID of a role. If included in the request, returns only role assignments containing this role ID. |\n| `userKey` | `string` The primary email address, alias email address, or unique user or group ID. If included in the request, returns role assignments only for this user or group. |\n| `includeIndirectRoleAssignments` | `boolean` When set to `true`, fetches indirect role assignments (i.e. role assignment via a group) as well as direct ones. Defaults to `false`. You must specify `userKey` or the indirect role assignments will not be included. |\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/roleAssignments#RoleAssignment) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|------------------------------------------------------------------------------------------------------------------------------------------------|\n| `kind` | `string` The type of the API resource. This is always `admin#directory#roleAssignments`. |\n| `etag` | `string` ETag of the resource. |\n| `items[]` | `object (`[RoleAssignment](/workspace/admin/directory/reference/rest/v1/roleAssignments#RoleAssignment)`)` A list of RoleAssignment 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)."]]
