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.

يستخدم معيار 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,

  // 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

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

string

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

HardwareKeyMetadata

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

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

string

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

الطُرق

create

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

disable

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

enable

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

get

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

list

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

obliterate

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