Method: users.settings.cse.keypairs.list

בתיבת הדו-שיח הזו מפורטים זוגות מפתחות הצפנה מצד הלקוח למשתמשים מאומתים.

בקשת HTTP

GET https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/cse/keypairs

בכתובת ה-URL נעשה שימוש בתחביר המרת gRPC.

פרמטרים של נתיב

פרמטרים
userId

string

כתובת האימייל הראשית של המבקש. כדי לציין את המשתמש המאומת, ניתן להשתמש בערך המיוחד me.

פרמטרים של שאילתה

פרמטרים
pageToken

string

אסימון עימוד שמציין את הדף של זוגות המפתחות שיש להחזיר. אם לא תספקו את האסימון, ה-API יחזיר את דף התוצאות הראשון.
pageSize

integer

מספר זוגות המפתחות שיש להחזיר. אם לא תספקו כתובת, גודל הדף יוגדר כברירת מחדל ל-20 רשומות.

גוף הבקשה

גוף הבקשה חייב להיות ריק.

גוף התגובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכלול נתונים במבנה הבא:

ייצוג JSON 
{
  "cseKeyPairs": [
    {
      object (CseKeyPair)
    }
  ],
  "nextPageToken": string
}
שדות
cseKeyPairs[]

object (CseKeyPair)

דף אחד ברשימה של זוגות המפתחות בהצפנה מצד הלקוח שהותקנו עבור המשתמש.
nextPageToken

string

אסימון העימוד שיועבר לקריאה הבאה של keypairs.list כדי לאחזר את הדף הבא של זוגות המפתחות. אם הערך הזה לא מוחזר, לא נשארים דפים נוספים.

היקפי הרשאות

כדי להשתמש בתכונה הזו יש צורך באחד מההיקפים הבאים של OAuth:

  • https://www.googleapis.com/auth/gmail.settings.basic
  • https://mail.google.com/
  • https://www.googleapis.com/auth/gmail.modify
  • https://www.googleapis.com/auth/gmail.readonly
  • https://www.googleapis.com/auth/gmail.settings.sharing

למידע נוסף, ניתן לעיין במדריך ההרשאות.