Skip to main content

Об'єкт ESSPrivateKeysQuery

Опис параметрів об'єкта

Параметр

Формат

Тип 1

Опис
nameQuery string O Пошук за назвою ключа.
companyQuery string O Пошук за назвою компанії.
caUserName string O Пошук за CA user name.
stamp boolean O true — тільки печатки, false — тільки ключі.
validTo object O Діапазон дати validTo.
userId number O Internal поле; для external API краще не використовувати.
title string O Пошук за посадою.
parentPKeyId number O Internal поле батьківського ключа.
uuids string[] O Список UUID ключів.
statuses enum[] O Фільтр за статусами ключів.
statusTypes enum[] O Фільтр за типами статусів.
storeType enum[] O HSM, FILE.
keyType enum[] O UA, ECDSA.
caType enum[] O Тип CA user.
pKeyId number[] O Internal ID ключів; для external API краще не використовувати.
companies number[] O Internal поле; у external API компанія береться з companyCode.
users number[] O Internal поле; для методу пошуку ключів співробітника employee береться з employeeIpn.
usage number[] O Usage фільтр.
orderBy object O Сортування.
limit object O Ліміт/offset.

JSON приклад:

{
  "nameQuery": "Ключ",
  "stamp": false,
  "statuses": ["ACTIVATED"],
  "storeType": ["HSM"],
  "keyType": ["UA"],
  "limit": {
    "offset": 0,
    "count": 50
  }
}
1 - Під визначенням колонки Тип поля мається на увазі скорочене позначення:

  • M (mandatory) — обов’язкові до заповнення поля;

  • O (optional) — необов’язкові (опціональні) до заповнення поля.

Back to top