Class UsersResource.SettingsResource.CseResource.KeypairsResource.ObliterateRequest
Deletes a client-side encryption key pair permanently and immediately. You can only permanently
delete key pairs that have been turned off for more than 30 days. To turn off a key pair, use
the DisableCseKeyPair method. Gmail can't restore or decrypt any messages that were encrypted by
an obliterated key. Authenticated users and Google Workspace administrators lose access to
reading the encrypted messages. 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.
Inheritance
Inherited Members
Namespace: Google.Apis.Gmail.v1
Assembly: Google.Apis.Gmail.v1.dll
Syntax
public class UsersResource.SettingsResource.CseResource.KeypairsResource.ObliterateRequest : GmailBaseServiceRequest<string>, IClientServiceRequest<string>, IClientServiceRequest
Constructors
ObliterateRequest(IClientService, ObliterateCseKeyPairRequest, string, string)
Constructs a new Obliterate request.
Declaration
public ObliterateRequest(IClientService service, ObliterateCseKeyPairRequest body, string userId, string keyPairId)
Parameters
| Type | Name | Description |
|---|---|---|
| IClientService | service | |
| ObliterateCseKeyPairRequest | body | |
| string | userId | |
| string | keyPairId |
Properties
HttpMethod
Gets the HTTP method.
Declaration
public override string HttpMethod { get; }
Property Value
| Type | Description |
|---|---|
| string |
Overrides
KeyPairId
The identifier of the key pair to obliterate.
Declaration
[RequestParameter("keyPairId", RequestParameterType.Path)]
public virtual string KeyPairId { get; }
Property Value
| Type | Description |
|---|---|
| string |
MethodName
Gets the method name.
Declaration
public override string MethodName { get; }
Property Value
| Type | Description |
|---|---|
| string |
Overrides
RestPath
Gets the REST path.
Declaration
public override string RestPath { get; }
Property Value
| Type | Description |
|---|---|
| string |
Overrides
UserId
The requester's primary email address. To indicate the authenticated user, you can use the
special value me.
Declaration
[RequestParameter("userId", RequestParameterType.Path)]
public virtual string UserId { get; }
Property Value
| Type | Description |
|---|---|
| string |
Methods
GetBody()
Returns the body of the request.
Declaration
protected override object GetBody()
Returns
| Type | Description |
|---|---|
| object |
Overrides
InitParameters()
Initializes Obliterate parameter list.
Declaration
protected override void InitParameters()