Method: users.settings.cse.keypairs.disable
تنظيم صفحاتك في مجموعات
يمكنك حفظ المحتوى وتصنيفه حسب إعداداتك المفضّلة.
إيقاف زوج مفاتيح التشفير من جهة العميل لن يتمكّن المستخدم الذي تمّت مصادقة هويته من استخدام مفتاحَي التشفير لفك تشفير نصوص الرسائل الواردة المشفَّرة من جهة العميل أو توقيع الرسائل الإلكترونية الصادرة المشفَّرة من جهة العميل.
لاستعادة إمكانية الوصول، استخدِم keypairs.enable لتفعيل مفتاحَي التشفير.
بعد 30 يومًا، يمكنك حذف مفتاحَي التشفير نهائيًا باستخدام الطريقة keypairs.obliterate.
بالنسبة إلى المشرفين الذين يديرون هويات المستخدمين ومجموعات المفاتيح الخاصة بهم في مؤسستهم، تتطلّب الطلبات الحصول على تفويض من خلال حساب خدمة يمتلك سلطة تفويض على مستوى النطاق لانتحال هوية المستخدمين باستخدام نطاق https://www.googleapis.com/auth/gmail.settings.basic.
بالنسبة إلى المستخدمين الذين يديرون هوياتهم ومفاتيحهم الخاصة، تتطلّب الطلبات تفعيل ميزة تشفير مفتاح الجهاز وضبطها.
طلب HTTP
POST https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:disable
يستخدِم عنوان URL بنية تحويل ترميز gRPC.
مَعلمات المسار
| المعلمات |
userId |
string
عنوان البريد الإلكتروني الأساسي للمطلوب منه للإشارة إلى المستخدم الذي تمّت مصادقة هويته، يمكنك استخدام القيمة الخاصة me.
|
keyPairId |
string
معرّف مفتاحَي التشفير المطلوب إيقافهما
|
نص الطلب
يجب أن يكون نص الطلب فارغًا.
نص الاستجابة
إذا كانت الاستجابة ناجحة، يحتوي نص الاستجابة على مثال CseKeyPair.
نطاقات التفويض
يتطلب أحد نطاقات OAuth التالية:
https://www.googleapis.com/auth/gmail.settings.basic
https://www.googleapis.com/auth/gmail.settings.sharing
لمزيد من المعلومات، يمكنك الاطّلاع على دليل التفويض.
إنّ محتوى هذه الصفحة مرخّص بموجب ترخيص Creative Commons Attribution 4.0 ما لم يُنصّ على خلاف ذلك، ونماذج الرموز مرخّصة بموجب ترخيص Apache 2.0. للاطّلاع على التفاصيل، يُرجى مراجعة سياسات موقع Google Developers. إنّ Java هي علامة تجارية مسجَّلة لشركة Oracle و/أو شركائها التابعين.
تاريخ التعديل الأخير: 2025-07-25 (حسب التوقيت العالمي المتفَّق عليه)
[null,null,["تاريخ التعديل الأخير: 2025-07-25 (حسب التوقيت العالمي المتفَّق عليه)"],[],[],null,["# Method: users.settings.cse.keypairs.disable\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\nTurns off a client-side encryption key pair. The authenticated user can no longer use the key pair to decrypt incoming CSE message texts or sign outgoing CSE mail.\n\nTo regain access, use the [keypairs.enable](/workspace/gmail/api/reference/rest/v1/users.settings.cse.keypairs/enable#caribou.api.proto.MailboxService.EnableCseKeyPair) to turn on the key pair.\n\nAfter 30 days, you can permanently delete the key pair by using the [keypairs.obliterate](/workspace/gmail/api/reference/rest/v1/users.settings.cse.keypairs/obliterate#caribou.api.proto.MailboxService.ObliterateCseKeyPair) method.\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}:disable`\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 turn off. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains an instance of [CseKeyPair](/workspace/gmail/api/reference/rest/v1/users.settings.cse.keypairs#CseKeyPair).\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)."]]
