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

لمزيد من المعلومات، يمكنك الاطّلاع على دليل التفويض.