Class UsersResource.SettingsResource.CseResource.IdentitiesResource

The "identities" collection of methods.

Inheritance
object
UsersResource.SettingsResource.CseResource.IdentitiesResource
Inherited Members
Namespace: Google.Apis.Gmail.v1
Assembly: Google.Apis.Gmail.v1.dll
Syntax
public class UsersResource.SettingsResource.CseResource.IdentitiesResource

Constructors

IdentitiesResource(IClientService)

Constructs a new resource.

Declaration
public IdentitiesResource(IClientService service)
Parameters
Type Name Description
IClientService service

Methods

Create(CseIdentity, string)

Creates and configures a client-side encryption identity that's authorized to send mail from the user account. Google publishes the S/MIME certificate to a shared domain-wide directory so that people within a Google Workspace organization can encrypt and send mail to the identity. 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.IdentitiesResource.CreateRequest Create(CseIdentity body, string userId)
Parameters
Type Name Description
CseIdentity 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.IdentitiesResource.CreateRequest

Delete(string, string)

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 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.IdentitiesResource.DeleteRequest Delete(string userId, string cseEmailAddress)
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 cseEmailAddress

The primary email address associated with the client-side encryption identity configuration that's removed.
Returns
Type Description
UsersResource.SettingsResource.CseResource.IdentitiesResource.DeleteRequest

Get(string, string)

Retrieves a client-side encryption identity 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.

Declaration
public virtual UsersResource.SettingsResource.CseResource.IdentitiesResource.GetRequest Get(string userId, string cseEmailAddress)
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 cseEmailAddress

The primary email address associated with the client-side encryption identity configuration that's retrieved.
Returns
Type Description
UsersResource.SettingsResource.CseResource.IdentitiesResource.GetRequest

List(string)

Lists the client-side encrypted identities 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.IdentitiesResource.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.IdentitiesResource.ListRequest

Patch(CseIdentity, string, string)

Associates a different key pair with an existing client-side encryption identity. The updated key pair must validate against Google's S/MIME certificate profiles. 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.IdentitiesResource.PatchRequest Patch(CseIdentity body, string userId, string emailAddress)
Parameters
Type Name Description
CseIdentity 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 emailAddress

The email address of the client-side encryption identity to update.
Returns
Type Description
UsersResource.SettingsResource.CseResource.IdentitiesResource.PatchRequest