Method: roleAssignments.list

אחזור רשימה מעומדת של כל הקצאות התפקידים.

בקשת HTTP

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

בכתובת ה-URL נעשה שימוש בתחביר המרת gRPC.

פרמטרים של נתיב

פרמטרים
customer

string

המזהה הייחודי של חשבון Google Workspace של הלקוח. אם מדובר בחשבון מרובה דומיינים, כדי לאחזר את כל הקבוצות של לקוח מסוים, יש להשתמש בשדה הזה במקום בשדה domain. אפשר גם להשתמש בכינוי my_customer כדי לייצג את customerId של החשבון. הערך customerId גם מוחזר כחלק מהמשאב משתמשים. עליך לספק את הפרמטר 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)

רשימה של מקורות מידע להקצאת תפקידים.
nextPageToken

string

היקפי הרשאות

כדי להשתמש בתכונה הזו יש צורך באחד מההיקפים הבאים של OAuth:

  • https://www.googleapis.com/auth/admin.directory.rolemanagement
  • https://www.googleapis.com/auth/admin.directory.rolemanagement.readonly

למידע נוסף, ניתן לעיין במדריך ההרשאות.