Method: users.settings.cse.keypairs.list

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 turned on and configured.

HTTP request

GET https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/cse/keypairs

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
userId

string

The requester's primary email address. To indicate the authenticated user, you can use the special value me.

Query parameters

Parameters
pageToken

string

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.
pageSize

integer

The number of key pairs to return. If not provided, the page size will default to 20 entries.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

JSON representation 
{
  "cseKeyPairs": [
    {
      object (CseKeyPair)
    }
  ],
  "nextPageToken": string
}
Fields
cseKeyPairs[]

object (CseKeyPair)

One page of the list of CSE key pairs installed for the user.
nextPageToken

string

Pagination token to be passed to a subsequent keypairs.list call in order to retrieve the next page of key pairs. If this value is not returned, then no further pages remain.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/gmail.settings.basic
  • https://mail.google.com/
  • https://www.googleapis.com/auth/gmail.modify
  • https://www.googleapis.com/auth/gmail.readonly
  • https://www.googleapis.com/auth/gmail.settings.sharing

For more information, see the Authorization guide.