Method: users.settings.cse.identities.patch

Associates a different key pair with an existing client-side encryption identity. The updated key pair must validate against Google's S/MIME certificate profiles.

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.

HTTP request

PATCH https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/cse/identities/{emailAddress}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
userId

string

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

string

The email address of the client-side encryption identity to update.

Request body

The request body contains an instance of CseIdentity.

Response body

If successful, the response body contains an instance of CseIdentity.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/gmail.settings.basic
  • https://www.googleapis.com/auth/gmail.settings.sharing

For more information, see the Authorization guide.