REST Resource: users.settings.cse.identities
تنظيم صفحاتك في مجموعات
يمكنك حفظ المحتوى وتصنيفه حسب إعداداتك المفضّلة.
المورد: CseIdentity
إعدادات ميزة "التشفير من جهة العميل" لعنوان البريد الإلكتروني لمستخدم تم مصادقة هويته يستخدم Gmail إعدادات ميزة "التشفير من جهة العميل" لحفظ مسودات الرسائل الإلكترونية المشفَّرة من جهة العميل ولتوقيع الرسائل الإلكترونية المشفَّرة وإرسالها.
بالنسبة إلى المشرفين الذين يديرون هويات المستخدمين ومجموعات المفاتيح الخاصة بهم في مؤسستهم، تتطلّب الطلبات الحصول على تفويض من خلال حساب خدمة يمتلك سلطة تفويض على مستوى النطاق لانتحال هوية المستخدمين باستخدام نطاق https://www.googleapis.com/auth/gmail.settings.basic.
بالنسبة إلى المستخدمين الذين يديرون هوياتهم ومفاتيحهم الخاصة، تتطلّب الطلبات تفعيل ميزة تشفير مفتاح الجهاز وضبطها.
| تمثيل JSON |
{
"emailAddress": string,
// Union field key_pair_configuration can be only one of the following:
"primaryKeyPairId": string,
"signAndEncryptKeyPairs": {
object (SignAndEncryptKeyPairs)
}
// End of list of possible types for union field key_pair_configuration.
} |
| الحقول |
emailAddress |
string
عنوان البريد الإلكتروني لجهة الإرسال. يجب أن يكون عنوان البريد الإلكتروني هو عنوان البريد الإلكتروني الأساسي للمستخدم الذي تم مصادقة هويته.
|
حقل الربط key_pair_configuration يمكن أن يكون key_pair_configuration واحدًا فقط مما يلي: |
primaryKeyPairId |
string
إذا كان هناك مفتاح تشفير مرتبط، يُرجى إدخال معرّف مفتاح التشفير، CseKeyPair.
|
signAndEncryptKeyPairs |
object (SignAndEncryptKeyPairs)
إعداد هوية "التشفير من جهة العميل" التي تستخدِم أزواج مفاتيح مختلفة للتوقيع والتشفير
|
SignAndEncryptKeyPairs
إعداد هوية "التشفير من جهة العميل" التي تستخدِم أزواج مفاتيح مختلفة للتوقيع والتشفير
| تمثيل JSON |
{
"signingKeyPairId": string,
"encryptionKeyPairId": string
} |
| الحقول |
signingKeyPairId |
string
معرّف CseKeyPair الذي يوقّع الرسائل الصادرة.
|
encryptionKeyPairId |
string
رقم تعريف CseKeyPair الذي يشفِّر الرسائل الإلكترونية الصادرة الموقَّعة.
|
الطُرق |
|
|
إنشاء هوية "التشفير من جهة العميل" وضبطها، وهي هوية مفوَّضة لإرسال البريد من حساب المستخدم |
|
|
لحذف هوية تشفير من جهة العميل |
|
|
يسترجع إعدادات هوية التشفير من جهة العميل. |
|
|
يسرد العناصر المشفّرة من جهة العميل لمستخدم تمّت مصادقة هويته. |
|
|
ربط مفتاحَي تشفير مختلفَين بهوية حالية للتشفير من جهة العميل |
إنّ محتوى هذه الصفحة مرخّص بموجب ترخيص Creative Commons Attribution 4.0 ما لم يُنصّ على خلاف ذلك، ونماذج الرموز مرخّصة بموجب ترخيص Apache 2.0. للاطّلاع على التفاصيل، يُرجى مراجعة سياسات موقع Google Developers. إنّ Java هي علامة تجارية مسجَّلة لشركة Oracle و/أو شركائها التابعين.
تاريخ التعديل الأخير: 2025-07-25 (حسب التوقيت العالمي المتفَّق عليه)
[null,null,["تاريخ التعديل الأخير: 2025-07-25 (حسب التوقيت العالمي المتفَّق عليه)"],[],[],null,["# REST Resource: users.settings.cse.identities\n\n- [Resource: CseIdentity](#CseIdentity)\n - [JSON representation](#CseIdentity.SCHEMA_REPRESENTATION)\n- [SignAndEncryptKeyPairs](#SignAndEncryptKeyPairs)\n - [JSON representation](#SignAndEncryptKeyPairs.SCHEMA_REPRESENTATION)\n- [Methods](#METHODS_SUMMARY)\n\nResource: CseIdentity\n---------------------\n\nThe client-side encryption (CSE) configuration for the email address of an authenticated user. Gmail uses CSE configurations to save drafts of client-side encrypted email messages, and to sign and send encrypted email messages.\n\nFor administrators managing identities and keypairs for users in their organization, requests require authorization with a [service account](https://developers.google.com/identity/protocols/OAuth2ServiceAccount) that has [domain-wide delegation authority](https://developers.google.com/identity/protocols/OAuth2ServiceAccount#delegatingauthority) to impersonate users with the `https://www.googleapis.com/auth/gmail.settings.basic` scope.\n\nFor users managing their own identities and keypairs, requests require [hardware key encryption](https://support.google.com/a/answer/14153163) turned on and configured.\n\n| JSON representation |\n|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"emailAddress\": string, // Union field `key_pair_configuration` can be only one of the following: \"primaryKeyPairId\": string, \"signAndEncryptKeyPairs\": { object (/workspace/gmail/api/reference/rest/v1/users.settings.cse.identities#SignAndEncryptKeyPairs) } // End of list of possible types for union field `key_pair_configuration`. } ``` |\n\n| Fields ||\n|--------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `emailAddress` | `string` The email address for the sending identity. The email address must be the primary email address of the authenticated user. |\n| Union field `key_pair_configuration`. `key_pair_configuration` can be only one of the following: ||\n| `primaryKeyPairId` | `string` If a key pair is associated, the ID of the key pair, [CseKeyPair](/workspace/gmail/api/reference/rest/v1/users.settings.cse.keypairs#CseKeyPair). |\n| `signAndEncryptKeyPairs` | `object (`[SignAndEncryptKeyPairs](/workspace/gmail/api/reference/rest/v1/users.settings.cse.identities#SignAndEncryptKeyPairs)`)` The configuration of a CSE identity that uses different key pairs for signing and encryption. |\n\nSignAndEncryptKeyPairs\n----------------------\n\nThe configuration of a CSE identity that uses different key pairs for signing and encryption.\n\n| JSON representation |\n|-----------------------------------------------------------------------|\n| ``` { \"signingKeyPairId\": string, \"encryptionKeyPairId\": string } ``` |\n\n| Fields ||\n|-----------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `signingKeyPairId` | `string` The ID of the [CseKeyPair](/workspace/gmail/api/reference/rest/v1/users.settings.cse.keypairs#CseKeyPair) that signs outgoing mail. |\n| `encryptionKeyPairId` | `string` The ID of the [CseKeyPair](/workspace/gmail/api/reference/rest/v1/users.settings.cse.keypairs#CseKeyPair) that encrypts signed outgoing mail. |\n\n| Methods ------- ||\n|-------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------|\n| ### [create](/workspace/gmail/api/reference/rest/v1/users.settings.cse.identities/create) | Creates and configures a client-side encryption identity that's authorized to send mail from the user account. |\n| ### [delete](/workspace/gmail/api/reference/rest/v1/users.settings.cse.identities/delete) | Deletes a client-side encryption identity. |\n| ### [get](/workspace/gmail/api/reference/rest/v1/users.settings.cse.identities/get) | Retrieves a client-side encryption identity configuration. |\n| ### [list](/workspace/gmail/api/reference/rest/v1/users.settings.cse.identities/list) | Lists the client-side encrypted identities for an authenticated user. |\n| ### [patch](/workspace/gmail/api/reference/rest/v1/users.settings.cse.identities/patch) | Associates a different key pair with an existing client-side encryption identity. |"]]
