Directory API: ग्रुप के सदस्य

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

किसी सदस्य को ग्रुप में जोड़ने के लिए, यहां दिए गए 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 – यह भूमिका सिर्फ़ तब उपलब्ध होती है, जब Admin console का इस्तेमाल करके Google Workspace चालू किया गया हो. मैनेजर की भूमिका वाले व्यक्ति के पास, ग्रुप के मालिक की भूमिका वाले व्यक्ति के पास मौजूद सभी अधिकार होते हैं. हालांकि, वह किसी सदस्य को ग्रुप का मालिक नहीं बना सकता और न ही ग्रुप को मिटा सकता है. किसी ग्रुप में, एक से ज़्यादा मालिक और मैनेजर हो सकते हैं.
  • 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 फ़िल्टर में दिए गए क्रम में दिखते हैं. हालांकि, 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": "USER"
   },
   {
    "kind": "directory#member",
    "id": "group member's unique ID",
    "email": "radhe@example.com",
    "role": "MANAGER",
    "type": "USER"
   }
  ],
   "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 स्टेटस कोड दिखता है.

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

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