Method: roles.list

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

בקשת HTTP

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

כתובת ה-URL משתמשת בתחביר של Transcoding של gRPC.

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

פרמטרים
customer

string

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

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