Method: users.settings.cse.identities.list

Enumera las identidades con encriptación del cliente para un usuario autenticado.

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

Token de paginación que indica qué página de identidades se debe mostrar. Si no se proporciona el token, la API devolverá la primera página de resultados.
pageSize

integer

La cantidad de identidades que se mostrarán. Si no se proporciona, el tamaño de la página se establecerá de forma predeterminada en 20 entradas.

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 con CSE configuradas para el usuario.
nextPageToken

string

Token de paginación que se pasará a una llamada posterior de identidades.list para recuperar la siguiente página de identidades. Si este valor no se muestra o es la cadena vacía, no quedará ninguna página más.

Alcances 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.