Method: members.hasMember

הפונקציה בודקת אם המשתמש הנתון חבר בקבוצה. החברות יכולה להיות ישירה או בתצוגת עץ, אבל אם היא מקוננת, הערכים memberKey ו-groupKey חייבים להיות ישויות באותו דומיין או שתוחזר השגיאה Invalid input. כדי לבדוק אם יש חברויות בתוך הארגון שכוללות ישויות מחוץ לדומיין של הקבוצה, משתמשים בשיטה checkTransitiveMembership() ב-Cloud Identity Groups API.

בקשת HTTP

GET https://admin.googleapis.com/admin/directory/v1/groups/{groupKey}/hasMember/{memberKey}

בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.

פרמטרים של נתיב

פרמטרים
groupKey

string

מזהה את הקבוצה בבקשת ה-API. הערך יכול להיות כתובת האימייל של הקבוצה, כתובת האימייל החלופית של הקבוצה או המזהה הייחודי של הקבוצה.
memberKey

string

מזהה את החבר בבקשת ה-API. הערך יכול להיות כתובת האימייל הראשית, כתובת האימייל החלופית או המזהה הייחודי של המשתמש.

גוף הבקשה

גוף הבקשה חייב להיות ריק.

גוף התשובה

תבנית JSON של תגובת חבר ב-Directory API.

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:

ייצוג JSON 
{
  "isMember": boolean
}
שדות
isMember

boolean

פלט בלבד. מציינת אם המשתמש הנתון חבר בקבוצה. החברות יכולה להיות ישירה או מקוננת.

היקפי ההרשאות

נדרש אחד מהיקפי ההרשאות הבאים של 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.member
  • https://www.googleapis.com/auth/admin.directory.group.member.readonly
  • https://www.googleapis.com/auth/admin.directory.group.readonly

מידע נוסף זמין במדריך להרשאות.