Method: members.hasMember

הפונקציה בודקת אם המשתמש שצוין הוא חבר בקבוצה. החברות יכולה להיות ישירה או מקננת, אבל אם הן מקוננות, memberKey ו-groupKey חייבים להיות ישויות באותו דומיין, אחרת תוחזר השגיאה Invalid input. כדי לבדוק אם יש חברויות או מינויים בתוך משתמשים שכוללים ישויות מחוץ לדומיין של הקבוצה, אפשר להשתמש ב-method 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 לתגובת Has Member ב-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

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