Method: users.settings.cse.keypairs.list
Zadbaj o dobrą organizację dzięki kolekcji
Zapisuj i kategoryzuj treści zgodnie ze swoimi preferencjami.
Wyświetla pary kluczy szyfrowania po stronie klienta dla uwierzytelnionego użytkownika.
W przypadku administratorów zarządzających tożsamościami i parami kluczy użytkowników w organizacji prośby wymagają autoryzacji konta usługi, które ma uprawnienia do delegowania uprawnień w całej domenie, aby podszywać się pod użytkowników w zakresie https://www.googleapis.com/auth/gmail.settings.basic
.
W przypadku użytkowników zarządzających własnymi tożsamościami i parami kluczy żądania wymagają włączenia i skonfigurowania szyfrowania za pomocą klucza sprzętowego.
Żądanie HTTP
GET https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/cse/keypairs
Adres URL używa składni transkodowania gRPC.
Parametry ścieżki
Parametry |
userId |
string
Podstawowy adres e-mail osoby, która wysłała prośbę. Aby wskazać uwierzytelnionego użytkownika, możesz użyć wartości specjalnej me .
|
Parametry zapytania
Parametry |
pageToken |
string
Token strony, który wskazuje, która strona z parami kluczy ma zostać zwrócona. Jeśli token nie zostanie podany, interfejs API zwróci pierwszą stronę wyników.
|
pageSize |
integer
Liczba par kluczy do zwrócenia. Jeśli nie podasz tej wartości, domyślnie zostanie użyta liczba 20.
|
Treść żądania
Treść żądania musi być pusta.
Treść odpowiedzi
W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:
Zapis JSON |
{
"cseKeyPairs": [
{
object (CseKeyPair )
}
],
"nextPageToken": string
} |
Pola |
cseKeyPairs[] |
object (CseKeyPair )
Jedna strona listy par kluczy szyfrowania po stronie klienta zainstalowanych u użytkownika.
|
nextPageToken |
string
Token strony, który należy przekazać do kolejnego wywołania keypairs.list, aby pobrać kolejną stronę par kluczy. Jeśli ta wartość nie zostanie zwrócona, nie ma kolejnych stron.
|
Zakresy autoryzacji
Wymaga jednego z tych zakresów 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
Więcej informacji znajdziesz w przewodniku po autoryzacji.
O ile nie stwierdzono inaczej, treść tej strony jest objęta licencją Creative Commons – uznanie autorstwa 4.0, a fragmenty kodu są dostępne na licencji Apache 2.0. Szczegółowe informacje na ten temat zawierają zasady dotyczące witryny Google Developers. Java jest zastrzeżonym znakiem towarowym firmy Oracle i jej podmiotów stowarzyszonych.
Ostatnia aktualizacja: 2025-07-25 UTC.
[null,null,["Ostatnia aktualizacja: 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)."]]