com.google.api.services.gmail

Class Gmail.Users.Settings.Cse.Keypairs

java.lang.Object

com.google.api.services.gmail.Gmail.Users.Settings.Cse.Keypairs

Enclosing class:

Gmail.Users.Settings.Cse

public class Gmail.Users.Settings.Cse.Keypairs
extends Object

The "keypairs" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Gmail.Users.Settings.Cse.Keypairs.Create
class	Gmail.Users.Settings.Cse.Keypairs.Disable
class	Gmail.Users.Settings.Cse.Keypairs.Enable
class	Gmail.Users.Settings.Cse.Keypairs.Get
class	Gmail.Users.Settings.Cse.Keypairs.List
class	Gmail.Users.Settings.Cse.Keypairs.Obliterate

Constructor Summary

Constructors

Constructor and Description
Keypairs()

Method Summary

Modifier and Type	Method and Description
Gmail.Users.Settings.Cse.Keypairs.Create	create(String userId, CseKeyPair content) Creates and uploads a client-side encryption S/MIME public key certificate chain and private key metadata for the authenticated user.
Gmail.Users.Settings.Cse.Keypairs.Disable	disable(String userId, String keyPairId, DisableCseKeyPairRequest content) Turns off a client-side encryption key pair.
Gmail.Users.Settings.Cse.Keypairs.Enable	enable(String userId, String keyPairId, EnableCseKeyPairRequest content) Turns on a client-side encryption key pair that was turned off.
Gmail.Users.Settings.Cse.Keypairs.Get	get(String userId, String keyPairId) Retrieves an existing client-side encryption key pair.
Gmail.Users.Settings.Cse.Keypairs.List	list(String userId) Lists client-side encryption key pairs for an authenticated user.
Gmail.Users.Settings.Cse.Keypairs.Obliterate	obliterate(String userId, String keyPairId, ObliterateCseKeyPairRequest content) Deletes a client-side encryption key pair permanently and immediately.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Keypairs

public Keypairs()

Method Detail

create

public Gmail.Users.Settings.Cse.Keypairs.Create create(String userId,
                                                       CseKeyPair content)
                                                throws IOException

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](https://developers.google.com/identity/protocols/OAuth2ServiceAccount) 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](https://support.google.com/a/answer/14153163) turned on and configured. Create a request for the method "keypairs.create". This request holds the parameters needed by the gmail server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

userId - The requester's primary email address. To indicate the authenticated user, you can use the special value `me`. [default: me]

content - the CseKeyPair

Returns:

the request

Throws:

IOException

disable

public Gmail.Users.Settings.Cse.Keypairs.Disable disable(String userId,
                                                         String keyPairId,
                                                         DisableCseKeyPairRequest content)
                                                  throws IOException

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](https://developers.google.com/identity/protocols/OAuth2ServiceAccount) 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](https://support.google.com/a/answer/14153163) turned on and configured. Create a request for the method "keypairs.disable". This request holds the parameters needed by the gmail server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

userId - The requester's primary email address. To indicate the authenticated user, you can use the special value `me`. [default: me]

keyPairId - The identifier of the key pair to turn off.

content - the DisableCseKeyPairRequest

Returns:

the request

Throws:

IOException

enable

public Gmail.Users.Settings.Cse.Keypairs.Enable enable(String userId,
                                                       String keyPairId,
                                                       EnableCseKeyPairRequest content)
                                                throws IOException

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](https://developers.google.com/identity/protocols/OAuth2ServiceAccount) 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](https://support.google.com/a/answer/14153163) turned on and configured. Create a request for the method "keypairs.enable". This request holds the parameters needed by the gmail server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

userId - The requester's primary email address. To indicate the authenticated user, you can use the special value `me`. [default: me]

keyPairId - The identifier of the key pair to turn on.

content - the EnableCseKeyPairRequest

Returns:

the request

Throws:

IOException

get

public Gmail.Users.Settings.Cse.Keypairs.Get get(String userId,
                                                 String keyPairId)
                                          throws IOException

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](https://developers.google.com/identity/protocols/OAuth2ServiceAccount) 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](https://support.google.com/a/answer/14153163) turned on and configured. Create a request for the method "keypairs.get". This request holds the parameters needed by the gmail server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

userId - The requester's primary email address. To indicate the authenticated user, you can use the special value `me`. [default: me]

keyPairId - The identifier of the key pair to retrieve.

Returns:

the request

Throws:

IOException

list

public Gmail.Users.Settings.Cse.Keypairs.List list(String userId)
                                            throws IOException

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](https://developers.google.com/identity/protocols/OAuth2ServiceAccount) that has [domain-wide delegation authority](https://developers.google.com/identity/protocols/OAuth2Service Account#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](https://support.google.com/a/answer/14153163) turned on and configured. Create a request for the method "keypairs.list". This request holds the parameters needed by the gmail server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

userId - The requester's primary email address. To indicate the authenticated user, you can use the special value `me`. [default: me]

Returns:

the request

Throws:

IOException

obliterate

public Gmail.Users.Settings.Cse.Keypairs.Obliterate obliterate(String userId,
                                                               String keyPairId,
                                                               ObliterateCseKeyPairRequest content)
                                                        throws IOException

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](https://developers.google.com/identity/protocols/OAuth2ServiceAccount) 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](https://support.google.com/a/answer/14153163) turned on and configured. Create a request for the method "keypairs.obliterate". This request holds the parameters needed by the gmail server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

userId - The requester's primary email address. To indicate the authenticated user, you can use the special value `me`. [default: me]

keyPairId - The identifier of the key pair to obliterate.

content - the ObliterateCseKeyPairRequest

Returns:

the request

Throws:

IOException