REST Resource: users.settings.cse.identities
با مجموعه‌ها، منظم بمانید
ذخیره و طبقه‌بندی محتوا براساس اولویت‌های شما.
منبع: CseIdentity
پیکربندی رمزگذاری سمت مشتری (CSE) برای آدرس ایمیل یک کاربر احراز هویت شده. Gmail از پیکربندی‌های CSE برای ذخیره پیش‌نویس پیام‌های ایمیل رمزگذاری‌شده سمت سرویس گیرنده و امضا و ارسال پیام‌های ایمیل رمزگذاری‌شده استفاده می‌کند.
برای سرپرستانی که هویت و جفت کلید کاربران را در سازمان خود مدیریت می‌کنند، درخواست‌ها نیاز به مجوز با یک حساب خدماتی دارند که دارای اختیارات تفویض اختیار در سراسر دامنه برای جعل هویت کاربران با دامنه 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 ) پیکربندی یک هویت CSE که از جفت کلیدهای مختلف برای امضا و رمزگذاری استفاده می کند. |
SignAndEncryptKeyPairs
پیکربندی یک هویت CSE که از جفت کلیدهای مختلف برای امضا و رمزگذاری استفاده می کند.
| نمایندگی JSON |
|---|
{
"signingKeyPairId": string,
"encryptionKeyPairId": string
} |
| فیلدها |
|---|
signingKeyPairId | string شناسه CseKeyPair که نامه‌های خروجی را امضا می‌کند. |
encryptionKeyPairId | string شناسه CseKeyPair که نامه های خروجی امضا شده را رمزگذاری می کند. |
روش ها |
|---|
| یک هویت رمزگذاری سمت سرویس گیرنده ایجاد و پیکربندی می کند که مجاز به ارسال نامه از حساب کاربری است. |
| هویت رمزگذاری سمت سرویس گیرنده را حذف می کند. |
| پیکربندی هویت رمزگذاری سمت سرویس گیرنده را بازیابی می کند. |
| شناسه های رمزگذاری شده سمت سرویس گیرنده را برای یک کاربر تأیید شده فهرست می کند. |
| یک جفت کلید متفاوت را با هویت رمزگذاری سمت مشتری موجود مرتبط می کند. |
جز در مواردی که غیر از این ذکر شده باشد،محتوای این صفحه تحت مجوز Creative Commons Attribution 4.0 License است. نمونه کدها نیز دارای مجوز Apache 2.0 License است. برای اطلاع از جزئیات، به خطمشیهای سایت Google Developers مراجعه کنید. جاوا علامت تجاری ثبتشده 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. |"]]
