किसी डोमेन के या किसी userKey (पेज पर नंबर) वाले उपयोगकर्ता के सभी समूहों को वापस लाता है.
एचटीटीपी अनुरोध
GET https://admin.googleapis.com/admin/directory/v1/groups
यह यूआरएल gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल करता है.
क्वेरी पैरामीटर
पैरामीटर | |
---|---|
customer |
ग्राहक के Google Workspace खाते का यूनीक आईडी. एक से ज़्यादा डोमेन वाले खाते के मामले में, किसी ग्राहक के सभी ग्रुप को फ़ेच करने के लिए, |
domain |
डोमेन नेम. सिर्फ़ एक डोमेन से ग्रुप पाने के लिए इस फ़ील्ड का इस्तेमाल करें. किसी ग्राहक खाते के सभी डोमेन दिखाने के लिए, |
maxResults |
दिए जाने वाले नतीजों की ज़्यादा से ज़्यादा संख्या. ज़्यादा से ज़्यादा 200 की वैल्यू दी जा सकती है. |
orderBy |
नतीजों को क्रम से लगाने के लिए कॉलम |
pageToken |
सूची में अगले पेज को बताने के लिए टोकन |
query |
क्वेरी स्ट्रिंग खोज. " |
sortOrder |
नतीजों को बढ़ते क्रम में देना है या घटते क्रम में. सिर्फ़ तब इस्तेमाल करें, जब OrderBy का इस्तेमाल किया गया हो |
userKey |
उपयोगकर्ता का ईमेल या नहीं बदला जा सकने वाला आईडी. अगर सूची में सिर्फ़ इन ग्रुप को शामिल करना है, तो उपयोगकर्ता उस ग्रुप का सदस्य होगा. अगर यह एक आईडी है, तो यह उपयोगकर्ता ऑब्जेक्ट के आईडी से मेल खाना चाहिए. |
अनुरोध का मुख्य भाग
अनुरोध का मुख्य हिस्सा खाली होना चाहिए.
जवाब का मुख्य भाग
अगर एपीआई सही से जुड़ जाता है, ताे जवाब के मुख्य भाग में नीचे दिए गए स्ट्रक्चर शामिल होता है.
JSON के काेड में दिखाना |
---|
{
"kind": string,
"etag": string,
"groups": [
{
object ( |
फ़ील्ड | |
---|---|
kind |
यह एक तरह का संसाधन है. |
etag |
संसाधन का ETag. |
groups[] |
ग्रुप ऑब्जेक्ट की सूची. |
nextPageToken |
इस नतीजे के अगले पेज को ऐक्सेस करने के लिए टोकन का इस्तेमाल किया जाता है. |
अनुमति के दायरे
इनमें से किसी एक 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.readonly
ज़्यादा जानकारी के लिए, अनुमति देने से जुड़ी गाइड देखें.
इससे ऑर्डर करें
Enums | |
---|---|
EMAIL |
ग्रुप का ईमेल. |
SortOrder
Enums | |
---|---|
ASCENDING |
आरोही क्रम. |
DESCENDING |
अवरोही क्रम. |