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

Запрос: GET /certificates?HasPrivateKey=true|false&IncludeRawData=true|false&ThrowOnParsingErrors=true|false

HTTP-заголовки:

Authorization: Bearer access_token
Accept: application/json

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

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

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

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

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

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

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

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

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

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

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

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

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

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