REST Resource: users.settings.cse.keypairs

Ресурс: CseKeyPair

Пара ключей S/MIME для шифрования на стороне клиента, состоящая из открытого ключа, цепочки сертификатов и метаданных для соответствующего закрытого ключа. Gmail использует эту пару ключей для выполнения следующих задач:

  • Подписывать исходящие зашифрованные сообщения на стороне клиента.
  • Сохраняйте и открывайте заново черновики зашифрованных на стороне клиента сообщений.
  • Сохраните и откройте отправленные сообщения.
  • Расшифровка входящих или архивных сообщений S/MIME.

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

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

JSON-представление 
{
  "keyPairId": string,
  "pkcs7": string,
  "pem": string,
  "subjectEmailAddresses": [
    string
  ],
  "enablementState": enum (EnablementState),
  "disableTime": string,
  "privateKeyMetadata": [
    {
      object (CsePrivateKeyMetadata)
    }
  ]
}
Поля
keyPairId

string

Только для вывода. Неизменяемый идентификатор пары ключей S/MIME для шифрования на стороне клиента.

pkcs7

string

Только ввод. Открытый ключ и цепочка сертификатов. Цепочка должна быть в формате PKCS#7 , использовать кодировку PEM и ASCII-защиту.

pem

string

Только вывод. Открытый ключ и цепочка сертификатов в формате PEM .

subjectEmailAddresses[]

string

Только вывод. Адреса электронной почты, указанные в конечном сертификате.

enablementState

enum ( EnablementState )

Только вывод. Текущее состояние ключевой пары.

disableTime

string ( Timestamp format)

Только для вывода. Если для пары ключей установлено значение DISABLED , указывается время, когда состояние пары ключей изменилось с ENABLED на DISABLED . Это поле присутствует только тогда, когда пара ключей находится в состоянии DISABLED .

Используется RFC 3339, согласно которому генерируемый вывод всегда будет Z-нормализован и будет содержать 0, 3, 6 или 9 дробных знаков. Допускаются также смещения, отличные от "Z". Примеры: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" или "2014-10-02T15:01:23+05:30" .

privateKeyMetadata[]

object ( CsePrivateKeyMetadata )

Метаданные для экземпляров закрытого ключа этой ключевой пары.

EnablementState

Перечисление текущего состояния ключевой пары.

Перечисления
stateUnspecified Текущее состояние пары ключей не установлено. Пара ключей не включена и не выключена.
enabled

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

Чтобы включить пару ключей, используйте метод keypairs.enable .

disabled

Пара ключей отключена. Авторизованные пользователи не могут расшифровывать электронные письма и подписывать исходящие сообщения. Если пара ключей отключена более чем на 30 дней, вы можете удалить её навсегда.

Чтобы отключить пару клавиш, используйте метод keypairs.disable .

CsePrivateKeyMetadata

Метаданные для экземпляра закрытого ключа.

JSON-представление 
{
  "privateKeyMetadataId": string,

  "kaclsKeyMetadata": {
    object (KaclsKeyMetadata)
  },
  "hardwareKeyMetadata": {
    object (HardwareKeyMetadata)
  }
}
Поля
privateKeyMetadataId

string

Только для вывода. Неизменяемый идентификатор экземпляра метаданных закрытого ключа.

Поле объединения metadata_variant . Поле объединения: Должно присутствовать ровно одно из следующих типов вариантов метаданных. metadata_variant может быть только одним из следующих:
kaclsKeyMetadata

object ( KaclsKeyMetadata )

Метаданные для экземпляра закрытого ключа, управляемого внешней службой списков контроля доступа по ключу.

hardwareKeyMetadata

object ( HardwareKeyMetadata )

Метаданные для аппаратных клавиш.

KaclsKeyMetadata

Метаданные для закрытых ключей управляются внешней службой списков контроля доступа по ключам. Подробную информацию об управлении доступом по ключам см. в справочнике API Google Workspace CSE .

JSON-представление 
{
  "kaclsUri": string,
  "kaclsData": string
}
Поля
kaclsUri

string

URI службы списков контроля доступа, которая управляет закрытым ключом.

kaclsData

string

Непрозрачные данные, генерируемые и используемые службой списков контроля доступа по ключу. Максимальный размер: 8 КиБ.

Метаданные аппаратного ключа

Метаданные для аппаратных клавиш.

Если в организации Google Workspace настроено аппаратное шифрование с помощью ключей , пользователи могут дополнительно хранить свой закрытый ключ на смарт-карте и использовать его для подписи и расшифровки электронных писем в Gmail, вставив смарт-карту в считыватель, подключенный к их устройству Windows.

JSON-представление 
{
  "description": string
}
Поля
description

string

Описание аппаратного ключа.

Методы

create

 Создает и загружает цепочку сертификатов открытого ключа S/MIME для шифрования на стороне клиента, а также метаданные закрытого ключа для аутентифицированного пользователя.

disable

 Отключает пару ключей шифрования на стороне клиента.

enable

 Включает пару ключей шифрования на стороне клиента, которая ранее была отключена.

get

 Получает существующую пару ключей шифрования на стороне клиента.

list

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

obliterate

 Удаляет пару ключей шифрования на стороне клиента безвозвратно и немедленно.