Method: users.settings.cse.identities.list

يسرد العناصر المشفّرة من جهة العميل لمستخدم تمّت مصادقة هويته.

بالنسبة إلى المشرفين الذين يديرون هويات المستخدمين ومجموعات المفاتيح الخاصة بهم في مؤسستهم، تتطلّب الطلبات الحصول على تفويض من خلال حساب خدمة يمتلك سلطة تفويض على مستوى النطاق لانتحال هوية المستخدمين باستخدام نطاق https://www.googleapis.com/auth/gmail.settings.basic.

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

طلب HTTP

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

يستخدِم عنوان URL بنية تحويل ترميز gRPC.

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

المعلمات
userId

string

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

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

المعلمات
pageToken

string

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

pageSize

integer

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

نص الطلب

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

نص الاستجابة

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

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

object (CseIdentity)

صفحة واحدة من قائمة هويات "التشفير من جهة العميل" التي تم ضبطها للمستخدم

nextPageToken

string

رمز مخطّط التقسيم الذي سيتم تمريره إلى طلب لاحق من identities.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

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