Method: users.settings.cse.identities.list
Mit Sammlungen den Überblick behalten
Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.
Listet die clientseitig verschlüsselten Identitäten für einen authentifizierten Nutzer auf.
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
GET https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/cse/identities
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.
|
Abfrageparameter
| Parameter |
pageToken |
string
Paginierungstoken, das angibt, welche Seite mit Identitäten zurückgegeben werden soll. Wenn das Token nicht angegeben wird, gibt die API die erste Ergebnisseite zurück.
|
pageSize |
integer
Die Anzahl der zurückzugebenden Identitäten. Wenn keine Angabe erfolgt, wird standardmäßig eine Seitengröße von 20 Einträgen verwendet.
|
Anfragetext
Der Anfragetext muss leer sein.
Antworttext
Wenn der Vorgang erfolgreich ist, enthält der Antworttext Daten mit folgender Struktur:
| JSON-Darstellung |
{
"cseIdentities": [
{
object (CseIdentity)
}
],
"nextPageToken": string
} |
| Felder |
cseIdentities[] |
object (CseIdentity)
Eine Seite der Liste der für den Nutzer konfigurierten Identitäten für die clientseitige Verschlüsselung.
|
nextPageToken |
string
Paginierungstoken, das an einen nachfolgenden Aufruf von „identities.list“ übergeben wird, um die nächste Seite mit Identitäten abzurufen. Wenn dieser Wert nicht zurückgegeben wird oder der leere String ist, gibt es keine weiteren Seiten.
|
Autorisierungsbereiche
Erfordert einen der folgenden OAuth-Bereiche:
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
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.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.ListCseIdentitiesResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLists the client-side encrypted identities 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/identities`\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 identities to return. If the token is not supplied, then the API will return the first page of results. |\n| `pageSize` | `integer` The number of identities 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| ``` { \"cseIdentities\": [ { object (/workspace/gmail/api/reference/rest/v1/users.settings.cse.identities#CseIdentity) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `cseIdentities[]` | `object (`[CseIdentity](/workspace/gmail/api/reference/rest/v1/users.settings.cse.identities#CseIdentity)`)` One page of the list of CSE identities configured for the user. |\n| `nextPageToken` | `string` Pagination token to be passed to a subsequent identities.list call in order to retrieve the next page of identities. If this value is not returned or is the empty string, 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)."]]
