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 उपयोगकर्ता की जानकारी अपडेट करने वाला इवेंट

OrderBy

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

अनुमान

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

SortOrder

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

ViewType

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