Directory API: חברי קבוצה

הוספת חבר לקבוצה

כדי להוסיף חבר לקבוצה, צריך להשתמש בבקשת POST הבאה ולכלול את ההרשאה שמתוארת בקטע בקשות הרשאה. חברי קבוצה יכולים להיות משתמשים או קבוצה אחרת. groupKey הוא כתובת האימייל של החבר החדש בקבוצה או הid הייחודי של הקבוצה. למאפיינים של הבקשה והתגובה, עיינו בהפניה ל-API: 

POST https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members

אם מוסיפים קבוצה כחברים בקבוצה אחרת, ייתכן עיכוב של עד 10 דקות לפני שחברי קבוצת הצאצא יופיעו כחברים בקבוצת ההורה. בנוסף, ה-API מחזיר שגיאה למחזורים בחברויות בקבוצות. לדוגמה, אם group1 הוא חבר ב-group2, group2 לא יכולה להיות חברה ב-group1.

בקשת JSON

בבקשת ה-JSON הבאה מוצג גוף בקשה לדוגמה שיוצר חבר בקבוצה. כתובת האימייל של החבר היא liz@example.com והתפקיד של החבר בקבוצה הוא MEMBER. הבקשה של POST משתמשת ב-NNNNN עבור groupKey: 

POST https://admin.googleapis.com/admin/directory/v1/groups/NNNNN/members

{
   "email": "liz@example.com",
    "role": "MEMBER"
}

role של חבר קבוצה יכול להיות:

  • OWNER – משתמשים בתפקיד הזה יכולים לשלוח הודעות לקבוצה, להוסיף או להסיר חברים, לשנות תפקידים של חברים, לשנות את ההגדרות של הקבוצה ולמחוק את הקבוצה. OWNER חייב להיות חבר בקבוצה.
  • MANAGER – התפקיד הזה זמין רק אם האפשרות Google Workspace מופעלת באמצעות מסוף Admin. תפקיד 'מנהל' יכול לבצע כל פעולה שמתבצעת על ידי תפקיד 'בעלים', חוץ מלהגדיר חבר כבעלים או למחוק את הקבוצה. בקבוצה יכולים להיות כמה חברים 'בעלים' ו'מנהל'.
  • MEMBER – תפקיד זה יכול להירשם לקבוצה, להציג ארכיוני דיונים ולהציג את רשימת החברות של הקבוצה. מידע נוסף על התפקידים של חברים זמין במרכז העזרה בנושא ניהול.

תגובת JSON

תשובה מוצלחת תחזיר קוד סטטוס HTTP 200 ואת פרטי החברות של המנוי. id הוא מזהה החברות הייחודי של המנוי: 

{
   "kind": "directory#member",
   "id": "group member's unique ID",
   "email": "liz@example.com",
   "role": "MEMBER",
   "type": "GROUP"
  }

type של חבר קבוצה יכול להיות:

  • GROUP – החבר הוא קבוצה אחרת.
  • MEMBER – החבר הוא משתמש

איך מעדכנים חברי קבוצה

כדי לעדכן חברות בקבוצה, צריך להשתמש בבקשת PUT הבאה ולכלול את ההרשאה שמתוארת בבקשות הרשאה. groupKey הוא כתובת האימייל של הקבוצה או id הייחודי של הקבוצה, וה-memberKey הוא כתובת האימייל הראשית של המשתמש או של הקבוצה, כתובת האימייל החלופית של המשתמש, או ה-id הייחודי של המשתמש. למאפיינים של הבקשה והתגובה, עיינו בהפניה ל-API: 

PUT https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members/memberKey

בקשת JSON

בבקשת ה-JSON הבאה מוצג גוף בקשה לדוגמה שמעדכן את הגדרות החברות בקבוצה. כתובת האימייל של החבר היא liz@example.com והתפקיד של החבר בקבוצה ישתנה מ-MEMBER ל-MANAGER. ה-groupKey של בקשת ה-PUT בדוגמה הזו הוא NNNNN. מידע על התפקידים 'חבר', 'בעלים' ו'מנהל' זמין במרכז העזרה בנושא ניהול: 

PUT https://admin.googleapis.com/admin/directory/v1/groups/NNNNN/members/liz@example.com
 
{
   "email": "liz@example.com",
    "role": "MANAGER"
}

תגובת JSON

תשובה מוצלחת תחזיר קוד סטטוס HTTP 200 ואת פרטי המינוי המעודכנים. id הוא מזהה החברות הייחודי של המנוי: 

{
   "kind": "directory#member",
   "id": "group member's unique ID",
   "email": "liz@example.com",
   "role": "MANAGER",
   "type": "GROUP"
  }

אחזור של חבר קבוצה

כדי לאחזר חברות בקבוצה, צריך להשתמש בבקשת GET הבאה ולכלול את ההרשאה שמתוארת בבקשות הרשאה. groupKey הוא כתובת האימייל של הקבוצה או id הייחודי של הקבוצה, וה-memberKey הוא כתובת האימייל הראשית של המשתמש או של הקבוצה, כתובת האימייל החלופית של המשתמש, או ה-id הייחודי של המשתמש. למאפיינים של הבקשה והתגובה, עיינו בהפניה ל-API: 

GET https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members/memberKey

תגובת JSON

תשובה מוצלחת תחזיר קוד סטטוס HTTP 200 ואת פרטי החברות של המנוי. id הוא מזהה החברות הייחודי של המנוי: 

{
   "kind": "directory#member",
   "id": "group member's unique ID",
   "email": "liz@example.com",
   "role": "MANAGER",
   "type": "GROUP"
  }

אחזור של כל חברי הקבוצה

כדי לאחזר את כל חברי הקבוצה, צריך להשתמש בבקשת GET הבאה ולכלול את ההרשאה שמתוארת בבקשות הרשאה. groupKey הוא כתובת האימייל של הקבוצה או ה-id הייחודי של הקבוצה. מחרוזת השאילתה האופציונלית roles היא מסנן שמאפשר לאחזר את חברי הקבוצה לפי תפקיד, ואוספי התפקידים שייווצרו מופיעים בסדר הנתון במסנן roles. למאפיינים של הבקשה והתגובה, ראו הפניית API. כדי לשפר את הקריאוּת, בדוגמה הזו אנחנו מחזירים שורות: 

GET https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members
?pageToken=pagination token
&roles=one or more of OWNER,MANAGER,MEMBER separated by a comma
&maxResults=maximum results per response page

כל חברי המועדון מוחזרים לפי סדר האלף-בית של חברי המועדון כתובות אימייל. ולהשתמש במחרוזת השאילתה pageToken עבור תשובות עם מספר גדול של משתתפים. במקרה של חלוקה לדפים, התשובה תחזיר את המאפיין nextPageToken, שיש לו אסימון לדף הבא של תוצאות התשובות. הבקשה הבאה שלך תשתמש באסימון הזה בתור ערך מחרוזת השאילתה pageToken.

תגובת JSON

תשובה מוצלחת תחזיר קוד סטטוס HTTP 200 ורשימת פרטי מנויים. id הוא מזהה החברות הייחודי של המנוי. בתשובה הזו יש nextPageToken לרשימת ההמשך של חברי הקבוצה: 

{
   "kind": "directory#members",
   "members": [
   {
    "kind": "directory#member",
    "id": "group member's unique ID",
    "email": "liz@example.com",
    "role": "MANAGER",
    "type": "USER"
   },
   {
    "kind": "directory#member",
    "id": "group member's unique ID",
    "email": "radhe@example.com",
    "role": "MANAGER",
    "type": "USER"
   }
  ],
   "nextPageToken": "NNNNN"
}

מחיקת חברות בקבוצה

כדי למחוק חברות של חבר בקבוצה, צריך להשתמש בבקשת DELETE הבאה ולכלול את ההרשאה שמתוארת בקטע בקשות הרשאה. groupKey הוא הid הייחודי של הקבוצה, ו-memberKey הוא כתובת האימייל הראשית של המשתמש או של החבר בקבוצה שנמחקה או כתובת האימייל הראשית של המשתמש id הייחודי שלו. למאפיינים של הבקשה והתגובה, עיינו בהפניה ל-API. 

DELETE https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members/memberKey
 לדוגמה, בקשת DELETE הזו מוחקת את החבר ש-groupKey שלו הוא nnn וש-memberKey שלו היא כתובת האימייל הראשית של המשתמש, liz@example.com: 
DELETE https://admin.googleapis.com/admin/directory/v1/groups/nnnn/members/liz@example.com

תגובה מוצלחת תחזיר קוד סטטוס HTTP 200.

כשמוחק חבר:

  • חברים שתסירו לא יקבלו יותר אימיילים שממוענים לקבוצה.
  • הסרת חבר מהקבוצה לא גורמת למחיקת החשבון שלו.
  • אם תמחקו את הבעלים של הקבוצה, היא תמשיך לפעול כרגיל. מנהלי מערכת יכולים לנהל את הקבוצה או להעביר את הבעלות עליה לחבר אחר בקבוצה