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 का रिस्पॉन्स

अनुरोध पूरा होने पर, एचटीटीपी 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

अनुरोध पूरा होने पर, एचटीटीपी 200 स्टेटस कोड दिखता है.