Method: users.settings.cse.keypairs.list
Mantieni tutto organizzato con le raccolte
Salva e classifica i contenuti in base alle tue preferenze.
Elenca le coppie di chiavi di crittografia lato client per un utente autenticato.
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
GET https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/cse/keypairs
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 .
|
Parametri di query
Parametri |
pageToken |
string
Token di paginazione che indica quale pagina di coppie di chiavi restituire. Se il token non viene fornito, l'API restituirà la prima pagina di risultati.
|
pageSize |
integer
Il numero di coppie di chiavi da restituire. Se non viene fornito, il valore predefinito per le dimensioni della pagina è 20 voci.
|
Corpo della richiesta
Il corpo della richiesta deve essere vuoto.
Corpo della risposta
In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:
Rappresentazione JSON |
{
"cseKeyPairs": [
{
object (CseKeyPair )
}
],
"nextPageToken": string
} |
Campi |
cseKeyPairs[] |
object (CseKeyPair )
Una pagina dell'elenco delle coppie di chiavi della crittografia lato client installate per l'utente.
|
nextPageToken |
string
Token di paginazione da passare a una successiva chiamata keypairs.list per recuperare la pagina successiva di coppie di chiavi. Se questo valore non viene restituito, non ci sono altre pagine.
|
Ambiti di autorizzazione
Richiede uno dei seguenti ambiti OAuth:
https://www.googleapis.com/auth/gmail.settings.basic
https://mail.google.com/
https://www.googleapis.com/auth/gmail.modify
https://www.googleapis.com/auth/gmail.readonly
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.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListCseKeyPairsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLists client-side encryption key pairs for an authenticated user.\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`GET https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/cse/keypairs`\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\n### Query parameters\n\n| Parameters ||\n|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageToken` | `string` Pagination token indicating which page of key pairs to return. If the token is not supplied, then the API will return the first page of results. |\n| `pageSize` | `integer` The number of key pairs to return. If not provided, the page size will default to 20 entries. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"cseKeyPairs\": [ { object (/workspace/gmail/api/reference/rest/v1/users.settings.cse.keypairs#CseKeyPair) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `cseKeyPairs[]` | `object (`[CseKeyPair](/workspace/gmail/api/reference/rest/v1/users.settings.cse.keypairs#CseKeyPair)`)` One page of the list of CSE key pairs installed for the user. |\n| `nextPageToken` | `string` Pagination token to be passed to a subsequent keypairs.list call in order to retrieve the next page of key pairs. If this value is not returned, then no further pages remain. |\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://mail.google.com/`\n- `\n https://www.googleapis.com/auth/gmail.modify`\n- `\n https://www.googleapis.com/auth/gmail.readonly`\n- `\n https://www.googleapis.com/auth/gmail.settings.sharing`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]