REST Resource: users.settings.cse.keypairs

Ресурс: CseKeyPair

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

  • Подписывайте исходящие зашифрованные сообщения на стороне клиента.
  • Сохраняйте и повторно открывайте черновики зашифрованных на стороне клиента сообщений.
  • Сохраняйте и повторно открывайте отправленные сообщения.
  • Расшифруйте входящие или архивированные сообщения S/MIME.
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 .

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

privateKeyMetadata[]

object ( CsePrivateKeyMetadata )

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

Состояние включения

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

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

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

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

disabled

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

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

CsePrivateKeyМетаданные

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

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 )

Метаданные для аппаратных ключей.

KaclsKeyМетаданные

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

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

string

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

kaclsData

string

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

Аппаратный ключМетаданные

Метаданные для аппаратных ключей.

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

string

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

Методы

create

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

disable

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

enable

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

get

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

list

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

obliterate

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