Method: users.settings.cse.keypairs.obliterate

क्लाइंट-साइड एन्क्रिप्शन की कुंजी के जोड़े को हमेशा के लिए और तुरंत मिटा देता है. सिर्फ़ उन पासकोड जोड़े को हमेशा के लिए मिटाया जा सकता है जिन्हें 30 दिनों से ज़्यादा समय से बंद किया गया है. किसी पासकोड जोड़े को बंद करने के लिए, keypairs.disable का इस्तेमाल करें.

Gmail, मिटाई गई कुंजी से एन्क्रिप्ट (सुरक्षित) किए गए किसी भी मैसेज को वापस नहीं ला सकता या उसे डिक्रिप्ट (सुरक्षित से सामान्य में बदला) नहीं कर सकता. पुष्टि किए गए उपयोगकर्ता और Google Workspace एडमिन, एन्क्रिप्ट (सुरक्षित) किए गए मैसेज नहीं पढ़ पाएंगे.

अपने संगठन के उपयोगकर्ताओं की पहचान और पासकोड मैनेज करने वाले एडमिन को, अनुरोधों के लिए सेवा खाते से अनुमति लेनी होगी. इस खाते के पास https://www.googleapis.com/auth/gmail.settings.basic स्कोप वाले उपयोगकर्ताओं के नाम पर काम करने के लिए, डोमेन के लिए अनुमति देने का अधिकार होना चाहिए.

अपनी पहचान और की-पेयर मैनेज करने वाले उपयोगकर्ताओं के लिए, अनुरोधों के लिए हार्डवेयर पासकोड एन्क्रिप्शन चालू और कॉन्फ़िगर होना ज़रूरी है.

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

POST https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:obliterate

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

पाथ पैरामीटर

पैरामीटर
userId

string

अनुरोध करने वाले का मुख्य ईमेल पता. पुष्टि किए गए उपयोगकर्ता की जानकारी देने के लिए, खास वैल्यू me का इस्तेमाल किया जा सकता है.
keyPairId

string

मिटाए जाने वाले पासकोड के जोड़े का आइडेंटिफ़ायर.

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

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

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

अगर एपीआई सही से जुड़ जाता है, तो रिस्पॉन्स बॉडी में खाली JSON ऑब्जेक्ट होता है.

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

इसके लिए, OAuth के इनमें से किसी एक स्कोप की ज़रूरत होती है:

  • https://www.googleapis.com/auth/gmail.settings.basic
  • https://www.googleapis.com/auth/gmail.settings.sharing

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