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)

उपयोगकर्ता के सिर्फ़ एडमिन या डोमेन-पूरे सार्वजनिक व्यू को फ़ेच करना है या नहीं. ज़्यादा जानकारी के लिए, किसी उपयोगकर्ता को गैर-एडमिन के तौर पर वापस लाना देखें.

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

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

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

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

JSON के काेड में दिखाना 
{
  "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 उपयोगकर्ता का अपडेट किया गया इवेंट

इससे ऑर्डर करें

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

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

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

SortOrder

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

ViewType

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