Method: users.settings.cse.identities.create
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.
HTTP request
POST https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/cse/identities
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 .
|
Request body
The request body contains an instance of CseIdentity
.
Response body
If successful, the response body contains a newly created 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.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-09-04 UTC.
[null,null,["Last updated 2024-09-04 UTC."],[[["Creates and configures a client-side encryption identity authorized to send mail from the user account, with the S/MIME certificate published to a shared directory for organization-wide encrypted communication."],["Uses an HTTP POST request to `https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/cse/identities`, replacing `{userId}` with the user's email address or `me`."],["Requires a request body containing a `CseIdentity` object and returns a `CseIdentity` object upon successful creation."],["Needs authorization with either `https://www.googleapis.com/auth/gmail.settings.basic` or `https://www.googleapis.com/auth/gmail.settings.sharing` scope."]]],[]]