אחזור כל הקבוצות של דומיין או של משתמש לפי userKey (חלוקה לדפים).
בקשת HTTP
GET https://admin.googleapis.com/admin/directory/v1/groups
כתובת ה-URL משתמשת בתחביר של Transcoding של gRPC.
פרמטרים של שאילתה
פרמטרים | |
---|---|
customer |
המזהה הייחודי של חשבון Google Workspace של הלקוח. אם מדובר בחשבון עם כמה דומיינים, כדי לאחזר את כל הקבוצות של לקוח, צריך להשתמש בשדה הזה במקום ב- |
domain |
שם הדומיין. משתמשים בשדה הזה כדי לקבל קבוצות מדומיין אחד בלבד. כדי להציג את כל הדומיינים של חשבון לקוח, צריך להשתמש במקום זאת בפרמטר השאילתה |
maxResults |
מספר התוצאות המקסימלי שיש להחזיר. הערך המקסימלי המותר הוא 200. |
orderBy |
עמודה לשימוש למיון התוצאות |
pageToken |
אסימון לציון הדף הבא ברשימה |
query |
חיפוש באמצעות מחרוזת שאילתה. הפורמט צריך להיות " |
sortOrder |
האם להציג את התוצאות בסדר עולה או יורד. יש צורך בכך רק כשמשתמשים גם ב-orderBy |
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 |
בסדר יורד. |