REST Resource: users.settings.cse.keypairs

المورد: زوج المفاتيح

زوج مفاتيح 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 "Zulu"، مع دقة نانوثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: "2014-10-02T15:01:23Z" و"2014-10-02T15:01:23.045123456Z".

privateKeyMetadata[]

object (CsePrivateKeyMetadata)

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

حالة التمكين

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

عمليات التعداد
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)
  }
  // End of list of possible types for union field metadata_variant.
}
الحقول
privateKeyMetadataId

string

الإخراج فقط. المعرّف غير القابل للتغيير لمثيل البيانات الوصفية للمفتاح الخاص.

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

object (KaclsKeyMetadata)

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

بيانات KclsKeyMetadata

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

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

string

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

kaclsData

string

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

الطُرق

create

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

disable

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

enable

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

get

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

list

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

obliterate

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