यह जांच करता है कि दिया गया उपयोगकर्ता, ग्रुप का सदस्य है या नहीं. पैसे चुकाकर ली जाने वाली सदस्यता, डायरेक्ट या नेस्ट की जा सकती है. हालांकि, अगर नेस्ट की गई है, तो memberKey
और groupKey
एक ही डोमेन की इकाइयां होनी चाहिए. ऐसा न होने पर, Invalid input
गड़बड़ी का मैसेज दिखेगा. नेस्ट की गई सदस्यताओं की जांच करने के लिए, Cloud Identity Groups API में checkTransitiveMembership()
तरीके का इस्तेमाल करें. इन सदस्यताओं में, ग्रुप के डोमेन से बाहर की इकाइयां शामिल होती हैं.
एचटीटीपी अनुरोध
GET https://admin.googleapis.com/admin/directory/v1/groups/{groupKey}/hasMember/{memberKey}
यूआरएल में gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल किया गया है.
पाथ पैरामीटर
पैरामीटर | |
---|---|
groupKey |
एपीआई अनुरोध में ग्रुप की पहचान करता है. वैल्यू के तौर पर, ग्रुप का ईमेल पता, ग्रुप का उपनाम या ग्रुप का यूनीक आईडी दिया जा सकता है. |
memberKey |
एपीआई अनुरोध में, उपयोगकर्ता सदस्य की पहचान करता है. वैल्यू, उपयोगकर्ता का मुख्य ईमेल पता, उपनाम या यूनीक आईडी हो सकता है. |
अनुरोध का मुख्य भाग
अनुरोध का मुख्य हिस्सा खाली होना चाहिए.
जवाब का मुख्य भाग
Directory API में, 'सदस्य है' रिस्पॉन्स के लिए JSON टेंप्लेट.
अगर एपीआई सही से जुड़ जाता है, ताे जवाब के मुख्य भाग में नीचे दिए गए स्ट्रक्चर शामिल होता है.
JSON के काेड में दिखाना |
---|
{ "isMember": boolean } |
फ़ील्ड | |
---|---|
isMember |
सिर्फ़ आउटपुट के लिए. इससे पता चलता है कि कोई उपयोगकर्ता ग्रुप का सदस्य है या नहीं. सदस्यता, डायरेक्ट या नेस्ट की जा सकती है. |
अनुमति के दायरे
इसके लिए, 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
ज़्यादा जानकारी के लिए, अनुमति से जुड़ी गाइड देखें.