Method: users.aliases.list

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

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

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

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

पाथ पैरामीटर

पैरामीटर
userKey

string

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

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

पैरामीटर
event

enum (Event)

ऐसे इवेंट जिन पर ध्यान देना ज़रूरी है.

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

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

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

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

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

string

यह किस तरह का संसाधन है.
etag

string

संसाधन का ETag.
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 मिटाए गए इवेंट का दूसरा नाम