یک جفت کلید رمزگذاری سمت سرویس گیرنده را به طور دائم و بلافاصله حذف می کند. فقط می‌توانید جفت‌های کلیدی را که بیش از 30 روز خاموش بوده‌اند، به‌طور دائم حذف کنید. برای خاموش کردن یک جفت کلید، از روش keypairs.disable استفاده کنید.
Gmail نمی‌تواند پیام‌هایی را که توسط یک کلید حذف شده رمزگذاری شده‌اند بازیابی یا رمزگشایی کند. کاربران احراز هویت شده و سرپرستان Google Workspace دسترسی به خواندن پیام های رمزگذاری شده را از دست می دهند.
درخواست HTTP
POST https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:obliterate
URL از دستور GRPC Transcoding استفاده می کند.
پارامترهای مسیر
| مولفه های | |
|---|---|
userId | آدرس ایمیل اصلی درخواست کننده. برای نشان دادن کاربر احراز هویت شده، می توانید از مقدار ویژه |
keyPairId | شناسه جفت کلید برای حذف. |
درخواست بدن
بدنه درخواست باید خالی باشد.
بدن پاسخگو
در صورت موفقیت آمیز بودن، بدنه پاسخ خالی است.
محدوده مجوز
به یکی از حوزه های OAuth زیر نیاز دارد:
-
https://www.googleapis.com/auth/gmail.settings.basic -
https://www.googleapis.com/auth/gmail.settings.sharing
برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.