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 מופעל באמצעות מסוף 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.

כשמחקים חברים:

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