Directory API: उपयोगकर्ता के उपनाम

उपयोगकर्ता का दूसरा नाम बनाना

किसी उपयोगकर्ता का उपनाम, एक ऐसा दूसरा ईमेल पता होता है जो उसी मेलबॉक्स का इस्तेमाल करता है जिसका इस्तेमाल उपयोगकर्ता का मुख्य ईमेल पता करता है. किसी उपयोगकर्ता के ईमेल पते का उपनाम, उपयोगकर्ता के मुख्य ईमेल पते के डोमेन से अलग डोमेन से जुड़ा हो सकता है. उपयोगकर्ता को 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

GET https://admin.googleapis.com/admin/directory/v1/users/liz@example.com/aliases

उपयोगकर्ता के सभी ईमेल पतों को वर्णमाला के क्रम में दिखाया जाता है. पेज का कोई साइज़ नहीं है. जैसे, 'सभी उपनाम वापस पाएं' जवाब के लिए इस्तेमाल की गई maxResults क्वेरी स्ट्रिंग या पेज नंबर.

JSON का रिस्पॉन्स

अनुरोध पूरा होने पर, HTTP 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 https://admin.googleapis.com/admin/directory/v1/users/liz@example.com/aliases/chica@example.com

अनुरोध पूरा होने पर, HTTP 200 स्टेटस कोड मिलता है.