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

הסוג של משאב ה-API. הערך הוא תמיד 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

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