Method: users.settings.cse.identities.list

Lista as identidades criptografadas do lado do cliente de um usuário autenticado.

Para administradores que gerenciam identidades e pares de chaves para usuários na organização, as solicitações exigem autorização com uma conta de serviço que tenha autoridade de delegação em todo o domínio para representar usuários com o escopo https://www.googleapis.com/auth/gmail.settings.basic.

Para usuários que gerenciam as próprias identidades e pares de chaves, as solicitações exigem a criptografia de chaves de hardware ativada e configurada.

Solicitação HTTP

GET https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/cse/identities

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
userId

string

O endereço de e-mail principal do solicitante. Para indicar o usuário autenticado, use o valor especial me.

Parâmetros de consulta

Parâmetros
pageToken

string

Token de paginação que indica qual página de identidades será retornada. Se o token não for fornecido, a API vai retornar a primeira página de resultados.
pageSize

integer

O número de identidades a serem retornadas. Se não for fornecido, o tamanho da página será de 20 entradas.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Se bem-sucedido, o corpo da resposta exibirá os dados com a seguinte estrutura:

Representação JSON 
{
  "cseIdentities": [
    {
      object (CseIdentity)
    }
  ],
  "nextPageToken": string
}
Campos
cseIdentities[]

object (CseIdentity)

Uma página da lista de identidades da CSE configuradas para o usuário.
nextPageToken

string

É o token de paginação que será transmitido para uma chamada identities.list subsequente para recuperar a próxima página de identidades. Se esse valor não for retornado ou for uma string vazia, não haverá mais páginas.

Escopos de autorização

Requer um dos seguintes escopos do 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 mais informações, consulte o guia de autorização.