REST Resource: users.settings.cse.keypairs

المرجع: CseKeyزوج

يشير ذلك المصطلح إلى زوج مفاتيح 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)

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

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

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