Method: users.settings.cse.keypairs.get

یک جفت کلید رمزگذاری موجود در سمت کلاینت را بازیابی می‌کند.

برای مدیرانی که هویت‌ها و جفت‌کلیدهای کاربران سازمان خود را مدیریت می‌کنند، درخواست‌ها نیاز به مجوز با یک حساب کاربری سرویس دارند که اختیار واگذاری در سطح دامنه برای جعل هویت کاربران با دامنه https://www.googleapis.com/auth/gmail.settings.basic را دارد.

برای کاربرانی که هویت و جفت کلیدهای خود را مدیریت می‌کنند، درخواست‌ها مستلزم فعال و پیکربندی شدن رمزگذاری کلید سخت‌افزاری است.

درخواست HTTP

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

این URL از سینتکس Transcoding در gRPC استفاده می‌کند.

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

پارامترها
userId

string

آدرس ایمیل اصلی درخواست‌کننده. برای مشخص کردن کاربر احراز هویت‌شده، می‌توانید از مقدار ویژه me استفاده کنید.

keyPairId

string

شناسه جفت کلید برای بازیابی.

درخواست بدنه

بدنه درخواست باید خالی باشد.

بدنه پاسخ

در صورت موفقیت، بدنه پاسخ حاوی نمونه‌ای از CseKeyPair است.

دامنه‌های مجوز

به یکی از حوزه‌های 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 .