Method: users.get

किसी उपयोगकर्ता की जानकारी दिखाता है.

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

GET https://admin.googleapis.com/admin/directory/v1/users/{userKey}

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

पाथ पैरामीटर

पैरामीटर
userKey

string

एपीआई अनुरोध में उपयोगकर्ता की पहचान करता है. वैल्यू, उपयोगकर्ता का मुख्य ईमेल पता, उपनाम वाला ईमेल पता या यूनीक उपयोगकर्ता आईडी हो सकता है.

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

पैरामीटर
customFieldMask

string

स्कीमा के नामों की कॉमा लगाकर अलग की गई सूची. इन स्कीमा के सभी फ़ील्ड फ़ेच किए जाते हैं. इसे सिर्फ़ तब सेट किया जाना चाहिए, जब projection=custom.
projection

enum (Projection)

इस उपयोगकर्ता के लिए, फ़ील्ड का कौनसा सबसेट फ़ेच करना है.
viewType

enum (ViewType)

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

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

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

जवाब का मुख्य हिस्सा

कामयाब रहने पर, जवाब के मुख्य हिस्से में User का एक इंस्टेंस शामिल किया जाता है.

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

इसके लिए, OAuth के इनमें से किसी एक स्कोप की ज़रूरत होती है:

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

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

अनुमान

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

ViewType

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