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

POST

users

Creates and configures a client-side encryption identity that's authorized to send mail from the user account. Google publishes the S/MIME certificate to a shared domain-wide directory so that people within a Google Workspace organization can encrypt and send mail to the identity.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://gmail.googleapis.com//gmail/v1/users//settings/cse/identities' \
--header 'Content-Type: application/json' \
--data-raw ''

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.

Body Params application/json

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.

Examples

Responses

🟢200Successful response

application/json

Body

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

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