Method: users.settings.cse.keypairs.list

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

אדמינים שמנהלים זהויות וזוגות מפתחות של משתמשים בארגון שלהם צריכים לקבל הרשאה מחשבון שירות שיש לו הרשאת הענקת גישה ברמת הדומיין כדי להתחזות למשתמשים ברמת ההיקף https://www.googleapis.com/auth/gmail.settings.basic.

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

בקשת HTTP

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

כתובת ה-URL משתמשת בתחביר של Transcoding של 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

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