Method: customers.v2.Users.list

מאחזר רשימה של משתמשים.

  • בבקשות צריך לציין מסנן. בקשות ללא פרמטר filter מחזירות שגיאה tooMany.
  • הפרמטר filter תומך רק בשוויון ב-userName (לדוגמה, userName eq "user@domain.com").
  • לא ניתן להשתמש בהתאמות של מחרוזות משנה (co,‏ sw,‏ ew), באופרטורים לוגיים (and,‏ or) ובמסנני ערכים מורכבים.
  • אין תמיכה בהחלפה בין דפים.

בקשת HTTP

GET https://cloudidentityscim.googleapis.com/v1beta1/customers/{customerId}/v2/Users

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

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

פרמטרים
customerId

string

חובה. מספר הלקוח.

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

פרמטרים
filter

string

פרמטר המסנן. בשלב הזה יש תמיכה רק בשוויון ב-userName.

גוף הבקשה

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

גוף התשובה

הודעת תגובה ממשתמשי כרטיס המוצר.

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

ייצוג JSON 
{
  "schemas": [
    string
  ],
  "resources": [
    {
      object (User)
    }
  ],
  "totalResults": integer
}
שדות
schemas[]

string

הסכימות של המשאבים שמוחזרים.
resources[]

object (User)

רשימת המשאבים המבוקשים.
totalResults

integer

המספר הכולל של התוצאות.

היקפי הרשאות

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

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

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