Method: users.aliases.list

उपयोगकर्ता के सभी उपनामों की सूची बनाता है.

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

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

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

पाथ पैरामीटर

पैरामीटर में
userKey

string

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

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

पैरामीटर में
event

enum (Event)

देखने के लिए इवेंट.

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

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

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

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

जेएसओएन के काेड में दिखाना
{
  "kind": string,
  "etag": string,
  "aliases": [
    {
      object (UserAlias)
    }
  ]
}
फ़ील्ड
kind

string

यह एक संसाधन है.

etag

string

संसाधन का ईटैग.

aliases[]

object (UserAlias)

उपनाम ऑब्जेक्ट की सूची.

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

इनमें से किसी एक OAuth दायरे की ज़रूरत होती है:

  • https://apps-apis.google.com/a/feeds/alias/
  • https://www.googleapis.com/auth/admin.directory.user
  • https://www.googleapis.com/auth/admin.directory.user.alias
  • https://www.googleapis.com/auth/admin.directory.user.alias.readonly
  • https://www.googleapis.com/auth/admin.directory.user.readonly

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

इवेंट

सदस्यता इवेंट का टाइप

Enums
ADD उपनाम बनाया गया इवेंट
DELETE उपनाम हटाया गया इवेंट