Method: users.settings.cse.keypairs.disable
משביתה זוג מפתחות להצפנה מצד הלקוח. המשתמש המאומת לא יכול יותר להשתמש בזוג המפתחות כדי לפענח הודעות טקסט נכנסות של CSE או לחתום על אימייל CSE יוצא.
כדי לקבל שוב גישה, יש להשתמש ב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 (שעון UTC).
[null,null,["עדכון אחרון: 2024-09-05 (שעון UTC)."],[[["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"]]
