delete method
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 CreateCseIdentity 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](https://developers.google.com/identity/protocols/OAuth2ServiceAccount#delegatingauthority)
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.
Request parameters:
userId
- The requester's primary email address. To indicate the
authenticated user, you can use the special value me
.
cseEmailAddress
- The primary email address associated with the
client-side encryption identity configuration that's removed.
$fields
- Selector specifying which fields to include in a partial
response.
Completes with a commons.ApiRequestError if the API endpoint returned an error.
If the used http.Client
completes with an error when making a REST call,
this method will complete with the same error.
Implementation
async.Future<void> delete(
core.String userId,
core.String cseEmailAddress, {
core.String? $fields,
}) async {
final queryParams_ = <core.String, core.List<core.String>>{
if ($fields != null) 'fields': [$fields],
};
final url_ =
'gmail/v1/users/' +
commons.escapeVariable('$userId') +
'/settings/cse/identities/' +
commons.escapeVariable('$cseEmailAddress');
await _requester.request(
url_,
'DELETE',
queryParams: queryParams_,
downloadOptions: null,
);
}