Class UsersResource.SettingsResource.CseResource.KeypairsResource

The "keypairs" collection of methods.

Inheritance

object

UsersResource.SettingsResource.CseResource.KeypairsResource

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.Gmail.v1

Assembly: Google.Apis.Gmail.v1.dll

Syntax

public class UsersResource.SettingsResource.CseResource.KeypairsResource

Constructors

KeypairsResource(IClientService)

Constructs a new resource.

Declaration

public KeypairsResource(IClientService service)

Parameters

Type	Name	Description
IClientService	service

Methods

Create(CseKeyPair, string)

Creates and uploads a client-side encryption S/MIME public key certificate chain and private key metadata for the authenticated user. 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.

Declaration

public virtual UsersResource.SettingsResource.CseResource.KeypairsResource.CreateRequest Create(CseKeyPair body, string userId)

Parameters

Type	Name	Description
CseKeyPair	body	The body of the request.
string	userId	The requester's primary email address. To indicate the authenticated user, you can use the special value me.

Returns

Type	Description
UsersResource.SettingsResource.CseResource.KeypairsResource.CreateRequest

Disable(DisableCseKeyPairRequest, string, string)

Turns off a client-side encryption key pair. The authenticated user can no longer use the key pair to decrypt incoming CSE message texts or sign outgoing CSE mail. To regain access, use the EnableCseKeyPair to turn on the key pair. After 30 days, you can permanently delete the key pair by using the ObliterateCseKeyPair method. 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.

Declaration

public virtual UsersResource.SettingsResource.CseResource.KeypairsResource.DisableRequest Disable(DisableCseKeyPairRequest body, string userId, string keyPairId)

Parameters

Type	Name	Description
DisableCseKeyPairRequest	body	The body of the request.
string	userId	The requester's primary email address. To indicate the authenticated user, you can use the special value me.
string	keyPairId	The identifier of the key pair to turn off.

Returns

Type	Description
UsersResource.SettingsResource.CseResource.KeypairsResource.DisableRequest

Enable(EnableCseKeyPairRequest, string, string)

Turns on a client-side encryption key pair that was turned off. The key pair becomes active again for any associated client-side encryption identities. 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.

Declaration

public virtual UsersResource.SettingsResource.CseResource.KeypairsResource.EnableRequest Enable(EnableCseKeyPairRequest body, string userId, string keyPairId)

Parameters

Type	Name	Description
EnableCseKeyPairRequest	body	The body of the request.
string	userId	The requester's primary email address. To indicate the authenticated user, you can use the special value me.
string	keyPairId	The identifier of the key pair to turn on.

Returns

Type	Description
UsersResource.SettingsResource.CseResource.KeypairsResource.EnableRequest

Get(string, string)

Retrieves an existing client-side encryption key pair. 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.

Declaration

public virtual UsersResource.SettingsResource.CseResource.KeypairsResource.GetRequest Get(string userId, string keyPairId)

Parameters

Type	Name	Description
string	userId	The requester's primary email address. To indicate the authenticated user, you can use the special value me.
string	keyPairId	The identifier of the key pair to retrieve.

Returns

Type	Description
UsersResource.SettingsResource.CseResource.KeypairsResource.GetRequest

List(string)

Lists client-side encryption key pairs for an authenticated user. 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.

Declaration

public virtual UsersResource.SettingsResource.CseResource.KeypairsResource.ListRequest List(string userId)

Parameters

Type	Name	Description
string	userId	The requester's primary email address. To indicate the authenticated user, you can use the special value me.

Returns

Type	Description
UsersResource.SettingsResource.CseResource.KeypairsResource.ListRequest

Obliterate(ObliterateCseKeyPairRequest, string, string)

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.

Declaration

public virtual UsersResource.SettingsResource.CseResource.KeypairsResource.ObliterateRequest Obliterate(ObliterateCseKeyPairRequest body, string userId, string keyPairId)

Parameters

Type	Name	Description
ObliterateCseKeyPairRequest	body	The body of the request.
string	userId	The requester's primary email address. To indicate the authenticated user, you can use the special value me.
string	keyPairId	The identifier of the key pair to obliterate.

Returns

Type	Description
UsersResource.SettingsResource.CseResource.KeypairsResource.ObliterateRequest