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,

  // Union field metadata_variant can be only one of the following:
  "kaclsKeyMetadata": {
    object (KaclsKeyMetadata)
  },
  "hardwareKeyMetadata": {
    object (HardwareKeyMetadata)
  }
  // End of list of possible types for union field metadata_variant.
}
Поля
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

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