Отзыв сертификата по серийному номеру

Обновлено 20 декабря 2023

Перед выполнением запроса к сервисам CAPROXY необходимо вызвать Сервис получения токена авторизации

Open API Documentation можно найти на странице Описание работы сервиса

Описание сервиса PUT /crt/revoke

Клиент отправляет запрос на отзыв сертификата с указанием его серийного номера и причины отзыва.

В ответ получает информацию об обновленном статусе сертификата.

Параметры запроса

Наименование поля		Тип данных	Описание поля	Обязательность параметра	Паттерн
HEAD
X-RqUid		String	Уникальный идентификатор сообщения ФП Интеграционный слой Чтобы обеспечить уникальность, можно использовать стандартные библиотеки и классы для генерации UUID/GUID ( https://ru.wikipedia.org/wiki/UUID ).	√	\^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}\$maxLength: 36
RqUid		String	Уникальный идентификатор сообщения SberAPI Чтобы обеспечить уникальность, можно использовать стандартные библиотеки и классы для генерации UUID/GUID ( https://ru.wikipedia.org/wiki/UUID ), убрав из результата разделители «-».	√	\^[0-9a-fA-F]{32}\$
X-System		String	Система Пример: FINTECH, HRPLATFORM, SYNAPSEСогласуется на этапе первичных встреч с представителями ФП ИС	√	\^[a-zA-Z0-9-_]+\$maxLength: 100
X-Channel		String	Канал Для потребителей в Сигме в значении параметра надо указать - SBERCA_SIGMA, Для потребителей в Альфе в значении параметра надо указать - SBERCA_ALPHA	√	\^[a-zA-Z0-9-_]+\$maxLength: 100
Authorization		String	Авторизационные данные Заполняется значением токена доступа* (access_token) по шаблону: "Bearer" + пробел + \<access_token>" example: "Bearer f3d29241-f35c-4bfd-b0ef-5f011c993ef9" _________________________________________________________________ * - процесс получения токена доступа описан на страницах: Настройки сервиса вызова API и Token 3.0.0	√
Content-Type		String	Заголовок Content-Type Например: "application/json"	√
BODY
crt_id		String	Серийный номер сертификата в формате HEX	√	\^[0-9a-fA-F]{1,40}\$maxLength: 40
reason		String	Причина отзыва сертификата.	√	enum:- UNSPECIFIED- KEY_COMPROMISE- CA_COMPROMISE- AFFILIATION_CHANGED- SUPERSEDED- CESSATION_OF_OPERATION- CERTIFICATE_HOLD- PRIVILEGE_WITHDRAWN- AA_COMPROMISE

Пример запроса

curl --location --request PUT 'https://ift.apim2.sberbank.ru:8443/prod/ILCS/crt/v1/revoke' \
--header 'RqUid: 9fe2e067808811eebe560242ac030001' \
--header 'X-RqUid: 9fe2e066-0078-11ee-be56-0242ac020999' \
--header 'X-System: SberAPI' \
--header 'X-Channel: SberAPI' \
--header 'Connection: close' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer efafecc1-bba9-499b-bd17-99ec1bc1bce1' \
--data '{
    "crt_id": "46b9f08ce333d418fedfd5483311518897b8d443",
    "reason": "CERTIFICATE_HOLD"
}'

Параметры ответа

Наименование поля		Тип данных	Описание поля	Обязательность параметра	Паттерн
crt_id		String	Серийный номер сертификата в формате HEX	√	\^[0-9a-fA-F]{1,40}\$ maxLength: 40
client_id		String	Уникальный идентификатор клиента (значение указывается клиентом для облегчения идентификации сертификата самим клиентом при дальнейшей обработке)		\^[a-zA-Z0-9-_+=@.,; ]*\$ maxLength: 128
created		String	Дата и время выпуска сертификата	√	format: date-time maxLength: 128
email		String	Контактный адрес электронной почты владельца сертификата		format: email maxLength: 128
expires		String	Дата и время истечения срока действия сертификата		format: date-time maxLength: 128
revocation_date		String	Дата и время отзыва сертификата. Возвращается тогда, когда сертификат отозван. В противном случае возвращается null		format: date-time maxLength: 128
revocation_reason		String	Причина отзыва сертификата. Возможные значения: Enum: [ , UNSPECIFIED, KEY_COMPROMISE, CA_COMPROMISE, AFFILIATION_CHANGED, SUPERSEDED, CESSATION_OF_OPERATION, CERTIFICATE_HOLD, PRIVILEGE_WITHDRAWN, AA_COMPROMISE ] Возвращается тогда, когда сертификат отозван. В противном случае возвращается null		enum:- null- UNSPECIFIED- KEY_COMPROMISE- CA_COMPROMISE- AFFILIATION_CHANGED- SUPERSEDED- CESSATION_OF_OPERATION- CERTIFICATE_HOLD- PRIVILEGE_WITHDRAWN- AA_COMPROMISE
status		String	Статус сертификата. Возможные варианты: Enum: [ ACTIVE, REVOKED, EXPIRED, REVOKED_EXPIRED ]	√	enum:- NEW- SUCCESS- ERROR- ACTIVE- REVOKED- BLOCKED- INVALID- EXPIRED- REVOKED_EXPIRED- UNKNOWN
system_id		String	Уникальный идентификатор системы, запрашивающей сертификат	√	\^[a-zA-Z0-9_-]+\$ maxLength: 128
template		String	Шаблон, на основе которого был выпущен сертификат		\^[a-zA-Z0-9_-]+\$ maxLength: 128

Пример ответа

{
    "template": "allow-san-dn",
    "email": "petrova.v.a@sberbank.ru",
    "system_id": "SAR",
    "client_id": "0058d83d-340f-4dad-ad8d-09348dc3d5c0",
    "expires": "2024-06-20T11:06:18.000+00:00",
    "created": "2023-06-21T11:01:18.000+00:00",
    "status": "REVOKED",
    "crt_id": "46b9f08ce333d418fedfd5483311518897b8d443",
    "revocation_date": "2023-06-21T14:29:34.989+00:00",
    "revocation_reason": "CERTIFICATE_HOLD"
}