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

חובה. המזהה הייחודי של הלקוח ב-Cloud Identity. מזהה הלקוח הוא מחרוזת אלפאנומרית שמתחילה באות C, לדוגמה, C01234abc. כדי למצוא את מספר הלקוח, אפשר להיעזר במאמר איפה מוצאים את מספר הלקוח.

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

פרמטרים
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

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