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 שמצפין את האימייל היוצא החתום.
|
Methods |
|
|
יצירת זהות של הצפנה מצד הלקוח והגדרתה, עם הרשאה לשלוח אימייל מחשבון המשתמש. |
|
|
מחיקה של זהות של הצפנה מצד הלקוח. |
|
|
אחזור של הגדרת זהות של הצפנה מצד הלקוח. |
|
|
הצגת הזהויות המוצפנות מצד הלקוח של משתמש מאומת. |
|
|
שיוך של זוג מפתחות אחר לזהות קיימת של הצפנה מצד הלקוח. |
אלא אם צוין אחרת, התוכן של דף זה הוא ברישיון Creative Commons Attribution 4.0 ודוגמאות הקוד הן ברישיון Apache 2.0. לפרטים, ניתן לעיין במדיניות האתר Google Developers. Java הוא סימן מסחרי רשום של חברת Oracle ו/או של השותפים העצמאיים שלה.
עדכון אחרון: 2025-07-25 (שעון UTC).
[null,null,["עדכון אחרון: 2025-07-25 (שעון UTC)."],[],[],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. |"]]
