Method: users.settings.cse.identities.list
Organiza tus páginas con colecciones
Guarda y categoriza el contenido según tus preferencias.
Muestra una lista de las identidades encriptadas del cliente para un usuario autenticado.
En el caso de los administradores que administran identidades y pares de claves para los usuarios de su organización, las solicitudes requieren autorización con una cuenta de servicio que tenga autoridad de delegación en todo el dominio para suplantar la identidad de los usuarios con el alcance https://www.googleapis.com/auth/gmail.settings.basic.
En el caso de los usuarios que administran sus propias identidades y pares de claves, las solicitudes requieren que la encriptación de claves de hardware esté activada y configurada.
Solicitud HTTP
GET https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/cse/identities
La URL usa la sintaxis de la transcodificación gRPC.
Parámetros de ruta de acceso
| Parámetros |
userId |
string
La dirección de correo electrónico principal del solicitante. Para indicar el usuario autenticado, puedes usar el valor especial me.
|
Parámetros de consulta
| Parámetros |
pageToken |
string
Es un token de paginación que indica qué página de identidades se debe mostrar. Si no se proporciona el token, la API mostrará la primera página de resultados.
|
pageSize |
integer
Es la cantidad de identidades que se mostrarán. Si no se proporciona, el tamaño de página será de 20 entradas de forma predeterminada.
|
Cuerpo de la solicitud
El cuerpo de la solicitud debe estar vacío.
Cuerpo de la respuesta
Si el proceso es satisfactorio, el cuerpo de la respuesta contiene datos con la siguiente estructura:
| Representación JSON |
{
"cseIdentities": [
{
object (CseIdentity)
}
],
"nextPageToken": string
} |
| Campos |
cseIdentities[] |
object (CseIdentity)
Una página de la lista de identidades de CSE configuradas para el usuario.
|
nextPageToken |
string
Es un token de paginación que se pasará a una llamada posterior a identities.list para recuperar la siguiente página de identidades. Si no se muestra este valor o si es una cadena vacía, significa que no hay más páginas.
|
Permisos de autorización
Se necesita uno de los siguientes permisos de 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
Para obtener más información, consulta la Guía de autorización.
Salvo que se indique lo contrario, el contenido de esta página está sujeto a la licencia Atribución 4.0 de Creative Commons, y los ejemplos de código están sujetos a la licencia Apache 2.0. Para obtener más información, consulta las políticas del sitio de Google Developers. Java es una marca registrada de Oracle o sus afiliados.
Última actualización: 2025-07-25 (UTC)
[null,null,["Última actualización: 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)."]]
