Method: users.settings.cse.keypairs.enable
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
Active une paire de clés de chiffrement côté client qui était désactivée. La paire de clés redevient active pour toutes les identités de chiffrement côté client associées.
Pour les administrateurs qui gèrent les identités et les paires de clés des utilisateurs de leur organisation, les demandes nécessitent une autorisation avec un compte de service disposant d'une autorité de délégation au niveau du domaine pour usurper l'identité des utilisateurs avec le champ d'application https://www.googleapis.com/auth/gmail.settings.basic.
Pour les utilisateurs qui gèrent leurs propres identités et paires de clés, les demandes nécessitent que le chiffrement par clé matérielle soit activé et configuré.
Requête HTTP
POST https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:enable
L'URL utilise la syntaxe de transcodage gRPC.
Paramètres de chemin d'accès
| Paramètres |
userId |
string
Adresse e-mail principale de la personne à l'origine de la demande. Pour indiquer l'utilisateur authentifié, vous pouvez utiliser la valeur spéciale me.
|
keyPairId |
string
Identifiant de la paire de clés à activer.
|
Corps de la requête
Le corps de la requête doit être vide.
Corps de la réponse
Si la requête aboutit, le corps de la réponse contient une instance de CseKeyPair.
Champs d'application des autorisations
Nécessite l'un des champs d'application OAuth suivants :
https://www.googleapis.com/auth/gmail.settings.basic
https://www.googleapis.com/auth/gmail.settings.sharing
Pour en savoir plus, consultez le guide d'autorisation.
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/07/25 (UTC).
[null,null,["Dernière mise à jour le 2025/07/25 (UTC)."],[],[],null,["# Method: users.settings.cse.keypairs.enable\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\nTurns on a client-side encryption key pair that was turned off. The key pair becomes active again for any associated client-side encryption identities.\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`POST https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:enable`\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| `keyPairId` | `string` The identifier of the key pair to turn on. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains an instance of [CseKeyPair](/workspace/gmail/api/reference/rest/v1/users.settings.cse.keypairs#CseKeyPair).\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)."]]
