Method: users.settings.cse.keypairs.disable
با مجموعه‌ها، منظم بمانید
ذخیره و طبقه‌بندی محتوا براساس اولویت‌های شما.
یک جفت کلید رمزگذاری سمت سرویس گیرنده را خاموش می کند. کاربر احراز هویت شده دیگر نمی تواند از جفت کلید برای رمزگشایی متون پیام CSE ورودی یا امضای نامه های CSE خروجی استفاده کند.
برای بازیابی دسترسی، از 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 Transcoding استفاده می کند.
پارامترهای مسیر
| پارامترها |
|---|
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 License است. نمونه کدها نیز دارای مجوز Apache 2.0 License است. برای اطلاع از جزئیات، به خطمشیهای سایت Google Developers مراجعه کنید. جاوا علامت تجاری ثبتشده 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)."]]
