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 keypairs.enable to turn on the key pair.
After 30 days, you can permanently delete the key pair by using the keypairs.obliterate 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.
HTTP request
POST https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:disable
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters | |
|---|---|
userId |
The requester's primary email address. To indicate the authenticated user, you can use the special value |
keyPairId |
The identifier of the key pair to turn off. |
Request body
The request body must be empty.
Response body
If successful, the response body contains an instance of CseKeyPair.
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/gmail.settings.basichttps://www.googleapis.com/auth/gmail.settings.sharing
For more information, see the Authorization guide.