# Об'єкт ESSPrivateKeysQuery

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

<table id="bkmrk-%D0%9F%D0%B0%D1%80%D0%B0%D0%BC%D0%B5%D1%82%D1%80-%D0%A4%D0%BE%D1%80%D0%BC%D0%B0%D1%82-%D0%A2%D0%B8%D0%BF%C2%A0" style="width: 100%;"><thead><tr><th class="head align-center" style="width: 13.7035%;">Параметр

</th><th style="width: 9.65239%;">Формат

</th><th class="head align-center" style="width: 8.34094%;">Тип <sup>1</sup>

</th><th class="head align-center" style="width: 68.2793%;">Опис

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

**JSON приклад:**

```json
{
  "nameQuery": "Ключ",
  "stamp": false,
  "statuses": ["ACTIVATED"],
  "storeType": ["HSM"],
  "keyType": ["UA"],
  "limit": {
    "offset": 0,
    "count": 50
  }
}
```

---

<dl class="footnote brackets" id="bkmrk-1---%D0%9F%D1%96%D0%B4-%D0%B2%D0%B8%D0%B7%D0%BD%D0%B0%D1%87%D0%B5%D0%BD%D0%BD%D1%8F%D0%BC-"><dt class="label" id="bkmrk-1---%D0%9F%D1%96%D0%B4-%D0%B2%D0%B8%D0%B7%D0%BD%D0%B0%D1%87%D0%B5%D0%BD%D0%BD%D1%8F%D0%BC--1"><span class="brackets">1 - </span>Під визначенням колонки **Тип поля** мається на увазі скорочене позначення:</dt><dd>- M (mandatory) — обов’язкові до заповнення поля;
- O (optional) — необов’язкові (опціональні) до заповнення поля.

</dd></dl>