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)

דף אחד ברשימת זוגות המפתחות של CSE שהותקנו עבור המשתמש.
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

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