.. _Integration_CryptoApi_GettingCertificates:

Запрос списка сертификатов
##########################

| Запрос: ``GET /v2/certificates?HasPrivateKey=true|false&IncludeRawData=true|false&ThrowOnParsingErrors=true|false``
| HTTP-заголовки:

.. code-block::

    Authorization: Bearer access_token
    Accept: application/json

Описание запроса
****************

Запрос позволяет получить список сертификатов, которые установлены на сервере.

Если параметр запроса ``HasPrivateKey`` установлен в ``true``, то в ответе на запрос будут только те сертификаты, для которых доступен закрытый ключ.
Это те сертификаты, с помощью которых можно создать ЭП или расшифровать данные. В случае значения ``false`` возвращаются все сертификаты.

Если параметр запроса ``IncludeRawData`` установлен в ``true``, то в ответ на запрос будут включены данные сертификата в виде массива байт (без закрытого ключа).
В случае значения ``false`` данные сертификата в виде массива байт в ответ не включаются.

Параметр ``ThrowOnParsingErrors`` управляет поведением запроса в случае ошибок разбора данных сертификатов.

Если параметр установлен в ``true``, то в случае ошибок разбора данных сертификатов выполнение запроса прерывается
и возвращается :ref:`HTTP-статус 400 (Bad Request) <Integration_Common_ApiHttpStatuses_BadRequest>` с сообщением об ошибке.

Если параметр установлен в ``false``, то выполнение запроса не прерывается. Crypto API игнорирует такие сертификаты и не включает их в ответ.

Ответ на запрос
***************

В случае успешного выполнения запроса возвращается коллекция с данными сертификатов.
Каждый элемент коллекции представляет JSON вида:

.. code-block:: JSON

    {
		"Thumbprint": "string",                                 // отпечаток сертификата
		"ValidFrom": "YYYY-MM-DDThh:mm:ss.fffZ",                // дата и время, с которого действует сертификат
		"ValidTo": "YYYY-MM-DDThh:mm:ss.fffZ",                  // дата и время, по которое действует сертификат
		"RawData": "base64",                                    // данные сертификата в виде массива байт в Base64
		"PublicKeyRawData": "base64"                            // публичный ключ сертификата в виде массива байт в Base64
		"SerialNumber": "string",                               // серийный номер сертификата
		"Surname": "string",                                    // фамилия владельца сертификата
		"FirstName": "string",                                  // имя владельца сертификата            
		"MiddleName": "string",                                 // отчество владельца сертификата
		"CommonName": "string",                                 // общее имя владельца сертификата
		"Position": "string",                                   // должность владельца сертификата
		"OrganizationName": "string",                           // наименование организации, в которой работает владелец сертификата
		"OrganizationInn": "string",                            // ИНН организации, в которой работает владелец сертификата
		"Inn": "string",                                        // ИНН физического лица или ИП, которые владеют сертификатом
		"Snils": "string",                                      // СНИЛС владельца сертификата
		"Email": "string",                                      // e-mail владельца сертификата
		"Department": "string",                                 // подразделение, в котором работает владелец сертификата
		"City": "string",                                       // город (населенный пункт) организации, в которой работает владелец сертификата, или владельца сертификата
		"Street": "string",                                     // улица и номер дома организации, в которой работает владелец сертификата, или владельца сертификата
		"Ogrn": "string",                                       // ОГРН организации, в которой работает владелец сертификата
		"OrgnIp": "string",                                     // ОГРНИП, в которой работает владелец сертификата
		"Region": "string",                                     // регион организации, в которой работает владелец сертификата, или владельца сертификата 
		"Locale": "string",                                     // язык сертификата            
		"RnsFss": "string",                                     // регистрационный номер страхователя ФСС
		"IssuerSimpleName": "string",                           // простое имя издателя сертификата
		"CertificateType": 0                                    // тип сертификата
	}

Поля ``Thumbprint`` и ``SerialNumber`` идентифицируют сертификат.

Поля ``ValidFrom`` и ``ValidTo`` определяют период действия сертификата.

Остальные поля, кроме ``RawData`` - это результат разбора поля ``Subject`` сертификата.

Поле ``RawData`` содержит данные сертификата в виде массива байт в Base64, если параметр ``IncludeRawData`` запроса был установлен в ``true``.

Поле ``CertificateType`` содержит одно из возможных значений:

* неизвестный тип (тип ``0``);
* сертификат работника организации (тип ``1``);
* сертификат физ. лица (тип ``2``);
* сертификат ИП (тип ``3``).