Method: users.list

यह या तो मिटाए गए उपयोगकर्ताओं की सूची या डोमेन के सभी उपयोगकर्ताओं की जानकारी हासिल करता है.

एचटीटीपी अनुरोध

GET https://admin.googleapis.com/admin/directory/v1/users

यूआरएल, gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल करता है.

क्वेरी पैरामीटर

पैरामीटर में
customFieldMask	string स्कीमा के नामों की कॉमा-सेपरेटेड लिस्ट. इन स्कीमा के सभी फ़ील्ड फ़ेच किए जाते हैं. इसे projection=custom सेट करते समय ही सेट किया जाना चाहिए.
customer	string ग्राहक के Google Workspace खाते का यूनीक आईडी. अगर किसी ग्राहक के लिए सभी ग्रुप की जानकारी पाने के लिए, एक से ज़्यादा डोमेन वाले खाते का इस्तेमाल करना है, तो domain के बजाय इस फ़ील्ड का इस्तेमाल करें. अपने खाते की customerId को दिखाने के लिए, my_customer के उपनाम का भी इस्तेमाल किया जा सकता है. customerId को उपयोगकर्ता संसाधन के हिस्से के तौर पर भी दिखाया जाता है. आपको customer या domain पैरामीटर में से किसी एक की जानकारी देनी होगी.
domain	string डोमेन नेम. सिर्फ़ एक डोमेन के ग्रुप पाने के लिए, इस फ़ील्ड का इस्तेमाल करें. किसी ग्राहक खाते के सभी डोमेन लौटाने के लिए, इसके बजाय customer क्वेरी पैरामीटर का इस्तेमाल करें. customer या domain पैरामीटर में से कोई एक दिया जाना चाहिए.
event	enum (Event) किस इवेंट के लिए सदस्यता लेनी है (अगर सदस्यता ली जा रही है)
maxResults	integer लौटाने के लिए नतीजों की ज़्यादा से ज़्यादा संख्या.
orderBy	enum (OrderBy) नतीजों को क्रम से लगाने के लिए, इस्तेमाल की जाने वाली प्रॉपर्टी.
pageToken	string सूची में अगले पेज के बारे में बताने के लिए टोकन
projection	enum (Projection) इस उपयोगकर्ता के लिए, फ़ील्ड का सबसेट.
query	string उपयोगकर्ता फ़ील्ड खोजने के लिए क्वेरी स्ट्रिंग. उपयोगकर्ता क्वेरी बनाने के बारे में ज़्यादा जानकारी के लिए, उपयोगकर्ताओं को खोजें देखें.
showDeleted	string अगर इसे true पर सेट किया जाता है, तो मिटाए गए उपयोगकर्ताओं की सूची का ऐक्सेस मिल जाता है. (डिफ़ॉल्ट: false)
sortOrder	enum (SortOrder) केस को अनदेखा करते हुए, नतीजों को बढ़ते या घटते क्रम में दिखाना है या नहीं.
viewType	enum (ViewType) क्या उपयोगकर्ता को सिर्फ़ एडमिन के लिए या पूरे डोमेन के लिए सार्वजनिक व्यू फ़ेच किया जा सकता है. ज़्यादा जानकारी के लिए, उपयोगकर्ता को गैर-एडमिन के तौर पर वापस लाना देखें.

अनुरोध का मुख्य भाग

अनुरोध का मुख्य हिस्सा खाली होना चाहिए.

जवाब का मुख्य भाग

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

जेएसओएन के काेड में दिखाना
{ "kind": string, "trigger_event": string, "etag": string, "users": [ { object (User) } ], "nextPageToken": string }

फ़ील्ड
kind	string यह एक संसाधन है.
trigger_event	string इस जवाब को ट्रिगर करने वाला इवेंट (सिर्फ़ पुश रिस्पॉन्स के मामले में इस्तेमाल किया जाता है)
etag	string संसाधन का ईटैग.
users[]	object (User) उपयोगकर्ता ऑब्जेक्ट की सूची.
nextPageToken	string इस नतीजे के अगले पेज को ऐक्सेस करने के लिए इस्तेमाल किया गया टोकन.

अनुमति के दायरे

इनमें से किसी एक OAuth दायरे की ज़रूरत होती है:

• https://www.googleapis.com/auth/admin.directory.user
• https://www.googleapis.com/auth/admin.directory.user.readonly
• https://www.googleapis.com/auth/cloud-platform

ज़्यादा जानकारी के लिए, अनुमति देने के लिए गाइड देखें.

इवेंट

सदस्यता इवेंट का टाइप

Enums
ADD	उपयोगकर्ता का बनाया गया इवेंट
DELETE	उपयोगकर्ता का मिटाया गया इवेंट
MAKE_ADMIN	उपयोगकर्ता एडमिन की स्थिति में बदलाव का इवेंट
UNDELETE	उपयोगकर्ता से हटाया नहीं गया इवेंट
UPDATE	उपयोगकर्ता का अपडेट किया गया इवेंट

ऑर्डर करने का समय

Enums
EMAIL	उपयोगकर्ता का मुख्य ईमेल पता.
FAMILY_NAME	उपयोगकर्ता के परिवार का नाम.
GIVEN_NAME	उपयोगकर्ता का दिया गया नाम.

अनुमान की रिपोर्ट

Enums
BASIC	उपयोगकर्ता के लिए कोई भी कस्टम फ़ील्ड शामिल न करें.
CUSTOM	customFieldMask में अनुरोध किए गए स्कीमा से कस्टम फ़ील्ड शामिल करें.
FULL	इस उपयोगकर्ता से जुड़े सभी फ़ील्ड शामिल करें.

SortOrder

Enums
ASCENDING	बढ़ते क्रम में.
DESCENDING	घटते क्रम में.

व्यू टाइप

Enums
admin_view	नतीजों में उपयोगकर्ता के लिए सिर्फ़ एडमिन और डोमेन की सार्वजनिक फ़ील्ड शामिल होती हैं.
domain_public	नतीजों में सिर्फ़ ऐसे उपयोगकर्ता के लिए फ़ील्ड शामिल होते हैं जो डोमेन के दूसरे उपयोगकर्ताओं को सार्वजनिक रूप से दिखते हैं.