Method: users.settings.cse.identities.delete
Deletes a client-side encryption identity. The authenticated user can no longer use the identity to send encrypted messages.
You cannot restore the identity after you delete it. Instead, use the identities.create method to create another identity with the same configuration.
HTTP request
DELETE https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/cse/identities/{cseEmailAddress}
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.
|
cseEmailAddress |
string
The primary email address associated with the client-side encryption identity configuration that's removed.
|
Request body
The request body must be empty.
Response body
If successful, the response body is empty.
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."],[[["Permanently deletes a client-side encryption identity, preventing the authenticated user from sending encrypted messages with it."],["Requires providing the user's primary email address and the email address associated with the identity to be deleted in the request URL."],["The request body should be empty, and a successful deletion results in an empty response body."],["Proper authorization with specific OAuth scopes (`gmail.settings.basic` or `gmail.settings.sharing`) is necessary to perform this action."],["Once deleted, the identity cannot be restored; a new one with the same configuration must be created if needed."]]],["This document outlines how to delete a client-side encryption identity in Gmail. A `DELETE` HTTP request is sent to a specific URL, using `userId` (or \"me\") and `cseEmailAddress` as path parameters. The request body must be empty. A successful deletion results in an empty response body. Deleting an identity is permanent, requiring the creation of a new one. The action needs one of two specified OAuth scopes for authorization.\n"]]
