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

संसाधन का ETag.
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 उपयोगकर्ता का अपडेट किया गया इवेंट

OrderBy

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

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

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

SortOrder

Enums
ASCENDING आरोही क्रम.
DESCENDING अवरोही क्रम.

ViewType

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