Method: customers.v2.Groups.list

מאחזר רשימה של קבוצות.

  • בבקשות צריך לציין מסנן. בקשות ללא פרמטר filter מחזירות שגיאה tooMany.
  • הפרמטר filter תומך רק בשוויון ב-displayName (לדוגמה, displayName eq "Group Name") או ב-externalId (לדוגמה, externalId eq "ddaafa46e2b6").
  • לא ניתן להשתמש בהתאמות של מחרוזות משנה (co,‏ sw,‏ ew), באופרטורים לוגיים (and,‏ or) ובמסנני ערכים מורכבים.
  • אין תמיכה בהחלפה בין דפים. אם יש יותר מ-50 התאמות לקבוצה, רק 50 התוצאות הראשונות יוחזרו.

בקשת HTTP

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

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

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

פרמטרים
customerId

string

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

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

פרמטרים
filter

string

פרמטר המסנן.

גוף הבקשה

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

גוף התשובה

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

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

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

string

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

object (Group)

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

integer

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

היקפי הרשאות

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

  • https://www.googleapis.com/auth/cloud-identity.groups.readonly
  • https://www.googleapis.com/auth/cloud-identity.groups
  • https://www.googleapis.com/auth/cloud-identity
  • https://www.googleapis.com/auth/cloud-platform

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