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 از دستور GRPC Transcoding استفاده می کند.

پارامترهای مسیر

پارامترها
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

برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.