REST Resource: users.settings.cse.identities
コレクションでコンテンツを整理
必要に応じて、コンテンツの保存と分類を行います。
リソース: CseIdentity
認証済みユーザーのメールアドレスのクライアントサイド暗号化(CSE)構成。Gmail は CSE 構成を使用して、クライアントサイド暗号化されたメール メッセージの下書きを保存し、暗号化されたメール メッセージを署名して送信します。
組織内のユーザーの ID と鍵ペアを管理する管理者の場合、リクエストには、https://www.googleapis.com/auth/gmail.settings.basic
スコープでユーザーの権限借用を行うためのドメイン全体の委任権限を持つサービス アカウントによる承認が必要です。
独自の ID と鍵ペアを管理しているユーザーの場合、リクエストでハードウェア キー暗号化を有効にして構成する必要があります。
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
送信元の ID のメールアドレス。メールアドレスは、認証されたユーザーのメインのメールアドレスである必要があります。
|
共用体フィールド key_pair_configuration 。 key_pair_configuration は次のいずれかになります。
|
primaryKeyPairId |
string
鍵ペアが関連付けられている場合は、鍵ペアの ID CseKeyPair 。
|
signAndEncryptKeyPairs |
object (SignAndEncryptKeyPairs )
署名と暗号化に異なる鍵ペアを使用する CSE ID の構成。
|
SignAndEncryptKeyPairs
署名と暗号化に異なる鍵ペアを使用する CSE ID の構成。
JSON 表現 |
{
"signingKeyPairId": string,
"encryptionKeyPairId": string
} |
フィールド |
signingKeyPairId |
string
送信メールに署名する CseKeyPair の ID。
|
encryptionKeyPairId |
string
署名付き送信メールを暗号化する CseKeyPair の ID。
|
メソッド |
|
ユーザー アカウントからメールを送信する権限のあるクライアントサイド暗号化 ID を作成して構成します。 |
|
クライアントサイド暗号化 ID を削除します。 |
|
クライアントサイド暗号化の ID 構成を取得します。 |
|
認証されたユーザーのクライアントサイド暗号化された ID を一覧表示します。 |
|
既存のクライアントサイド暗号化 ID に別の鍵ペアを関連付けます。 |
特に記載のない限り、このページのコンテンツはクリエイティブ・コモンズの表示 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. |"]]