מאחזר את כל הקבוצות של דומיין או של משתמש עם מפתח userKey (חלוקה לדפים).
בקשת HTTP
GET https://admin.googleapis.com/admin/directory/v1/groups
בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.
פרמטרים של שאילתה
פרמטרים | |
---|---|
customer |
המזהה הייחודי של חשבון Google Workspace של הלקוח. אם מדובר בחשבון עם כמה דומיינים, כדי לאחזר את כל הקבוצות של לקוח, צריך להשתמש בשדה הזה במקום ב- |
domain |
שם הדומיין. צריך להשתמש בשדה הזה כדי לקבל קבוצות מדומיין אחד בלבד. כדי להחזיר את כל הדומיינים של חשבון לקוח, צריך להשתמש בפרמטר |
maxResults |
מספר התוצאות המקסימלי שיש להחזיר. הערך המקסימלי המותר הוא 200. |
orderBy |
עמודה לשימוש למיון התוצאות |
pageToken |
אסימון לציון הדף הבא ברשימה |
query |
חיפוש מחרוזות שאילתה. הפורמט צריך להיות " |
sortOrder |
האם להחזיר תוצאות בסדר עולה או יורד. לשימוש רק כשנעשה שימוש גם באפשרות 'סידור לפי' |
userKey |
כתובת האימייל או מזהה שלא ניתן לשינוי של המשתמש, אם רק הקבוצות האלה מופיעות ברשימה, המשתמש הנתון חבר בהן. אם מדובר במזהה, הוא צריך להתאים למזהה של אובייקט המשתמש. |
גוף הבקשה
גוף הבקשה חייב להיות ריק.
גוף התשובה
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:
ייצוג JSON |
---|
{
"kind": string,
"etag": string,
"groups": [
{
object ( |
שדות | |
---|---|
kind |
זה סוג המשאב. |
etag |
ה-ETag של המשאב. |
groups[] |
רשימה של אובייקטים קבוצתיים. |
nextPageToken |
האסימון שמשמש לגישה לדף הבא בתוצאה הזו. |
היקפי ההרשאות
נדרש אחד מהיקפי ההרשאות הבאים של OAuth:
https://apps-apis.google.com/a/feeds/groups/
https://www.googleapis.com/auth/admin.directory.group
https://www.googleapis.com/auth/admin.directory.group.readonly
מידע נוסף זמין במדריך להרשאות.
OrderBy
טיפוסים בני מנייה (enum) | |
---|---|
EMAIL |
כתובת האימייל של הקבוצה. |
SortOrder
טיפוסים בני מנייה (enum) | |
---|---|
ASCENDING |
סדר עולה. |
DESCENDING |
סדר יורד. |