उपयोगकर्ता का उपनाम बनाना
उपयोगकर्ता का उपनाम ऐसा वैकल्पिक ईमेल पता होता है जो उसी मेलबॉक्स का इस्तेमाल करता है जिसका इस्तेमाल उपयोगकर्ता के मुख्य ईमेल पते करता है. उपयोगकर्ता का उपनाम उस डोमेन से अलग, किसी दूसरे खाते के डोमेन से जुड़ा हो सकता है जिसका इस्तेमाल उपयोगकर्ता के मुख्य ईमेल पते पर किया जाता है. 24 घंटे के अंदर (अक्सर पहले), उपयोगकर्ता को इस पते पर भेजे गए ईमेल मिलने शुरू हो जाते हैं. उपनाम बनाने से पहले, एपीआई के लिए यह ज़रूरी है कि डोमेन के मालिकाना हक की पुष्टि हो रही हो.
उपयोगकर्ता का उपनाम बनाने के लिए, नीचे दिए गए POST अनुरोध का इस्तेमाल करें और अनुमति देने के अनुरोध में बताया गया अनुमति शामिल करें. userKey, उपयोगकर्ता का मुख्य ईमेल पता, उपयोगकर्ता id या उपयोगकर्ता के किसी उपनाम का ईमेल पता हो सकता है. अनुरोध और रिस्पॉन्स प्रॉपर्टी के लिए, एपीआई का रेफ़रंस देखें:
POST https://admin.googleapis.com/admin/directory/v1/users/userKey/aliases
JSON अनुरोध
नीचे दिया गया JSON अनुरोध, उपयोगकर्ता का उपनाम बनाने के लिए एक सैंपल अनुरोध दिखाता है. उपयोगकर्ता का नाम liz@example.com है और उसका ईमेल उपनाम Chica@example.com है:
POST https://admin.googleapis.com/admin/directory/v1/users/liz@example.com/aliasesअनुरोध के मुख्य भाग में नई उपनाम जानकारी है:
{
"alias": "chica@example.com"
}
सही जवाब देने पर एचटीटीपी 201 स्टेटस कोड दिखता है. स्टेटस कोड के साथ-साथ, रिस्पॉन्स, नए उपयोगकर्ता के उपनाम के लिए प्रॉपर्टी दिखाता है.
किसी उपयोगकर्ता के सभी उपनामों को फिर से पाएं
सभी डोमेन में, किसी उपयोगकर्ता के उपनामों को वापस पाने के लिए, नीचे दिए गए GET अनुरोध का इस्तेमाल करें. इसमें, अनुमति देने के अनुरोध में दी गई अनुमति को शामिल करें. userKey, उपयोगकर्ता का मुख्य ईमेल पता, उपयोगकर्ता id या उपयोगकर्ता के किसी उपनाम का ईमेल पता हो सकता है. अनुरोध और रिस्पॉन्स प्रॉपर्टी के लिए, एपीआई का रेफ़रंस देखें:
GET https://admin.googleapis.com/admin/directory/v1/users/userKey/aliases
उदाहरण के लिए, इस अनुरोध यूआरआई से userKey, liz@example.com के लिए सभी उपनाम दिखाए जाते हैं:
GET https://admin.googleapis.com/admin/directory/v1/users/liz@example.com/aliases
सभी उपयोगकर्ताओं के उपनाम, वर्णमाला के क्रम में दिए जाते हैं. कोई पेज आकार नहीं है जैसे 'सभी उपनामों को फिर से पाएं' प्रतिक्रिया के लिए इस्तेमाल किया गया maxResults क्वेरी स्ट्रिंग या पेजिनेशन.
JSON का रिस्पॉन्स
सही जवाब एचटीटीपी 200 स्टेटस कोड दिखाता है. रिस्पॉन्स, स्टेटस कोड के साथ ही, उपयोगकर्ताओं के उपनामों को वर्णमाला के क्रम में दिखाता है. ये उपनाम डोमेन, खाते के प्राइमरी डोमेन और अन्य एक से ज़्यादा डोमेन होते हैं:
{
"kind": "directory#user#aliases",
"aliases": [
{
"kind": "directory#user#alias",
"id": "the unique user id",
"primary_email": "liz@example.com",
"alias": "chica@example.com"
},
{
"kind": "directory#user#alias",
"id": "the unique user id",
"primary_email": "liz@example.com",
"alias": "support@example.com"
},
{
"kind": "directory#user#alias",
"id": "the unique user id",
"primary_email": "liz@example.com",
"alias": "help@hr.example.com"
},
{
"kind": "directory#user#alias",
"id": "the unique user id",
"primary_email": "liz@example.com",
"alias": "tickets@jumboinc.com"
}
]
}
उपयोगकर्ता का उपनाम मिटाना
उपयोगकर्ता का उपनाम मिटाने के लिए, नीचे दिए गए DELETE अनुरोध का इस्तेमाल करें और
अनुरोध की अनुमति दें में बताया गया अनुमति शामिल करें. उपनाम को हटाने में
24 घंटे तक लग सकते हैं. userKey, उपयोगकर्ता का मुख्य ईमेल पता, उपयोगकर्ता id या उपयोगकर्ता के किसी उपनाम का ईमेल पता हो सकता है. और aliasId वह उपनाम ईमेल पता है जिसे
मिटाया जा रहा है. अनुरोध और रिस्पॉन्स प्रॉपर्टी के लिए, एपीआई का रेफ़रंस देखें.
DELETE https://admin.googleapis.com/admin/directory/v1/users/userKey/aliases/aliasIdउदाहरण के लिए, यह
DELETE अनुरोध userKey, liz@example.com के लिए Chica@example.com उपनाम को मिटा देता है:
DELETE https://admin.googleapis.com/admin/directory/v1/users/liz@example.com/aliases/chica@example.com
सही जवाब एचटीटीपी 200 स्टेटस कोड दिखाता है.