REST Resource: users.settings.cse.keypairs

المورد: CseKeyPair

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

  • توقيع الرسائل الصادرة المشفَّرة من جهة العميل
  • حفظ مسودّات الرسائل المشفَّرة من جهة العميل وإعادة فتحها
  • حفظ الرسائل المرسَلة وإعادة فتحها
  • فك تشفير رسائل S/MIME الواردة أو المؤرشفة

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

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

تمثيل 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 armor.
pem

string

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

string

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

enum (EnablementState)

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

string (Timestamp format)

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

يستخدم المعيار RFC 3339، حيث يكون الناتج الذي يتم إنشاؤه مُمثلاً بالتوقيت العالمي المنسَّق مع حرف Z في النهاية ويستخدم الأرقام الجزئية 0 أو 3 أو 6 أو 9. تُقبل أيضًا المعادلات الأخرى التي لا تستخدم حرف Z. أمثلة: "2014-10-02T15:01:23Z" أو "2014-10-02T15:01:23.045123456Z" أو "2014-10-02T15:01:23+05:30".
privateKeyMetadata[]

object (CsePrivateKeyMetadata)

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

EnablementState

تعداد الحالة الحالية لمفتاحَي التشفير

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

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

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

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

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

CsePrivateKeyMetadata

تمثّل هذه السمة البيانات الوصفية لمثيل مفتاح خاص.

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

  "kaclsKeyMetadata": {
    object (KaclsKeyMetadata)
  },
  "hardwareKeyMetadata": {
    object (HardwareKeyMetadata)
  }
}
الحقول
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

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

في حال إعداد تشفير مفتاح الجهاز لمؤسسة Google Workspace، يمكن للمستخدمين تخزين مفتاحهم الخاص بشكل اختياري على بطاقتهم الذكية واستخدامه لتوقيع الرسائل الإلكترونية وفك تشفيرها في Gmail من خلال إدخال البطاقة الذكية في قارئ موصول بجهاز Windows.

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

string

وصف لمفتاح الأمان الخارجي

الطُرق

create

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

disable

 توقِف هذه الطريقة زوج مفاتيح التشفير من جهة العميل.

enable

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

get

 يستردّ هذا الإجراء زوج مفاتيح تشفير حالي من جهة العميل.

list

 تعرض هذه الطريقة أزواج مفاتيح التشفير من جهة العميل لمستخدم تم إثبات هويته.

obliterate

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