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 इस उपयोगकर्ता से जुड़े सभी फ़ील्ड शामिल करें.

व्यू टाइप

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