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)

רשימה של משאבי RoleAssignment.

nextPageToken

string

היקפי ההרשאות

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

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

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