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
ज़्यादा जानकारी के लिए, अनुमति से जुड़ी गाइड देखें.
जब तक कुछ अलग से न बताया जाए, तब तक इस पेज की सामग्री को Creative Commons Attribution 4.0 License के तहत और कोड के नमूनों को Apache 2.0 License के तहत लाइसेंस मिला है. ज़्यादा जानकारी के लिए, Google Developers साइट नीतियां देखें. Oracle और/या इससे जुड़ी हुई कंपनियों का, Java एक रजिस्टर किया हुआ ट्रेडमार्क है.
आखिरी बार 2025-07-25 (UTC) को अपडेट किया गया.
[null,null,["आखिरी बार 2025-07-25 (UTC) को अपडेट किया गया."],[],[],null,["# Method: users.settings.cse.keypairs.obliterate\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nDeletes a client-side encryption key pair permanently and immediately. You can only permanently delete key pairs that have been turned off for more than 30 days. To turn off a key pair, use the [keypairs.disable](/workspace/gmail/api/reference/rest/v1/users.settings.cse.keypairs/disable#caribou.api.proto.MailboxService.DisableCseKeyPair) method.\n\nGmail can't restore or decrypt any messages that were encrypted by an obliterated key. Authenticated users and Google Workspace administrators lose access to reading the encrypted messages.\n\nFor administrators managing identities and keypairs for users in their organization, requests require authorization with a [service account](https://developers.google.com/identity/protocols/OAuth2ServiceAccount) that has [domain-wide delegation authority](https://developers.google.com/identity/protocols/OAuth2ServiceAccount#delegatingauthority) to impersonate users with the `https://www.googleapis.com/auth/gmail.settings.basic` scope.\n\nFor users managing their own identities and keypairs, requests require [hardware key encryption](https://support.google.com/a/answer/14153163) turned on and configured.\n\n### HTTP request\n\n`POST https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:obliterate`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|-------------|-------------------------------------------------------------------------------------------------------------------------|\n| `userId` | `string` The requester's primary email address. To indicate the authenticated user, you can use the special value `me`. |\n| `keyPairId` | `string` The identifier of the key pair to obliterate. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body is an empty JSON object.\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/gmail.settings.basic`\n- `\n https://www.googleapis.com/auth/gmail.settings.sharing`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]
