gmail.users.settings.cse.keypairs.disable
Disable a client-side encryption key pair to stop its use for decrypting incoming CSE mail or signing outgoing CSE messages; re-enable later or permanently delete after 30 days.
Instructions
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](https://develop [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON DisableCseKeyPairRequest object; pass it via params or whole via body_file Siblings over the same resource: create, enable, get, list, obliterate.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| query | No | Extra KEY=VALUE query pairs for endpoints whose parameters Discovery does not describe. | |
| params | No | Parameter map merged into the request; typed parameters win. | |
| userId | Yes | [URL path segment] The requester's primary email address. To indicate the authenticated user, you can use the special value `me`. | me |
| dry_run | No | Return the request that would be sent, without sending it. | |
| body_file | No | Read the request body from this file ('-' for stdin) instead of building one from the parameters. The body is a JSON DisableCseKeyPairRequest object. | |
| keyPairId | Yes | [URL path segment] The identifier of the key pair to turn off. | |
| request_body | No | Request body of type DisableCseKeyPairRequest: pass it via `params` (merged into the built body) or whole via `body_file`. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| pem | No | ||
| pkcs7 | No | ||
| keyPairId | No | ||
| disableTime | No | ||
| enablementState | No | ||
| privateKeyMetadata | No | ||
| subjectEmailAddresses | No |