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

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

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

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

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

בקשת 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 מופעל באמצעות מסוף Google Admin. תפקיד של מנהל מאפשר לעשות את כל הפעולות שבעלים יכולים לעשות, חוץ מלהפוך חבר בקבוצה לבעלים או למחוק את הקבוצה. בקבוצה יכולים להיות כמה חברים עם הרשאות OWNER ו-MANAGER.
  • 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. מידע על התפקידים MEMBER,‏ OWNER ו-MANAGER זמין במרכז העזרה בנושא ניהול: 

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.

כשמוחקים חבר/ה:

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