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

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

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

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

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

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

अनुरोध पूरा होने पर, HTTP 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 का रिस्पॉन्स

अनुरोध पूरा होने पर, HTTP 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

अनुरोध पूरा होने पर, HTTP 200 स्टेटस कोड मिलता है.

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

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