Шифрование
Каждая операция этой группы: что она принимает, что возвращает и какими ошибками может ответить.
Операции
The OpenPGP public keys that let senders seal mail to an address, the directory the Encryption page of the app publishes to. Only public keys travel here: the private key stays on the device that made it, so nothing in this API can read sealed mail.
Published keys belong to a person. A key reads and publishes the keys of the workspace owner, and an app those of the person who connected it.
GET/encryption/keys
List your published keys
Every key published for an address in this workspace, newest first, retired ones included with revokedAt and revokedReason. Published keys belong to a person. A key reads and publishes the keys of the workspace owner, and an app those of the person who connected it. A key limited to particular addresses lists only the keys of those addresses.
Requires the emails:read scope.
Возвращает
The keys, newest first.
Ошибки
Ошибки, которые может вернуть любая операция400401403404422500Каталог ошибок
Также доступно в
POST/encryption/keys
Publish a public key for an address
Publishes an armored OpenPGP public key for one of your addresses, so that senders can seal mail to it, as Publish on the Encryption page does. The address has to be an address of this workspace on a verified domain, switched on, and one you may use.
An address keeps one live key. Publishing another while one is live is a 409 key_already_published; to rotate, send the fingerprint of the live key in replaces, and it is retired as the new one is published. Mail already sealed to the old key stays readable only with the old private key.
Published keys belong to a person. A key reads and publishes the keys of the workspace owner, and an app those of the person who connected it.
Requires the emails:read scope.
Тело запроса
addressstringОбязательноThe address the key is for.
До 320 символовpublicKeystringОбязательноThe armored OpenPGP PUBLIC KEY BLOCK, up to 64 KB.
От 64 до 65536 символовШаблон^-----BEGIN PGP PUBLIC KEY BLOCK-----[\s\S]+-----END PGP PUBLIC KEY BLOCK-----\s*$fingerprintstringОбязательноThe fingerprint of the key, 40 upper-case hexadecimal characters.
Шаблон^[0-9A-F]{40}$algorithmstringThe algorithm of the key, such as
ed25519, for display only.До 32 символовreplacesstringThe fingerprint of the live key this one replaces, to rotate it.
Шаблон^[0-9A-F]{40}$
Возвращает
The key, now published.
Ошибки
- 403
The key lacks the scope, or may not send as that address.
step_up_required: the call was made with an OAuth access token that has not been verified in the last 60 minutes. Ask for a code withPOST /security/step-up, send it toPOST /security/step-up/verify, then repeat the call. The person can also choose Allow changes for 60 minutes on the app in Account settings, Connected apps, on the OpenEmail website. An API key is never asked for a code.- 409
key_already_published: the address has a live key andreplaceswas not given, or this key was published for it before.domain_not_verified: the domain of the address is not verified yet.
Ошибки, которые может вернуть любая операция400401404422500Каталог ошибок
Также доступно в
GET/encryption/keys/lookup
Find the keys to seal mail to
The live public keys published for each address, the lookup the composer makes before it seals a message. An address with no key comes back with keys empty, so mail to it cannot be sealed. Only keys published by somebody who can read the address count, so a key a former member left behind is never offered.
Requires the emails:send scope.
Параметры запроса
addressesstringОбязательноComma-separated recipient addresses, at most 51. A display name in angle brackets is read as its address.
Возвращает
One row per address asked about.
Ошибки
Ошибки, которые может вернуть любая операция400401403404422500Каталог ошибок
Также доступно в
Объекты
AddressKeysobject
objectstringОбязательно- Одно из
"address_keys" addressstringОбязательноThe address as it was read, lower-cased.
keysobject[]ОбязательноfingerprintstringОбязательноpublicKeystringОбязательноcreatedAtstringОбязательно- Формат
date-time
AddressKeysListobject
objectstring- Одно из
"list" dataAddressKeys[]
EncryptionKeyobject
objectstringОбязательно- Одно из
"encryption_key" idstringОбязательноpgpk_and 24 hex.addressstringОбязательноfingerprintstringОбязательно40 upper-case hexadecimal characters.
publicKeystringОбязательноThe armored OpenPGP PUBLIC KEY BLOCK.
algorithmstringОбязательноcreatedAtstringОбязательно- Формат
date-time revokedAtstringОбязательноWhen it was retired. Null on the live key.
Может быть nullФорматdate-timerevokedReasonstringОбязательно- Может быть null
EncryptionKeyListobject
objectstring- Одно из
"list" dataEncryptionKey[]