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.
For administrators managing identities and keypairs for users in their organization, requests require authorization with a service account that has domain-wide delegation authority to impersonate users with the https://www.googleapis.com/auth/gmail.settings.basic
scope.
For users managing their own identities and keypairs, requests require hardware key encryption turned on and configured.
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 |
The requester's primary email address. To indicate the authenticated user, you can use the special value |
cseEmailAddress |
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 an empty JSON object.
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.