Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-137956179.1 KB
users

Creates and uploads a client-side encryption S/MIME public key certificate chain and private key metadata for the 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.

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

Path parameters

userIdstring required

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

Request body

enablementState'stateUnspecified' | 'enabled' | 'disabled'

Output only. The current state of the key pair.

pemstring

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

disableTimestring google-datetime

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.

pkcs7string

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

keyPairIdstring

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

subjectEmailAddressesstring[]

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

Response

Successful response