डायरेक्ट्री एपीआई: ग्रुप के सदस्य

ग्रुप में कोई सदस्य जोड़ना

ग्रुप में किसी सदस्य को जोड़ने के लिए, नीचे दिए गए POST अनुरोध का इस्तेमाल करें. साथ ही, अनुरोधों को अनुमति देने के अनुरोध में दी गई अनुमति को शामिल करें. ग्रुप का सदस्य, उपयोगकर्ता या कोई अन्य ग्रुप हो सकता है. groupKey, नए सदस्य के ग्रुप का ईमेल पता या ग्रुप का यूनीक id होता है. अनुरोध और रिस्पॉन्स प्रॉपर्टी के लिए, एपीआई का रेफ़रंस देखें:

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

अगर किसी ग्रुप को दूसरे ग्रुप के सदस्य के तौर पर जोड़ा जाता है, तो चाइल्ड ग्रुप के सदस्यों को पैरंट ग्रुप के सदस्य के तौर पर दिखने में 10 मिनट तक लग सकते हैं. इसके अलावा, एपीआई, ग्रुप की सदस्यताओं में साइकल के लिए गड़बड़ी दिखाता है. उदाहरण के लिए, अगर ग्रुप 1, ग्रुप 2 का सदस्य है, तो ग्रुप 2, ग्रुप 1 का सदस्य नहीं हो सकता.

JSON अनुरोध

नीचे दिया गया JSON अनुरोध, सैंपल अनुरोध का एक मुख्य हिस्सा दिखाता है, जो ग्रुप का सदस्य बनाता है. सदस्य का ईमेल पता liz@example.com है और ग्रुप में सदस्य की भूमिका MEMBER के तौर पर है. POST अनुरोध, groupKey के लिए NNNNN का इस्तेमाल करता है:

POST https://admin.googleapis.com/admin/directory/v1/groups/NNNNN/members
{
   "email": "liz@example.com",
    "role": "MEMBER"
}

ग्रुप के किसी सदस्य के role में ये चीज़ें हो सकती हैं:

  • OWNER – इस भूमिका से ग्रुप में मैसेज भेजने, सदस्यों को जोड़ने या हटाने, सदस्यों की भूमिकाएं बदलने, ग्रुप की सेटिंग बदलने, और ग्रुप को मिटाने में बदलाव हो सकता है. OWNER, ग्रुप का सदस्य होना चाहिए.
  • MANAGER – यह भूमिका सिर्फ़ तब उपलब्ध होती है, जब Google Workspace को Admin console में जाकर चालू किया गया हो. मैनेजर की भूमिका, किसी सदस्य को मालिक बनाने या ग्रुप को मिटाने के अलावा, वह सब कुछ कर सकती है जो मालिक की भूमिका में होता है. एक ग्रुप में मालिक और मैनेजर के एक से ज़्यादा सदस्य हो सकते हैं.
  • MEMBER – यह भूमिका किसी ग्रुप की सदस्यता ले सकती है, चर्चा के संग्रह देख सकती है, और ग्रुप की सदस्यता सूची देख सकती है. सदस्य की भूमिकाओं के बारे में ज़्यादा जानकारी के लिए, एडमिन सहायता केंद्र पर जाएं.

JSON का रिस्पॉन्स

सही जवाब देने पर एचटीटीपी 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 होता है. अनुरोध और रिस्पॉन्स प्रॉपर्टी के लिए, एपीआई का रेफ़रंस देखें:

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

JSON अनुरोध

नीचे दिया गया JSON अनुरोध, सैंपल अनुरोध का एक मुख्य हिस्सा दिखाता है. इससे ग्रुप की सदस्यता की सेटिंग अपडेट होती हैं. सदस्य का ईमेल पता liz@example.com है और ग्रुप में सदस्य की भूमिका को MEMBER से बदलकर MANAGER कर दिया गया है. इस उदाहरण में PUT अनुरोध का groupKey NNNNN है. सदस्य, मालिक, और मैनेजर की भूमिकाओं के बारे में जानकारी पाने के लिए, एडमिन सहायता केंद्र पर जाएं:

PUT https://admin.googleapis.com/admin/directory/v1/groups/NNNNN/members/liz@example.com
{
   "email": "liz@example.com",
    "role": "MANAGER"
}

JSON का रिस्पॉन्स

सही जवाब देने पर एचटीटीपी 200 स्टेटस कोड और सदस्यता की अपडेट की गई जानकारी दिखती है. id, सदस्य के लिए यूनीक सदस्यता आईडी है:

{
   "kind": "directory#member",
   "id": "group member's unique ID",
   "email": "liz@example.com",
   "role": "MANAGER",
   "type": "GROUP"
  }

किसी ग्रुप के सदस्य को वापस लाना

किसी ग्रुप की सदस्यता को फिर से पाने के लिए, नीचे दिए गए GET अनुरोध का इस्तेमाल करें और अनुमति देने के अनुरोध में बताई गई अनुमति को शामिल करें. groupKey, ग्रुप का ईमेल पता या ग्रुप का यूनीक id होता है. साथ ही, memberKey, उपयोगकर्ता या ग्रुप का प्राइमरी ईमेल पता, उपयोगकर्ता का अन्य ईमेल पता या उपयोगकर्ता का यूनीक id होता है. अनुरोध और रिस्पॉन्स प्रॉपर्टी के लिए, एपीआई का रेफ़रंस देखें:

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

JSON का रिस्पॉन्स

सही जवाब देने पर एचटीटीपी 200 स्टेटस कोड और सदस्य की सदस्यता की जानकारी दिखती है. id, सदस्य के लिए यूनीक सदस्यता आईडी है:

{
   "kind": "directory#member",
   "id": "group member's unique ID",
   "email": "liz@example.com",
   "role": "MANAGER",
   "type": "GROUP"
  }

समूह के सभी सदस्यों को फिर से पाएं

ग्रुप के सभी सदस्यों को वापस पाने के लिए, नीचे दिए गए GET अनुरोध का इस्तेमाल करें. साथ ही, अनुरोधों को अनुमति देने के अनुरोध में दी गई अनुमति को शामिल करें. groupKey, ग्रुप का ईमेल पता या ग्रुप का यूनीक id है. roles क्वेरी स्ट्रिंग का इस्तेमाल करना ज़रूरी नहीं है. यह फ़िल्टर की मदद से, ग्रुप के सदस्यों को भूमिका के हिसाब से फिर से हासिल किया जा सकता है. साथ ही, उनसे बनने वाली भूमिकाओं का कलेक्शन, roles फ़िल्टर में दिए गए क्रम में होता है. अनुरोध और रिस्पॉन्स प्रॉपर्टी के लिए, एपीआई का रेफ़रंस देखें. आसानी से समझ में आने के लिए, इस उदाहरण में लाइन रिटर्न का इस्तेमाल किया गया है:

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 का रिस्पॉन्स

सही जवाब देने पर एचटीटीपी 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 है. अनुरोध और रिस्पॉन्स प्रॉपर्टी के लिए, एपीआई का रेफ़रंस देखें.:

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

सही जवाब एचटीटीपी 200 स्टेटस कोड दिखाता है.

किसी सदस्य की जानकारी मिटाए जाने पर:

  • जिन सदस्यों को आप हटाते हैं उन्हें ग्रुप को भेजे गए ईमेल नहीं मिलेंगे.
  • ग्रुप से किसी सदस्य को हटाने पर, उसका खाता नहीं मिटता है.
  • अगर आप ग्रुप के मालिक को मिटा देते हैं, तो भी ग्रुप सामान्य रूप से काम करता रहेगा. एडमिन के तौर पर, आपके पास ग्रुप को मैनेज करने या ग्रुप के किसी दूसरे सदस्य को मालिकाना हक असाइन करने का विकल्प होता है