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

برای اطلاعات بیشتر، بهOAuth 2.0 Overview .