Method: users.settings.cse.keypairs.disable
يتم إيقاف زوج مفاتيح التشفير من جهة العميل. لم يعُد بإمكان المستخدم الذي تمت مصادقته استخدام مفتاحَي التشفير لفك تشفير نصوص الرسائل الواردة من جهة العميل أو توقيع الرسائل الصادرة المشفَّرة من جهة العميل.
لاستعادة إمكانية الوصول، استخدِم keypairs.enable
لتفعيل مفتاحَي التشفير.
وبعد 30 يومًا، يمكنك حذف مفتاحَي التشفير نهائيًا باستخدام طريقة keypairs.obliterate
.
طلب 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 و/أو شركائها التابعين.
تاريخ التعديل الأخير: 2024-09-05 (حسب التوقيت العالمي المتفَّق عليه)
[null,null,["تاريخ التعديل الأخير: 2024-09-05 (حسب التوقيت العالمي المتفَّق عليه)"],[[["Turns off a client-side encryption key pair, preventing the authenticated user from decrypting incoming or signing outgoing CSE messages."],["To regain access to the key pair, use the `keypairs.enable` method within 30 days, after which it can be permanently deleted with `keypairs.obliterate`."],["This action is performed through a POST request to the specified endpoint with `userId` and `keyPairId` as path parameters."],["Requires specific authorization scopes (`gmail.settings.basic` or `gmail.settings.sharing`) for the request to be processed."]]],["This API endpoint disables a client-side encryption key pair via a `POST` request to a specific URL including `userId` and `keyPairId` path parameters. The request body is empty. Upon success, the API returns a `CseKeyPair` instance. Disabling a key prevents decryption of incoming messages and signing of outgoing mail. The key can be re-enabled or permanently deleted after 30 days. Access requires specific OAuth scopes, either `gmail.settings.basic` or `gmail.settings.sharing`.\n"]]