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.

مَعلمات المسار

المعلمات
userId

string

عنوان البريد الإلكتروني الأساسي لصاحب الطلب للإشارة إلى المستخدم الذي تمّت مصادقته، يمكنك استخدام القيمة الخاصة me.

مَعلمات طلب البحث

المعلمات
pageToken

string

رمز تقسيم إلى صفحات يشير إلى صفحة أزواج المفاتيح المطلوب عرضها. في حال عدم توفير الرمز المميّز، ستعرض واجهة برمجة التطبيقات الصفحة الأولى من النتائج.
pageSize

integer

عدد أزواج المفاتيح المطلوب عرضها. في حال عدم توفيرها، سيتم ضبط حجم الصفحة تلقائيًا على 20 إدخالاً.

نص الطلب

يجب أن يكون نص الطلب فارغًا.

نص الاستجابة

إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:

تمثيل JSON 
{
  "cseKeyPairs": [
    {
      object (CseKeyPair)
    }
  ],
  "nextPageToken": string
}
الحقول
cseKeyPairs[]

object (CseKeyPair)

صفحة واحدة من قائمة مفاتيح التشفير من جهة العميل المثبَّتة للمستخدم
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.