Method: users.settings.cse.keypairs.list

Выводит список пар ключей шифрования на стороне клиента для аутентифицированного пользователя.

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

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

HTTP-запрос

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

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

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

Параметры
userId

string

Основной адрес электронной почты запрашивающего. Чтобы указать аутентифицированного пользователя, можно использовать специальное значение me .

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

Параметры
pageToken

string

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

pageSize

integer

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

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

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

Тело ответа

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

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

object ( CseKeyPair )

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

nextPageToken

string

Токен пагинации, который будет передан в последующий вызов keypairs.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

Более подробную информацию см. в Руководстве по авторизации .