Method: users.settings.cse.identities.patch
Mit Sammlungen den Überblick behalten
Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.
Hiermit wird einer vorhandenen Identität für die clientseitige Verschlüsselung ein anderes Schlüsselpaar zugewiesen. Das aktualisierte Schlüsselpaar muss anhand der S/MIME-Zertifikatprofile von Google validiert werden.
Für Administratoren, die Identitäten und Schlüsselpaare für Nutzer in ihrer Organisation verwalten, ist für Anfragen eine Autorisierung mit einem Dienstkonto erforderlich, das domainweite Bevollmächtigung zur Identitätsübernahme von Nutzern mit dem Umfang https://www.googleapis.com/auth/gmail.settings.basic
hat.
Für Nutzer, die ihre eigenen Identitäten und Schlüsselpaare verwalten, muss die Hardwareschlüsselverschlüsselung aktiviert und konfiguriert sein.
HTTP-Anfrage
PATCH https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/cse/identities/{emailAddress}
Die URL verwendet die Syntax der gRPC-Transcodierung.
Pfadparameter
Parameter |
userId |
string
Die primäre E-Mail-Adresse des Antragstellers. Sie können den speziellen Wert me verwenden, um den authentifizierten Nutzer anzugeben.
|
emailAddress |
string
Die E-Mail-Adresse der Identität für die clientseitige Verschlüsselung, die aktualisiert werden soll.
|
Anfragetext
Der Anfragetext enthält eine Instanz von CseIdentity
.
Antworttext
Wenn der Vorgang erfolgreich abgeschlossen wurde, enthält der Antworttext eine Instanz von CseIdentity
.
Autorisierungsbereiche
Erfordert einen der folgenden OAuth-Bereiche:
https://www.googleapis.com/auth/gmail.settings.basic
https://www.googleapis.com/auth/gmail.settings.sharing
Weitere Informationen finden Sie im Leitfaden zur Autorisierung.
Sofern nicht anders angegeben, sind die Inhalte dieser Seite unter der Creative Commons Attribution 4.0 License und Codebeispiele unter der Apache 2.0 License lizenziert. Weitere Informationen finden Sie in den Websiterichtlinien von Google Developers. Java ist eine eingetragene Marke von Oracle und/oder seinen Partnern.
Zuletzt aktualisiert: 2025-07-25 (UTC).
[null,null,["Zuletzt aktualisiert: 2025-07-25 (UTC)."],[],[],null,["# Method: users.settings.cse.identities.patch\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nAssociates a different key pair with an existing client-side encryption identity. The updated key pair must validate against Google's [S/MIME certificate profiles](https://support.google.com/a/answer/7300887).\n\nFor administrators managing identities and keypairs for users in their organization, requests require authorization with a [service account](https://developers.google.com/identity/protocols/OAuth2ServiceAccount) that has [domain-wide delegation authority](https://developers.google.com/identity/protocols/OAuth2ServiceAccount#delegatingauthority) to impersonate users with the `https://www.googleapis.com/auth/gmail.settings.basic` scope.\n\nFor users managing their own identities and keypairs, requests require [hardware key encryption](https://support.google.com/a/answer/14153163) turned on and configured.\n\n### HTTP request\n\n`PATCH https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/cse/identities/{emailAddress}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------------|-------------------------------------------------------------------------------------------------------------------------|\n| `userId` | `string` The requester's primary email address. To indicate the authenticated user, you can use the special value `me`. |\n| `emailAddress` | `string` The email address of the client-side encryption identity to update. |\n\n### Request body\n\nThe request body contains an instance of [CseIdentity](/workspace/gmail/api/reference/rest/v1/users.settings.cse.identities#CseIdentity).\n\n### Response body\n\nIf successful, the response body contains an instance of [CseIdentity](/workspace/gmail/api/reference/rest/v1/users.settings.cse.identities#CseIdentity).\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/gmail.settings.basic`\n- `\n https://www.googleapis.com/auth/gmail.settings.sharing`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]