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
لمزيد من المعلومات، يمكنك الاطّلاع على دليل التفويض.
إنّ محتوى هذه الصفحة مرخّص بموجب ترخيص Creative Commons Attribution 4.0 ما لم يُنصّ على خلاف ذلك، ونماذج الرموز مرخّصة بموجب ترخيص Apache 2.0. للاطّلاع على التفاصيل، يُرجى مراجعة سياسات موقع Google Developers. إنّ Java هي علامة تجارية مسجَّلة لشركة Oracle و/أو شركائها التابعين.
تاريخ التعديل الأخير: 2025-07-25 (حسب التوقيت العالمي المتفَّق عليه)
[null,null,["تاريخ التعديل الأخير: 2025-07-25 (حسب التوقيت العالمي المتفَّق عليه)"],[],[],null,["# Method: users.settings.cse.keypairs.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListCseKeyPairsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLists client-side encryption key pairs for an authenticated user.\n\nFor administrators managing identities and keypairs for users in their organization, requests require authorization with a [service account](https://developers.google.com/identity/protocols/OAuth2ServiceAccount) that has [domain-wide delegation authority](https://developers.google.com/identity/protocols/OAuth2ServiceAccount#delegatingauthority) to impersonate users with the `https://www.googleapis.com/auth/gmail.settings.basic` scope.\n\nFor users managing their own identities and keypairs, requests require [hardware key encryption](https://support.google.com/a/answer/14153163) turned on and configured.\n\n### HTTP request\n\n`GET https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/cse/keypairs`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|-------------------------------------------------------------------------------------------------------------------------|\n| `userId` | `string` The requester's primary email address. To indicate the authenticated user, you can use the special value `me`. |\n\n### Query parameters\n\n| Parameters ||\n|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageToken` | `string` Pagination token indicating which page of key pairs to return. If the token is not supplied, then the API will return the first page of results. |\n| `pageSize` | `integer` The number of key pairs to return. If not provided, the page size will default to 20 entries. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"cseKeyPairs\": [ { object (/workspace/gmail/api/reference/rest/v1/users.settings.cse.keypairs#CseKeyPair) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `cseKeyPairs[]` | `object (`[CseKeyPair](/workspace/gmail/api/reference/rest/v1/users.settings.cse.keypairs#CseKeyPair)`)` One page of the list of CSE key pairs installed for the user. |\n| `nextPageToken` | `string` Pagination token to be passed to a subsequent keypairs.list call in order to retrieve the next page of key pairs. If this value is not returned, then no further pages remain. |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/gmail.settings.basic`\n- `\n https://mail.google.com/`\n- `\n https://www.googleapis.com/auth/gmail.modify`\n- `\n https://www.googleapis.com/auth/gmail.readonly`\n- `\n https://www.googleapis.com/auth/gmail.settings.sharing`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]
