UsersSettingsCseKeypairs
class UsersSettingsCseKeypairs extends Resource (View source)
The "keypairs" collection of methods.
Typical usage is:
$gmailService = new Google\Service\Gmail(...);
$keypairs = $gmailService->users_settings_cse_keypairs;Methods
Creates and uploads a client-side encryption S/MIME public key certificate chain and private key metadata for the authenticated user. (keypairs.create)
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. (keypairs.disable)
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.
Retrieves an existing client-side encryption key pair. (keypairs.get)
Lists client-side encryption key pairs for an authenticated user.
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. (keypairs.obliterate)
Details
CseKeyPair
create(string $userId, CseKeyPair $postBody, array $optParams = [])
Creates and uploads a client-side encryption S/MIME public key certificate chain and private key metadata for the authenticated user. (keypairs.create)
CseKeyPair
disable(string $userId, string $keyPairId, DisableCseKeyPairRequest $postBody, array $optParams = [])
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. (keypairs.disable)
CseKeyPair
enable(string $userId, string $keyPairId, EnableCseKeyPairRequest $postBody, array $optParams = [])
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.
(keypairs.enable)
CseKeyPair
get(string $userId, string $keyPairId, array $optParams = [])
Retrieves an existing client-side encryption key pair. (keypairs.get)
ListCseKeyPairsResponse
listUsersSettingsCseKeypairs(string $userId, array $optParams = [])
Lists client-side encryption key pairs for an authenticated user.
(keypairs.listUsersSettingsCseKeypairs)
obliterate(string $userId, string $keyPairId, ObliterateCseKeyPairRequest $postBody, array $optParams = [])
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. (keypairs.obliterate)