Установка и использование платформы

REST API: получение сертификатов

Для запроса у ноды сертификата из хранилища сертификатов предусмотрена группа методов /pki/certificate. Методы этой группы позволяют получить сертификат по разным полям:

В запросе эти методы принимают значение соответствующего поля сертификата и, опционально, параметр plainText, который задаёт формат ответа.

Если сертификат существует, то в ответе каждого из этих методов нода возвращает сертификат в формате DER (как он и записан в хранилище сертификатов ноды), байты кодируются в формат Base64. Если в запросе метода параметру plainText задано значение true, то сертификат возвращается в формате plainText.

Если сертификата не существует, то в ответе каждого из этих методов возвращается ошибка с кодом 404 Not Found.

Примечание

Те же данные, что и с помощью REST методов группы /pki/certificate, можно получить с помощью группы методов gRPC сервиса PkiPublicService.

Авторизация методов группы /pki/certificate

В случае API-KEY авторизация не требуется.

В случае OAuth2 авторизации требуется наличие роли user в JWT токене.

GET /pki/certificate/by-dn/%percent-encoded-DN%

Метод возвращает сертификат по его отличительному имени (distinguished name), записанному в поле DN.

Пример запроса метода GET /pki/certificate/by-dn/%percent-encoded-DN%:

GET /pki/certificate/by-dn/%percent-encoded-DN%:

Запрос:

{
  "DN": "CN=Steve Kille,O=Isode Limited,C=GB",
  "plainText": false
}

Примечание

Те же данные, что и с помощью REST метода GET /pki/certificate/by-dn/%percent-encoded-DN%, можно получить с помощью gRPC метода GetCertificateByDn(CertByDNRequest).

GET /pki/certificate/by-dn-hash/%DN-hash-string%

Метод возвращает сертификат по хэшу SHA-1 (Keccak) от поля DN сертификата.

Примечание

Те же данные, что и с помощью REST метода GET /pki/certificate/by-dn-hash/%DN-hash-string%, можно получить с помощью gRPC метода GetCertificateByDnHash(CertByDNHashRequest).

GET /pki/certificate/by-public-key/%public-key-base58%

Метод возвращает сертификат по байтам публичного ключа (поле publicKey).

Примечание

Те же данные, что и с помощью REST метода GET /pki/certificate/by-public-key/%public-key-base58%, можно получить с помощью gRPC метода GetCertificateByPublicKey(CertByPublicKeyRequest).

GET /pki/certificate/by-fingerprint/%fingerprint-base64%

Метод возвращает сертификат по его SHA-1 отпечатку (поле fingerprint).

Примечание

Те же данные, что и с помощью REST метода GET /pki/certificate/by-fingerprint/%fingerprint-base64%, можно получить с помощью gRPC метода GetCertificateByFingerprint(CertByFingerprintRequest).

Смотрите также

Методы REST API

Проверка УКЭП

gRPC: получение сертификатов