Method: users.settings.cse.identities.list

Отображает список зашифрованных на стороне клиента идентификаторов для аутентифицированного пользователя.

Для администраторов, управляющих учетными записями и парами ключей для пользователей в своей организации, запросы требуют авторизации с помощью служебной учетной записи , обладающей полномочиями делегирования в масштабе домена для имитации пользователей с областью действия https://www.googleapis.com/auth/gmail.settings.basic .

Для пользователей, управляющих своими учетными записями и парами ключей, запросы требуют включения и настройки аппаратного шифрования ключей .

HTTP-запрос

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

В URL-адресе используется синтаксис транскодирования gRPC .

Параметры пути

Параметры
userId

string

Основной адрес электронной почты отправителя запроса. Для указания авторизованного пользователя можно использовать специальное значение me .

Параметры запроса

Параметры
pageToken

string

Токен пагинации указывает, какую страницу с данными следует вернуть. Если токен не указан, API вернет первую страницу результатов.

pageSize

integer

Количество возвращаемых идентификаторов. Если не указано, размер страницы по умолчанию будет равен 20 записям.

Текст запроса

Тело запроса должно быть пустым.

Ответный текст

В случае успеха тело ответа будет содержать данные следующей структуры:

JSON-представление 
{
  "cseIdentities": [
    {
      object (CseIdentity)
    }
  ],
  "nextPageToken": string
}
Поля
cseIdentities[]

object ( CseIdentity )

Одна страница списка учетных записей CSE, настроенных для пользователя.

nextPageToken

string

Токен пагинации, который будет передан в последующий вызов функции identities.list для получения следующей страницы с данными об участниках. Если это значение не возвращается или является пустой строкой, то дальнейших страниц не осталось.

Области полномочий

Требуется один из следующих диапазонов аутентификации 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

Для получения более подробной информации см.OAuth 2.0 Overview .