REST Resource: users.settings.cse.keypairs

المرجع: CseKeypair

يشير هذا المصطلح إلى زوج مفاتيح S/MIME للتشفير من جهة العميل، والذي يتألف من مفتاح عام وسلسلة شهاداته والبيانات الوصفية لمفتاحه الخاص المقترن. يستخدم Gmail مفتاحَي التشفير لإكمال المهام التالية:

  • توقيع الرسائل الصادرة المشفَّرة من جهة العميل
  • حفظ مسودات الرسائل المشفّرة من جهة العميل وإعادة فتحها
  • حفظ الرسائل المُرسَلة وإعادة فتحها
  • فك تشفير رسائل S/MIME الواردة أو المؤرشفة.
تمثيل JSON 
{
  "keyPairId": string,
  "pkcs7": string,
  "pem": string,
  "subjectEmailAddresses": [
    string
  ],
  "enablementState": enum (EnablementState),
  "disableTime": string,
  "privateKeyMetadata": [
    {
      object (CsePrivateKeyMetadata)
    }
  ]
}
الحقول
keyPairId

string

النتائج فقط. المعرّف غير القابل للتغيير لمفتاحَي التشفير S/MIME للتشفير من جهة العميل
pkcs7

string

الإدخال فقط. المفتاح العام وسلسلة الشهادات الخاصة به يجب أن تكون السلسلة بالتنسيق PKCS#7 وأن تستخدم ترميز PEM ودرع ASCII.
pem

string

النتائج فقط. تمثّل هذه السمة المفتاح العام وسلسلة شهاداته بتنسيق PEM.
subjectEmailAddresses[]

string

النتائج فقط. هويات عناوين البريد الإلكتروني التي تم تحديدها في الشهادة التجريبية.
enablementState

enum (EnablementState)

النتائج فقط. الحالة الحالية لمفتاحَي التشفير.
disableTime

string (Timestamp format)

النتائج فقط. في حال ضبط مفتاحَي التشفير على DISABLED، هذا هو الوقت الذي تغيّرت فيه حالة مفتاحَي التشفير من ENABLED إلى DISABLED. لا يتوفّر هذا الحقل إلا عندما يكون مفتاحا التشفير في حالة DISABLED.

طابع زمني بتنسيق RFC3339 حسب التوقيت العالمي المنسَّق (UTC) "زولو" بدقة نانوثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: "2014-10-02T15:01:23Z" و"2014-10-02T15:01:23.045123456Z".
privateKeyMetadata[]

object (CsePrivateKeyMetadata)

البيانات الوصفية لمثيلات المفتاح الخاص لزوج المفاتيح هذا

EnablementState

التعداد للحالة الحالية لزوج المفاتيح.

عمليات التعداد
stateUnspecified لم يتم ضبط الحالة الحالية لمفتاحَي التشفير. لم يتم تفعيل مفتاحَي التشفير أو إيقافهما.
enabled

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

لتفعيل مفتاحَي التشفير، استخدِم الطريقة keypairs.enable.
disabled

تم إيقاف مفتاحَي التشفير. ولا يمكن للمستخدمين الذين تمت مصادقتهم فك تشفير الرسائل الإلكترونية أو توقيع الرسائل الصادرة. إذا تم إيقاف مفتاحَي التشفير لمدة تزيد عن 30 يومًا، يمكنك حذفهما نهائيًا.

لإيقاف مفتاحَي التشفير، استخدِم الطريقة keypairs.disable.

CsePrivateKeyMetadata

البيانات الوصفية لمثيل مفتاح خاص

تمثيل JSON 
{
  "privateKeyMetadataId": string,

  // Union field metadata_variant can be only one of the following:
  "kaclsKeyMetadata": {
    object (KaclsKeyMetadata)
  },
  "hardwareKeyMetadata": {
    object (HardwareKeyMetadata)
  }
  // End of list of possible types for union field metadata_variant.
}
الحقول
privateKeyMetadataId

string

النتائج فقط. رقم التعريف غير القابل للتغيير لمثيل البيانات الوصفية للمفتاح الخاص.
حقل الاتحاد metadata_variant. حقل الاتحاد: يجب أن يتوفّر واحد بالضبط من أنواع صيغ البيانات الوصفية التالية. يمكن أن يكون metadata_variant واحدًا فقط مما يلي:
kaclsKeyMetadata

object (KaclsKeyMetadata)

البيانات الوصفية لمثيل مفتاح خاص تديره خدمة قائمة التحكّم بالوصول إلى مفاتيح خارجية
hardwareKeyMetadata

object (HardwareKeyMetadata)

البيانات الوصفية لمفاتيح الأجهزة

KaclsKeyMetadata

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

تمثيل JSON 
{
  "kaclsUri": string,
  "kaclsData": string
}
الحقول
kaclsUri

string

معرِّف الموارد المنتظم (URI) لخدمة قائمة التحكّم بالوصول إلى مفاتيح التشفير التي تدير المفتاح الخاص.
kaclsData

string

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

HardwareKeyMetadata

البيانات الوصفية لمفاتيح الأجهزة

تمثيل JSON 
{
  "description": string
}
الحقول
description

string

وصف حول مفتاح الجهاز

الطُرق

create

 إنشاء وتحميل سلسلة شهادات المفتاح العام S/MIME للتشفير من جهة العميل والبيانات الوصفية للمفتاح الخاص للمستخدم الذي تمت مصادقته.

disable

 إيقاف مفتاحَي تشفير من جهة العميل

enable

 تفعيل مفتاحَي تشفير من جهة العميل تم إيقافه

get

 لاسترداد مفتاحَي تشفير حاليَين من جهة العميل.

list

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

obliterate

 يتم حذف مفتاحَي تشفير من جهة العميل نهائيًا وعلى الفور.