इस पेज का अनुवाद Cloud Translation 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 Workspace को Admin console का इस्तेमाल करके चालू किया गया हो. मैनेजर की भूमिका, मालिक को मालिक बनाने या ग्रुप को मिटाने के अलावा, वह सब कुछ कर सकती है जो मालिक की भूमिका करता है. एक ग्रुप में एक से ज़्यादा OWNER और Manager सदस्य हो सकते हैं.
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 का रिस्पॉन्स

{
   "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 स्टेटस कोड दिखता है.

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

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