Gmail API

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

GET

users

Retrieves an existing client-side encryption key pair.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://gmail.googleapis.com//gmail/v1/users//settings/cse/keypairs/'

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

userId

string

required

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

keyPairId

string

required

The identifier of the key pair to retrieve.

Responses

🟢200Successful response

application/json

Body

A client-side encryption S/MIME key pair, which is comprised of a public key, its certificate chain, and metadata for its paired private key. Gmail uses the key pair to complete the following tasks: - Sign outgoing client-side encrypted messages. - Save and reopen drafts of client-side encrypted messages. - Save and reopen sent messages. - Decrypt incoming or archived S/MIME messages.

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.

kaclsKeyMetadata

object (KaclsKeyMetadata)

optional

Metadata for a private key instance managed by an external key access control list service.

privateKeyMetadataId

string

read-onlyoptional

Output only. The immutable ID for the private key metadata instance.

subjectEmailAddresses

array[string]

read-onlyoptional

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

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

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

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