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

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

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

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

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

בקשת JSON

בבקשת ה-JSON הבאה מוצג גוף בקשה לדוגמה שיוצר חבר קבוצה. כתובת האימייל של החברה היא dana@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 הבאה מוצג גוף בקשה לדוגמה שמעדכן הגדרות של חברות בקבוצה. כתובת האימייל של החברה היא dana@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": "GROUP"
   },
   {
    "kind": "directory#member",
    "id": "group member's unique ID",
    "email": "radhe@example.com",
    "role": "MANAGER",
    "type": "MEMBER"
   }
  ],
   "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.

כשחבר נמחק:

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