Skip to main content
Glama

gmail.users.settings.cse.keypairs.enable

Reactivates a disabled client-side encryption key pair, making it active again for associated identities.

Instructions

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 that has domain-wide delegation authority to impersonate users with the https://www.googleapis.com/auth/gmail.settings.basic scope. For users [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 EnableCseKeyPairRequest object; pass it via params or whole via body_file Siblings over the same resource: create, disable, get, list, obliterate.

Input Schema

NameRequiredDescriptionDefault
queryNoExtra KEY=VALUE query pairs for endpoints whose parameters Discovery does not describe.
paramsNoParameter map merged into the request; typed parameters win.
userIdYes[URL path segment] The requester's primary email address. To indicate the authenticated user, you can use the special value `me`.me
dry_runNoReturn the request that would be sent, without sending it.
body_fileNoRead the request body from this file ('-' for stdin) instead of building one from the parameters. The body is a JSON EnableCseKeyPairRequest object.
keyPairIdYes[URL path segment] The identifier of the key pair to turn on.
request_bodyNoRequest body of type EnableCseKeyPairRequest: pass it via `params` (merged into the built body) or whole via `body_file`.

Output Schema

NameRequiredDescriptionDefault
pemNo
pkcs7No
keyPairIdNo
disableTimeNo
enablementStateNo
privateKeyMetadataNo
subjectEmailAddressesNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • changedInput schema / properties / body_file / description
      Previous value: -"Read the request body from this file ('-' for stdin) instead of building one from the parameters."New value: +"Read the request body from this file ('-' for stdin) instead of building one from the parameters. The body is a JSON EnableCseKeyPairRequest object."
    • addedInput schema / properties / request_body
      Added value: +{
      +  "description": "Request body of type EnableCseKeyPairRequest: pass it via `params` (merged into the built body) or whole via `body_file`.",
      +  "type": "object"
      +}
  2. Changed4 schema fields changed
    • changedInput schema / properties / keyPairId / description
      Previous value: -"The identifier of the key pair to turn on."New value: +"[URL path segment] The identifier of the key pair to turn on."
    • addedInput schema / properties / userId / default
      Added value: +"me"
    • changedInput schema / properties / userId / description
      Previous value: -"The requester's primary email address. To indicate the authenticated user, you can use the special value `me`."New value: +"[URL path segment] The requester's primary email address. To indicate the authenticated user, you can use the special value `me`."
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "properties": {
      +    "disableTime": {
      +      "type": "string"
      +    },
      +    "enablementState": {
      +      "enum": [
      +        "stateUnspecified",
      +        "enabled",
      +        "disabled"
      +      ],
      +      "type": "string"
      +    },
      +    "keyPairId": {
      +      "type": "string"
      +    },
      +    "pem": {
      +      "type": "string"
      +    },
      +    "pkcs7": {
      +      "type": "string"
      +    },
      +    "privateKeyMetadata": {
      +      "items": {
      +        "properties": {
      +          "hardwareKeyMetadata": {
      +            "properties": {
      +              "description": {
      +                "type": "string"
      +              }
      +            },
      +            "type": "object"
      +          },
      +          "kaclsKeyMetadata": {
      +            "properties": {
      +              "kaclsData": {
      +                "type": "string"
      +              },
      +              "kaclsUri": {
      +                "type": "string"
      +              }
      +            },
      +            "type": "object"
      +          },
      +          "privateKeyMetadataId": {
      +            "type": "string"
      +          }
      +        },
      +        "type": "object"
      +      },
      +      "type": "array"
      +    },
      +    "subjectEmailAddresses": {
      +      "items": {
      +        "type": "string"
      +      },
      +      "type": "array"
      +    }
      +  },
      +  "type": "object"
      +}
  3. First observed

TDQS

A4/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations, the description carries the full burden and does well: it discloses the required service-account/domain-wide-delegation auth and scope, the HTTP POST semantics, that it is refused under --readonly profiles, and the JSON response format. Idempotency and rate-limit behavior are not addressed, keeping it below top marks.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The purpose is front-loaded and every element is substantive, but the text is a run-on that splices auth, HTTP-POST notes, return format, and siblings together, and contains a broken fragment ('For users [HTTP POST]') that hurts readability.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

An output schema exists, so return values needn't be detailed, yet the description still notes the response format. Combined with full auth and safety disclosure for a 7-parameter mutation tool, it is nearly complete, missing only idempotency/error context.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the baseline is 3. The description reinforces how the body is passed (params or body_file) and names the EnableCseKeyPairRequest type, but this largely repeats what the schema already documents.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource: 'Turns on a client-side encryption key pair that was turned off,' plus the resulting effect (becomes active again for associated identities). This clearly distinguishes it from the sibling verbs create, disable, get, list, and obliterate.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The phrase 'that was turned off' implicitly routes agents here as the reversal of the disable sibling, and the sibling list is provided. However, it never explicitly states when to choose this over disable/obliterate, leaving the comparison to inference.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools