Method: domains.users.list

רשימה של משתמשים שיש להם גישה לדומיין.

בקשת HTTP

GET https://gmailpostmastertools.googleapis.com/v2beta/{parent=domains/*}/users

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

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

פרמטרים
parent

string

חובה. שם משאב האב של המשתמשים שרוצים להציג. פורמט: domains/{domain}

פרמטרים של שאילתה

פרמטרים
pageSize

integer

אופציונלי. גודל הדף המבוקש. יכול להיות שהשרת יחזיר פחות משתמשים מהמספר שצוין בבקשה. אם לא מציינים ערך, ערך ברירת המחדל של השדה הזה הוא 10. הערך המקסימלי בשדה הזה הוא 200.
pageToken

string

אופציונלי. הערך של nextPageToken שמוחזר מבקשת List קודמת, אם יש כזה.

גוף הבקשה

גוף הבקשה צריך להיות ריק.

גוף התשובה

הודעת תגובה ל-users.list.

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:

ייצוג ב-JSON 
{
  "users": [
    {
      object (User)
    }
  ],
  "nextPageToken": string
}
שדות
users[]

object (User)

המשתמשים שיש להם גישה לדומיין.
nextPageToken

string

אסימון לאחזור של דף התוצאות הבא, או ערך ריק אם אין עוד תוצאות ברשימה.

היקפי הרשאות

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

  • https://www.googleapis.com/auth/postmaster
  • https://www.googleapis.com/auth/postmaster.user

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