Method: users.settings.cse.identities.patch
Associates a different key pair with an existing client-side encryption identity. The updated key pair must validate against Google's S/MIME certificate profiles.
HTTP request
PATCH https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/cse/identities/{emailAddress}
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
userId |
string
The requester's primary email address. To indicate the authenticated user, you can use the special value me.
|
emailAddress |
string
The email address of the client-side encryption identity to update.
|
Request body
The request body contains an instance of CseIdentity.
Response body
If successful, the response body contains an instance of CseIdentity.
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/gmail.settings.basic
https://www.googleapis.com/auth/gmail.settings.sharing
For more information, see the Authorization guide.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-09-04 UTC.
[null,null,["Last updated 2024-09-04 UTC."],[[["This operation updates the key pair associated with an existing client-side encryption identity for a user in Gmail."],["The updated key pair must meet Google's S/MIME certificate profile requirements."],["You need to provide the user's email address and the email address of the client-side encryption identity to update."],["The request requires specific authorization scopes related to Gmail settings."],["A successful update returns the updated client-side encryption identity details."]]],["This describes how to update an existing client-side encryption identity with a new key pair via a `PATCH` request to `https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/cse/identities/{emailAddress}`. The `userId` and `emailAddress` are specified as path parameters. The request body must contain a `CseIdentity` instance. A successful update returns a `CseIdentity` instance in the response. Authorization requires either the `gmail.settings.basic` or `gmail.settings.sharing` OAuth scope. The new key pair must align with Google's S/MIME certificate profiles.\n"]]
