Method: users.settings.cse.identities.list

Enumera 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 a 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

Parámetros
userId

string

Es 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 devolver. Si no se proporciona el token, la API devolverá la primera página de resultados.
pageSize

integer

Es la cantidad de identidades que se devolverá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)

Es una página de la lista de identidades de CSE configuradas para el usuario.
nextPageToken

string

Es un token de paginación que se debe pasar a una llamada posterior a identities.list para recuperar la siguiente página de identidades. Si no se devuelve este valor o es una cadena vacía, no quedan 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 OAuth 2.0 Overview.