Gmail API

/gmail/v1/users/{userId}/settings/cse/identities/{cseEmailAddress}

GET

users

Retrieves a client-side encryption identity configuration.

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

{
  "emailAddress": "string",
  "primaryKeyPairId": "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.

cseEmailAddress

string

required

The primary email address associated with the client-side encryption identity configuration that's retrieved.

Responses

🟢200Successful response

application/json

Body

The client-side encryption (CSE) configuration for the email address of an authenticated user. Gmail uses CSE configurations to save drafts of client-side encrypted email messages, and to sign and send encrypted email messages.

emailAddress

string

optional

The email address for the sending identity. The email address must be the primary email address of the authenticated user.

primaryKeyPairId

string

optional

If a key pair is associated, the identifier of the key pair, CseKeyPair.

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

/gmail/v1/users/{userId}/settings/cse/identities/{cseEmailAddress}

/gmail/v1/users/{userId}/settings/cse/identities/{emailAddress}