gmail.users.settings.cse.keypairs.list
Lists client-side encryption key pairs for an authenticated Gmail user, with pagination for managing encryption identities.
Instructions
Lists client-side encryption key pairs for an authenticated user. 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 [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: create, disable, enable, get, 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. | |
| pageSize | No | [query parameter] The number of key pairs to return. If not provided, the page size will default to 20 entries. | 20 |
| body_file | No | Read the request body from this file ('-' for stdin) instead of building one from the parameters. | |
| pageToken | No | [query parameter] Pagination token indicating which page of key pairs to return. If the token is not supplied, then the API will return the first page of results. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| cseKeyPairs | No | ||
| nextPageToken | No |