Gmail API

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

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

Lists client-side encryption key pairs for an authenticated user.

Request

Path Params

userId

string

required

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

Query Params

pageSize

integer

optional

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

pageToken

string

optional

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.

Request samples

Responses

Successful response(200)

Successful response

HTTP Code: 200

Content Type : JSONapplication/json

cseKeyPairs

array[object (CseKeyPair) {7}]

optional

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

disableTime

string <google-datetime>

read-onlyoptional

Output only. If a key pair is set to DISABLED, the time that the key pair's state changed from ENABLED to DISABLED. This field is present only when the key pair is in state DISABLED.

enablementState

enum<string>

read-onlyoptional

Output only. The current state of the key pair.

Allowed values:

stateUnspecifiedenableddisabled

keyPairId

string

read-onlyoptional

Output only. The immutable ID for the client-side encryption S/MIME key pair.

pem

string

read-onlyoptional

Output only. The public key and its certificate chain, in PEM format.

pkcs7

string

optional

Input only. The public key and its certificate chain. The chain must be in PKCS#7 format and use PEM encoding and ASCII armor.

privateKeyMetadata

array[object (CsePrivateKeyMetadata) {2}]

optional

Metadata for instances of this key pair's private key.

subjectEmailAddresses

array[string]

read-onlyoptional

Output only. The email address identities that are specified on the leaf certificate.

nextPageToken

string

optional

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

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

Last modified: a year ago