השבתה של זוג מפתחות להצפנה מצד הלקוח. המשתמש המאומת לא יכול יותר להשתמש בצמד המפתחות כדי לפענח טקסטים של הודעות 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 |
כתובת האימייל הראשית של השולח. כדי לציין את המשתמש המאומת, אפשר להשתמש בערך המיוחד |
keyPairId |
המזהה של זוג המפתחות שרוצים להשבית. |
גוף הבקשה
גוף הבקשה צריך להיות ריק.
גוף התשובה
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל מופע של CseKeyPair.
היקפי הרשאות
נדרש אחד מהיקפי ההרשאות הבאים של OAuth:
https://www.googleapis.com/auth/gmail.settings.basichttps://www.googleapis.com/auth/gmail.settings.sharing
ניתן למצוא מידע נוסף כאן: OAuth 2.0 Overview.