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 ที่เข้ารหัสจดหมายขาออกที่ลงนาม
|
เมธอด |
|
|
สร้างและกําหนดค่าข้อมูลระบุตัวตนการเข้ารหัสฝั่งไคลเอ็นต์ที่ได้รับสิทธิ์ให้ส่งอีเมลจากบัญชีผู้ใช้ |
|
|
ลบข้อมูลประจำตัวการเข้ารหัสฝั่งไคลเอ็นต์ |
|
|
ดึงข้อมูลการกำหนดค่าข้อมูลประจำตัวการเข้ารหัสฝั่งไคลเอ็นต์ |
|
|
แสดงข้อมูลประจำตัวที่เข้ารหัสฝั่งไคลเอ็นต์สําหรับผู้ใช้ที่ผ่านการตรวจสอบสิทธิ์ |
|
|
เชื่อมโยงคู่คีย์อื่นกับข้อมูลประจำตัวการเข้ารหัสฝั่งไคลเอ็นต์ที่มีอยู่ |
เนื้อหาของหน้าเว็บนี้ได้รับอนุญาตภายใต้ใบอนุญาตที่ต้องระบุที่มาของครีเอทีฟคอมมอนส์ 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. |"]]
