/gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:disable

POST

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.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://gmail.googleapis.com//gmail/v1/users//settings/cse/keypairs/:disable' \
--header 'Content-Type: application/json' \
--data-raw '{}'

Response Example

{
    "disableTime": "string",
    "enablementState": "stateUnspecified",
    "keyPairId": "string",
    "pem": "string",
    "pkcs7": "string",
    "privateKeyMetadata": [
        {
            "kaclsKeyMetadata": {
                "kaclsData": "string",
                "kaclsUri": "string"
            },
            "privateKeyMetadataId": "string"
        }
    ],
    "subjectEmailAddresses": [
        "string"
    ]
}

Request

Path Params

Body Params application/json

Examples

Responses

🟢200Successful response

application/json

Body

Modified at 2023-08-15 05:40:23

/gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}

/gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:enable