Method: users.settings.cse.keypairs.disable
Mantieni tutto organizzato con le raccolte
Salva e classifica i contenuti in base alle tue preferenze.
Disattiva una coppia di chiavi di crittografia lato client. L'utente autenticato non può più utilizzare la coppia di chiavi per decriptare i testi dei messaggi CSE in arrivo o firmare la posta CSE in uscita.
Per riottenere l'accesso, utilizza keypairs.enable per attivare la coppia di chiavi.
Dopo 30 giorni, puoi eliminare definitivamente la coppia di chiavi utilizzando il metodo keypairs.obliterate.
Per gli amministratori che gestiscono le identità e le coppie di chiavi per gli utenti della propria organizzazione, le richieste richiedono l'autorizzazione con un account di servizio che abbia autorità di delega a livello di dominio per rubare l'identità degli utenti con l'ambito https://www.googleapis.com/auth/gmail.settings.basic.
Per gli utenti che gestiscono le proprie identità e le proprie coppie di chiavi, le richieste richiedono l'attivazione e la configurazione della crittografia della chiave hardware.
Richiesta HTTP
POST https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:disable
L'URL utilizza la sintassi di transcodifica gRPC.
Parametri del percorso
| Parametri |
userId |
string
L'indirizzo email principale del richiedente. Per indicare l'utente autenticato, puoi utilizzare il valore speciale me.
|
keyPairId |
string
L'identificatore della coppia di chiavi da disattivare.
|
Corpo della richiesta
Il corpo della richiesta deve essere vuoto.
Corpo della risposta
In caso di esito positivo, il corpo della risposta contiene un'istanza di CseKeyPair.
Ambiti di autorizzazione
Richiede uno dei seguenti ambiti OAuth:
https://www.googleapis.com/auth/gmail.settings.basic
https://www.googleapis.com/auth/gmail.settings.sharing
Per ulteriori informazioni, consulta la Guida all'autorizzazione.
Salvo quando diversamente specificato, i contenuti di questa pagina sono concessi in base alla licenza Creative Commons Attribution 4.0, mentre gli esempi di codice sono concessi in base alla licenza Apache 2.0. Per ulteriori dettagli, consulta le norme del sito di Google Developers. Java è un marchio registrato di Oracle e/o delle sue consociate.
Ultimo aggiornamento 2025-07-25 UTC.
[null,null,["Ultimo aggiornamento 2025-07-25 UTC."],[],[],null,["# Method: users.settings.cse.keypairs.disable\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 off a client-side encryption key pair. The authenticated user can no longer use the key pair to decrypt incoming CSE message texts or sign outgoing CSE mail.\n\nTo regain access, use the [keypairs.enable](/workspace/gmail/api/reference/rest/v1/users.settings.cse.keypairs/enable#caribou.api.proto.MailboxService.EnableCseKeyPair) to turn on the key pair.\n\nAfter 30 days, you can permanently delete the key pair by using the [keypairs.obliterate](/workspace/gmail/api/reference/rest/v1/users.settings.cse.keypairs/obliterate#caribou.api.proto.MailboxService.ObliterateCseKeyPair) method.\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}:disable`\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 off. |\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)."]]
