Перейти к содержимому
Аладдин Р.Д.Аладдин Р.Д.Аладдин Р.Д.

7.1.1. REST API eCA-CA (версия 3)

Aladdin Enterprise CAAPI и SDKAladdin Enterprise CA

Методы идентификации и аутентификации

Заголовок раздела «Методы идентификации и аутентификации»

Метод идентификации и аутентификации по сертификату доступа

Заголовок раздела «Метод идентификации и аутентификации по сертификату доступа»
POST API – Аутентификация с помощью сертификата
URL – x509-provider-service/api/v3/public/auth/sign-in/x509
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/
Query -
Request -
Response ResponseEntity -> ItemResponse ->Ответ JSON в HTTP-body
token (string),Маркер доступа
refresh (string)Токен обновления

Метод обновления маркера доступа

Заголовок раздела «Метод обновления маркера доступа»
POST API – Обновление токена доступа
Метод доступен администратору и оператору
URL – security-service/api/v3/public/auth/refresh-token
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/[v3] Контроллер%3A Авторизации/refreshToken
Query -
Request -
Response ResponseEntity -> ItemResponse ->Ответ JSON в HTTP-body
token (string),Маркер доступа
refresh (string)Токен обновления

Метод обновления последней активности учётной записи

Заголовок раздела «Метод обновления последней активности учётной записи»
PUT API – Обновление последней активности учетной записи по ее идентификатору
Метод доступен только администратору
URL – security-service/api/v3/public/accounts/{accountId}/activity
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/
Query {(id – обязательный параметр)
id (UUID)Идентификатор учетной записи
Request -
Response -

Метод аутентификации по Kerberos-ticket

Заголовок раздела «Метод аутентификации по Kerberos-ticket»
POST API – Аутентификация по Kerberos-ticket
URL – security-service/api/v3/public/auth/sign-in/kerberos
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/
Query -
Request -
ResponseОтвет JSON в HTTP-body
token (string),Маркер доступа
refresh (string)Токен обновления

Метод аутентификации по логину и паролю

Заголовок раздела «Метод аутентификации по логину и паролю»
POST API – Аутентификация по логину и паролю
URL – security-service/api/v3/public/auth/sign-in/ldap
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/
Query -
Request
username (string),Имя пользователя
password (string)Пароль пользователя
ResponseОтвет JSON в HTTP-body
token (string),Маркер доступа
refresh (string)Токен обновления

Методы работы с лицензией

Заголовок раздела «Методы работы с лицензией»

Метод получения информации о возможности использования сторонних[7] ключевых носителей в соответствии с параметрами лицензии

Заголовок раздела «Метод получения информации о возможности использования сторонних[7] ключевых носителей в соответствии с параметрами лицензии»
GET API – Метод получения информации о возможности использования сторонних ключевых носителей в соответствии с параметрами лицензии
Метод доступен только администратору.
Если по текущей лицензии разрешено использование сторонних ключевых носителей, ответ метода будет иметь код 204.
Если по текущей лицензии разрешено использование сторонних ключевых носителей, ответ метода будет иметь код 403 и сообщение “Использование сторонних токенов запрещено лицензией”.
URL – license-service/api/v3/public/restrictions/third-party-tokens
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/[v3] Контроллер%3A Лицензионные ограничения/checkThirdPartyTokens
Query -
Request -
Response -

Методы работы с субъектами

Заголовок раздела «Методы работы с субъектами»

Метод поиска субъектов

Заголовок раздела «Метод поиска субъектов»
GET API – Поиск субъектов
Метод доступен администратору и оператору.
В ответе для оператора содержатся только те субъекты, на просмотр или управление которых ему предоставлены полномочия.
В ответе данного метода в поле “subjectName” атрибуты “ROLE” (роль), “DATEOFBIRTH” (дата рождения) и “PLACEOFBIRTH” (место рождения) в случае их наличия у субъекта будут указаны как “UNKNOWN”.
Данные атрибуты поддерживаются в публичном API начиная с версии v4.
URL – subjects-service/api/v3/public/subjects
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/[v3] Контроллер%3A субъекты/findAll_2
Query
search (string) [опционально],Полнотекстовый поиск (имя субъекта)
isBlocked (boolean) [опционально],Флаг: субъект заблокирован в ресурсной системе
isConnected (boolean) [опционально],Флаг: субъект подключен к ресурсной системе
id (UUID[])[опционально],ID субъекта
notId (UUID[])[опционально],Исключая ID субъекта
securityGroupId (UUID[])[опционально],ID группы безопасности
resourceId (UUID[])[опционально],ID ресурсной системы
sortDirection (string) [опционально],Направления сортировки (ASC;DESC)
sortBy (string[])[опционально],Список полей, к которым применяется сортировка
pageOffset (integer) [опционально],Смещение от начала списка (пагинация)
pageLimit (integer) [опциональноОграничение на размер выборки (пагинация)
Request -
Response ResponseEntity -> CollectionResponse ->Ответ JSON в HTTP-body
id (UUID),ID субъекта
commonName (string)Имя субъекта
distinguishedName (string),Расположение субъекта в ресурсной системе
resource:Ресурсная система
id (uuid),ID ресурсной системы
commonName (string),Имя ресурсной системы
distinguishedName (string)BaseDN точки подключения к ресурсной системе
subjectName:Имя субъекта
(enum: CN,
UID,
E,
EMAILADDRESS,
MAIL,
SN,
GIVENNAME,
INITIALS,
SURNAME,
OU,
O,
L,
ST,
DC,
C,
UNSTRUCTUREDADDRESS,
UNSTRUCTUREDNAME,
POSTALCODE,
BUSINESSCATEGORY,
TELEPHONENUMBER,
PSEUDONYM,
POSTALADDRESS,
STREET,
NAME,
T,
DN,
DESCRIPTION,
INN,
OGRN,
OGRNIP,
SNILS,
INNLE,
UNKNOWN):		Поля разделенного имени субъекта
values (string[]),Значения компонента
editable (boolean),Флаг: компонент доступен для редактирования
subjectAltName:Альтернативное имя субъекта
(enum: RFC822NAME,
DNS_NAME,
IPADDRESS,
DIRECTORY_NAME,
UNIFORM_RESOURCE_ID,
REGISTERED_ID,
MS_UPN,
MS_GUID,
KRB5PRINCIPAL,
PERMANENT_IDENTIFIER,
XMPP_ADDR,
SRV_NAME,
SUBJECT_IDENTIFICATION_METHOD,
UNKNOWN):		Поля альтернативного имени субъекта
values (string[]),Значения компонента
editable (boolean),Флаг: компонент доступен для редактирования
isConnected (boolean),Флаг: субъект подключен к ресурсной системе
isBlocked (boolean),Флаг: субъект заблокирован в ресурсной системе
certificatesCount (integer),Количество сертификатов
modify (instant),Время изменения (ISO 8601)
updated (instant),Время обновления (ISO 8601)
created (instant),Время создания (ISO 8601)
sid (string)SID субъекта

Метод получения субъекта по идентификатору

Заголовок раздела «Метод получения субъекта по идентификатору»
GET API – Получение субъекта по идентификатору
Метод доступен администратору и оператору при наличии полномочий на просмотр или управление субъектом, идентификатор которого передается во входных параметрах.
В ответе данного метода в поле “subjectName” атрибуты “ROLE” (роль), “DATEOFBIRTH” (дата рождения) и “PLACEOFBIRTH” (место рождения) в случае их наличия у субъекта будут указаны как “UNKNOWN”.
Данные атрибуты поддерживаются в публичном API начиная с версии v4.
URL – subjects-service/api/v3/public/subjects/{id
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/[v3] Контроллер%3A субъекты/findById_2
Query
id (UUID)ID субъекта
Request -
Response ResponseEntity -> ItemResponse ->Ответ JSON в HTTP-body
id (UUID),ID субъекта
commonName (string)Имя субъекта
distinguishedName (string),Расположение субъекта в ресурсной системе
resource:Ресурсная система
id (uuid),ID ресурсной системы
commonName (string),Имя ресурсной системы
distinguishedName (string)BaseDN точки подключения к ресурсной системе
subjectName:Имя субъекта
(enum: CN,
UID,
E,
EMAILADDRESS,
MAIL,
SN,
GIVENNAME,
INITIALS,
SURNAME,
OU,
O,
L,
ST,
DC,
C,
UNSTRUCTUREDADDRESS,
UNSTRUCTUREDNAME,
POSTALCODE,
BUSINESSCATEGORY,
TELEPHONENUMBER,
PSEUDONYM,
POSTALADDRESS,
STREET,
NAME,
T,
DN,
DESCRIPTION,
INN,
OGRN,
OGRNIP,
SNILS,
INNLE,
UNKNOWN):		Поля разделенного имени субъекта
values (string[]),Значения компонента
editable (boolean),Флаг: компонент доступен для редактирования
subjectAltName:Альтернативное имя субъекта
(enum: RFC822NAME,
DNS_NAME,
IPADDRESS,
DIRECTORY_NAME,
UNIFORM_RESOURCE_ID,
REGISTERED_ID,
MS_UPN,
MS_GUID,
KRB5PRINCIPAL,
PERMANENT_IDENTIFIER,
XMPP_ADDR,
SRV_NAME,
SUBJECT_IDENTIFICATION_METHOD,
UNKNOWN):		Поля альтернативного имени субъекта
values (string[]),Значения компонента
editable (boolean),Флаг: компонент доступен для редактирования
isConnected (boolean),Флаг: субъект подключен к ресурсной системе
isBlocked (boolean),Флаг: субъект заблокирован в ресурсной системе
certificatesCount (integer),Количество сертификатов
modify (instant),Время изменения (ISO 8601)
updated (instant),Время обновления (ISO 8601)
created (instant),Время создания (ISO 8601)
sid (string)SID субъекта

Метод создания и изменения субъекта

Заголовок раздела «Метод создания и изменения субъекта»
PUT API – Создание и изменение субъекта
Метод доступен администратору и оператору при наличии полномочий на управление субъектами
URL – subjects-service/api/v3/public/subjects
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/[v3] Контроллер%3A субъекты/update
Query -
Request
id (UUID) [опционально],Идентификатор субъекта
subjectName: { (enum: CN, UID, E, EMAILADDRESS, MAIL, SN, GIVENNAME, INITIALS, SURNAME, OU, O, L, ST, DC, C, UNSTRUCTUREDADDRESS, UNSTRUCTUREDNAME, POSTALCODE, BUSINESSCATEGORY, TELEPHONENUMBER, PSEUDONYM, POSTALADDRESS, STREET, NAME, T, DN, DESCRIPTION, INN, OGRN, OGRNIP, SNILS, INNLE, UNKNOWN): string[] } [опционально],Поля разделенного имени субъекта
subjectAltName: { (enum: RFC822NAME, DNS_NAME, IPADDRESS, DIRECTORY_NAME, UNIFORM_RESOURCE_ID, REGISTERED_ID, MS_UPN, MS_GUID, KRB5PRINCIPAL, PERMANENT_IDENTIFIER, XMPP_ADDR, SRV_NAME, SUBJECT_IDENTIFICATION_METHOD, UNKNOWN): string[] } [опционально\Поля альтернативного имени субъекта
Response ResponseEntity -> ItemResponse ->Ответ JSON в HTTP-body
id (UUID),ID субъекта
commonName (string)Имя субъекта
distinguishedName (string),Расположение субъекта в ресурсной системе
resource:Ресурсная система
id (uuid),ID ресурсной системы
commonName (string),Имя ресурсной системы
distinguishedName (string)BaseDN точки подключения к ресурсной системе
subjectName:Имя субъекта
(enum: CN,
UID,
E,
EMAILADDRESS,
MAIL,
SN,
GIVENNAME,
INITIALS,
SURNAME,
OU,
O,
L,
ST,
DC,
C,
UNSTRUCTUREDADDRESS,
UNSTRUCTUREDNAME,
POSTALCODE,
BUSINESSCATEGORY,
TELEPHONENUMBER,
PSEUDONYM,
POSTALADDRESS,
STREET,
NAME,
T,
DN,
DESCRIPTION,
INN,
OGRN,
OGRNIP,
SNILS,
INNLE,
UNKNOWN):		Поля разделенного имени субъекта
values (string[]),Значения компонента
editable (boolean),Флаг: компонент доступен для редактирования
subjectAltName:Альтернативное имя субъекта
(enum: RFC822NAME,
DNS_NAME,
IPADDRESS,
DIRECTORY_NAME,
UNIFORM_RESOURCE_ID,
REGISTERED_ID,
MS_UPN,
MS_GUID,
KRB5PRINCIPAL,
PERMANENT_IDENTIFIER,
XMPP_ADDR,
SRV_NAME,
SUBJECT_IDENTIFICATION_METHOD,
UNKNOWN):		Поля альтернативного имени субъекта
values (string[]),Значения компонента
editable (boolean),Флаг: компонент доступен для редактирования
isConnected (boolean),Флаг: субъект подключен к ресурсной системе
isBlocked (boolean),Флаг: субъект заблокирован в ресурсной системе
certificatesCount (integer),Количество сертификатов
modify (instant),Время изменения (ISO 8601)
updated (instant),Время обновления (ISO 8601)
created (instant),Время создания (ISO 8601)
sid (string)SID субъекта

Методы создания и изменения субъекта на основании запроса pkcs#10

Заголовок раздела «Методы создания и изменения субъекта на основании запроса pkcs#10»

Метод создания и изменения субъекта на основании запроса pkcs#10 (формат запроса на сертификат из входных параметров – multipart/form-data)

Заголовок раздела «Метод создания и изменения субъекта на основании запроса pkcs#10 (формат запроса на сертификат из входных параметров – multipart/form-data)»
PUT API – Создание и изменение субъекта на основании запроса pkcs#10 (multipart/form-data)
Метод доступен администратору и оператору при наличии полномочий на управление субъектами
URL – subjects-service/api/v3/public/subjects/pkcs10
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/[v3] Контроллер%3A субъекты/updateByPkcs10AsMultipartFile_1
Query -
Request
Id (UUID) [опционально],Идентификатор субъекта
request (binary),Файл запроса на сертификат (см. пример использования метода ниже).
Допустимые форматы запроса на сертификат: • PEM; • PEM без хидера и футера (“-----BEGIN CERTIFICATE-----” и “-----END CERTIFICATE---“).
subjectAltName: { (enum: RFC822NAME, DNS_NAME, IPADDRESS, DIRECTORY_NAME, UNIFORM_RESOURCE_ID, REGISTERED_ID, MS_UPN, MS_GUID, KRB5PRINCIPAL, PERMANENT_IDENTIFIER, XMPP_ADDR, SRV_NAME, SUBJECT_IDENTIFICATION_METHOD, UNKNOWN): string[] } [опционально\Поля альтернативного имени субъекта
Response ResponseEntity -> ItemResponse ->Ответ JSON в HTTP-body
id (UUID),ID субъекта
commonName (string)Имя субъекта
distinguishedName (string),Расположение субъекта в ресурсной системе
resource:Ресурсная система
id (uuid),ID ресурсной системы
commonName (string),Имя ресурсной системы
distinguishedName (string)BaseDN точки подключения к ресурсной системе
subjectName:Имя субъекта
(enum: CN,
UID,
E,
EMAILADDRESS,
MAIL,
SN,
GIVENNAME,
INITIALS,
SURNAME,
OU,
O,
L,
ST,
DC,
C,
UNSTRUCTUREDADDRESS,
UNSTRUCTUREDNAME,
POSTALCODE,
BUSINESSCATEGORY,
TELEPHONENUMBER,
PSEUDONYM,
POSTALADDRESS,
STREET,
NAME,
T,
DN,
DESCRIPTION,
INN,
OGRN,
OGRNIP,
SNILS,
INNLE,
UNKNOWN):		Поля разделенного имени субъекта
values (string[]),Значения компонента
editable (boolean),Флаг: компонент доступен для редактирования
subjectAltName:Альтернативное имя субъекта
(enum: RFC822NAME,
DNS_NAME,
IPADDRESS,
DIRECTORY_NAME,
UNIFORM_RESOURCE_ID,
REGISTERED_ID,
MS_UPN,
MS_GUID,
KRB5PRINCIPAL,
PERMANENT_IDENTIFIER,
XMPP_ADDR,
SRV_NAME,
SUBJECT_IDENTIFICATION_METHOD,
UNKNOWN):		Поля альтернативного имени субъекта
values (string[]),Значения компонента
editable (boolean),Флаг: компонент доступен для редактирования
isConnected (boolean),Флаг: субъект подключен к ресурсной системе
isBlocked (boolean),Флаг: субъект заблокирован в ресурсной системе
certificatesCount (integer),Количество сертификатов
modify (instant),Время изменения (ISO 8601)
updated (instant),Время обновления (ISO 8601)
created (instant),Время создания (ISO 8601)
sid (string)SID субъекта

Метод создания и изменения субъекта на основании запроса pkcs#10 (формат запроса на сертификат из входных параметров – application/json)

Заголовок раздела «Метод создания и изменения субъекта на основании запроса pkcs#10 (формат запроса на сертификат из входных параметров – application/json)»

Примечание: отличается от метода выше форматом передаваемого во входных параметрах запроса на сертификат. В данном методе на вход поступает содержимое файла запроса на сертификат в формате PEM (содержимое в Base64).

PUT API – Создание и изменение субъекта на основании запроса pkcs#10 (application/json)
Метод доступен администратору и оператору при наличии полномочий на управление субъектами
URL – subjects-service/api/v3/public/subjects/pkcs10
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/[v3] Контроллер%3A субъекты/updateByPkcs10AsMultipartFile_1
Query -
Request
Id (UUID) [опционально],Идентификатор субъекта
request:Файл запроса на сертификат
contentType (string) [опционально],Тип загружаемого файла (HTTP MediaType) - application/octet-stream)
fileName (string) [опционально],Имя загружаемого файла
data (string:binary)Содержимое PEM файла запроса на сертификат (массив байт в Base64) - см. пример использования метода ниже.
Допустимые форматы запроса на сертификат: • PEM; • PEM без хидера и футера (“-----BEGIN CERTIFICATE-----” и “-----END CERTIFICATE---“).
subjectAltName: { (enum: RFC822NAME, DNS_NAME, IPADDRESS, DIRECTORY_NAME, UNIFORM_RESOURCE_ID, REGISTERED_ID, MS_UPN, MS_GUID, KRB5PRINCIPAL, PERMANENT_IDENTIFIER, XMPP_ADDR, SRV_NAME, SUBJECT_IDENTIFICATION_METHOD, UNKNOWN): string[] } [опционально\Поля альтернативного имени субъекта
Response ResponseEntity -> ItemResponse ->Ответ JSON в HTTP-body
id (UUID),ID субъекта
commonName (string)Имя субъекта
distinguishedName (string),Расположение субъекта в ресурсной системе
resource:Ресурсы
id (uuid),ID ресурсной системы
commonName (string),Имя ресурсной системы
distinguishedName (string)BaseDN точки подключения к ресурсной системе
subjectName:Имя субъекта
(enum: CN,
UID,
E,
EMAILADDRESS,
MAIL,
SN,
GIVENNAME,
INITIALS,
SURNAME,
OU,
O,
L,
ST,
DC,
C,
UNSTRUCTUREDADDRESS,
UNSTRUCTUREDNAME,
POSTALCODE,
BUSINESSCATEGORY,
TELEPHONENUMBER,
PSEUDONYM,
POSTALADDRESS,
STREET,
NAME,
T,
DN,
DESCRIPTION,
INN,
OGRN,
OGRNIP,
SNILS,
INNLE,
UNKNOWN):		Поля разделенного имени субъекта
values (string[]),Значения компонента
editable (boolean),Флаг: компонент доступен для редактирования
subjectAltName:Альтернативное имя субъекта
(enum: RFC822NAME,
DNS_NAME,
IPADDRESS,
DIRECTORY_NAME,
UNIFORM_RESOURCE_ID,
REGISTERED_ID,
MS_UPN,
MS_GUID,
KRB5PRINCIPAL,
PERMANENT_IDENTIFIER,
XMPP_ADDR,
SRV_NAME,
SUBJECT_IDENTIFICATION_METHOD,
UNKNOWN):		Поля альтернативного имени субъекта
values (string[]),Значения компонента
editable (boolean),Флаг: компонент доступен для редактирования
isConnected (boolean),Флаг: субъект подключен к ресурсной системе
isBlocked (boolean),Флаг: субъект заблокирован в ресурсной системе
certificatesCount (integer),Количество сертификатов
modify (instant),Время изменения (ISO 8601)
updated (instant),Время обновления (ISO 8601)
created (instant),Время создания (ISO 8601)
sid (string)SID субъекта

Метод удаления субъекта

Заголовок раздела «Метод удаления субъекта»
DELETE API – Удаление субъекта
Метод доступен администратору и оператору при наличии полномочий на локальную РС
URL – subjects-service/api/v3/public/subjects/{id
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/[v3] Контроллер%3A субъекты/deleteById
Query {(id – обязательный параметр)
id (UUID)Идентификатор субъекта
Request -
Response -

Метод поиска идентификаторов субъектов

Заголовок раздела «Метод поиска идентификаторов субъектов»
GET API – Поиск ID субъектов
Метод доступен администратору и оператору
URL – subjects-service/api/v3/public/subjects/ids
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/[v3] Контроллер%3A субъекты/findAllAsIds
Query
search (string) [опционально],Полнотекстовый поиск (имя субъекта)
isBlocked (boolean) [опционально],Флаг: субъект заблокирован в ресурсной системе
isConnected (boolean) [опционально],Флаг: субъект подключен к ресурсной системе
id (UUID[])[опционально],ID субъекта
notId (UUID[])[опционально],Исключая ID субъекта
securityGroupId (UUID[])[опционально],ID группы безопасности
resourceId (UUID[])[опционально],ID ресурсной системы
sortDirection (string) [опционально],Направления сортировки (ASC;DESC)
sortBy (string[])[опционально],Список полей, к которым применяется сортировка
pageOffset (integer) [опционально],Смещение от начала списка (пагинация)
pageLimit (integer) [опциональноОграничение на размер выборки (пагинация)
Request -
Response ResponseEntity -> CollectionResponse ->Ответ JSON в HTTP-body
items (UUID)ID субъекта

Методы работы с шаблонами сертификатов

Заголовок раздела «Методы работы с шаблонами сертификатов»
Сопоставление идентификаторов шаблонов
Идентификатор 1.2.0Идентификатор 2.x
1000019129245a-eaad-4ebc-a2a4-8845ac0336fb
100002af3b0355-1798-4c64-98f7-a9c70407db1c
100003bf2dac0a-f05f-49dd-95b4-e50691489b6a
100004aa03e458-50cd-46b8-82cd-d5612ed3b647
100005aac2e49b-9c8e-4869-80c1-eef526ba75ab
100006059a38f5-f345-4275-b79f-e7e6cc3cbb68
10000708c66f99-218a-46ef-bdee-6a2b3b26a4f1
1000080c234243-18cf-4c05-b699-537731b2436f
10000911ec34a4-d03e-4059-92f0-9c09b08bffea
10001018d9bd4e-6f15-423f-8137-ac8416ad6874

Метод поиска шаблонов

Заголовок раздела «Метод поиска шаблонов»
GET API – Поиск шаблонов
Метод доступен администратору и оператору.
В ответе для оператора содержатся только те шаблоны, на использование которых ему предоставлены полномочия
URL – templates-service/api/v3/public/templates
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/[v3] Контроллер%3A шаблоны/findAll
Query
types (enum[]: EMBEDDED, CLONED, IMPORTED, UNKNOWN) [опционально],Тип шаблона
certificateType (enum[]: CERTIFICATE, ROOT_CA, SUB_CA, UNKNOWN) [опционально],Тип выпускаемого сертификата
endEntityType (enum[]: USER, DEVICE, ROOT_CA, SUB_CA, UNKNOWN) [опционально],Тип субъекта
search (string) [опционально],Полнотекстовый поиск по имени шаблона
removed (boolean) [опционально],Флаг: шаблон удален
id (UUID[])[опционально],ID шаблона
notId (UUID[])[опционально],Исключая ID шаблона
keyAlgorithm (enum[]:RSA, ECDSA, GOST_R_34_10_2012, UNKNOWN) [опционально],Фильтр: алгоритм ключа включен в шаблоне[8]
extendedKeyUsage (string[])[опционально],Фильтр: расширенное использование ключа
isCertificateAuthorityIdEmpty(boolean) [опционально],Фильтр: ID издающего ЦС не задан
sortDirection (string) [опционально],Направления сортировки (ASC;DESC)
sortBy (string[])[опционально],Список полей, к которым применяется сортировка
pageOffset (integer) [опционально],Смещение от начала списка (пагинация)
pageLimit (integer) [опциональноОграничение на размер выборки (пагинация)
Request -
Response ResponseEntity -> CollectionResponse ->Ответ JSON в HTTP-body
id (UUID),ID шаблона
name (string),Имя шаблона
type (enum: EMBEDDED, CLONED, IMPORTED, UNKNOWN),Тип шаблона
certificateType (enum: CERTIFICATE, ROOT_CA, SUB_CA, UNKNOWN),Тип выпускаемого сертификата
certificateAuthorityId (UUID),ID ЦС, который должен использоваться при выпуске сертификата по данному шаблону
endEntityType (enum: USER, DEVICE, ROOT_CA, SUB_CA, UNKNOWN),Тип субъекта
certificateCount (int64),Число выпущенных по шаблону сертификатов
removed (boolean),Флаг: шаблон удален
updated (instant),Время обновления (ISO 8601)
created (instant),Время создания (ISO 8601)
appendSubjectSId (boolean)Флаг: включать SID субъекта в сертификат

Метод получения шаблона по идентификатору

Заголовок раздела «Метод получения шаблона по идентификатору»
GET API – Получение шаблона по идентификатору
Метод доступен:администратору;, оператору при наличии полномочий на использование шаблона, идентификатор которого передается во входных параметрах.В ответе данного метода в поле “subjectDN” компоненты “ROLE” (роль), “DATEOFBIRTH” (дата рождения) и “PLACEOFBIRTH” (место рождения) в случае их наличия в шаблоне будут указаны как “UNKNOWN”.
Данные компоненты поддерживаются в публичном API начиная с версии v4.
URL – templates-service/api/v3/public/templates/{id
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/[v3] Контроллер%3A шаблоны/findById
Query
id (UUID)ID шаблона
Request -
Response ResponseEntity -> ItemResponse ->Ответ JSON в HTTP-body
id (UUID),ID шаблона
name (string),Имя шаблона
type (enum: EMBEDDED, CLONED, IMPORTED, UNKNOWN),Тип шаблона
certificateType (enum: CERTIFICATE, ROOT_CA, SUB_CA, UNKNOWN),Тип выпускаемого сертификата
certificateAuthorityId (UUID),ID ЦС, который должен использоваться при выпуске сертификата по данному шаблону
endEntityType (enum: USER, DEVICE, ROOT_CA, SUB_CA, UNKNOWN),Тип субъекта
removed (boolean),Флаг: шаблон удален
validity (int64),Время действия выпускаемого сертификата (мс)
rsa:Описание RSA-криптографии
use (boolean),Флаг: RSA-ключи доступны для шаблона
minLength (int32),Минимальная длина RSA-ключа
lengths (int32[])Доступные длины RSA-ключа
ecdsa:Описание ESDCA-криптографии
use (boolean),Флаг: ESDCA -ключи доступны для шаблона
minLength (int32),Минимальная длина ESDCA -ключа
lengths (int32[])Доступные длины ESDCA -ключа
gost:Описание ГОСТ-криптографии
use (boolean),Флаг: ГОСТ -ключи доступны для шаблона
minLength (int32),Минимальная длина ГОСТ -ключа
lengths (int32[])Доступные длины ГОСТ -ключа
keyUsage:Назначение ключа сертификата
critical (boolean),Флаг: расширение критическое
values (enum[]:DIGITAL_SIGNATURE, NON_REPUDIATION, KEY_ENCIPHERMENT, DATA_ENCIPHERMENT, KEY_AGREEMENT, KEY_CERT_SIGN, CRL_SIGN, ENCIPHER_ONLY, DECIPHER_ONLY, UNKNOWN)Значение расширения
extendedKeyUsage:Расширенное назначение ключа сертификата
critical (boolean),Флаг: расширение критическое
values (string[])Значение расширения (OIDs)
policies:Политики сертификата
critical (boolean),Флаг: расширение критическое
values (string[])Значение расширения (OIDs)
subjectDN:Имя субъекта сертификата
index (int32),Индекс (для сортировки, по умолчанию – 0)
name (string),Имя компонента
description (string),Описание компонента
required (boolean),Флаг: обязателен к заполнению
validation (boolean),Флаг: валидация значения
modifiable (boolean),Флаг: доступен к редактированию
defaultValue (string),Значение по умолчанию
regex (string),Регулярное значение для валидации значения
alert (string),Предупреждение о неудачной валидации значения
code (enum: CN,
UID,
E,
EMAILADDRESS,
MAIL,
SN,
GIVENNAME,
INITIALS,
SURNAME,
OU,
O,
L,
ST,
DC,
C,
UNSTRUCTUREDADDRESS,
UNSTRUCTUREDNAME,
POSTALCODE,
BUSINESSCATEGORY,
TELEPHONENUMBER,
PSEUDONYM,
POSTALADDRESS,
STREET,
NAME,
T,
DN,
DESCRIPTION,
INN,
OGRN,
OGRNIP,
SNILS,
INNLE,
UNKNOWN)		Код компонента
subjectAltName:Расширенное имя субъекта сертификата
index (int32),Индекс (для сортировки, по умолчанию – 0)
name (string),Имя компонента
description (string),Описание компонента
required (boolean),Флаг: обязателен к заполнению
validation (boolean),Флаг: валидация значения
modifiable (boolean),Флаг: доступен к редактированию
defaultValue (string),Значение по умолчанию
regex (string),Регулярное значение для валидации значения
alert (string),Предупреждение о неудачной валидации значения
code (enum: RFC822NAME,
DNS_NAME,
IPADDRESS,
DIRECTORY_NAME,
UNIFORM_RESOURCE_ID,
REGISTERED_ID,
MS_UPN,
MS_GUID,
KRB5PRINCIPAL,
PERMANENT_IDENTIFIER,
XMPP_ADDR,
SRV_NAME,
SUBJECT_IDENTIFICATION_METHOD,
UNKNOWN),		Код компонента
generalName (int32),Идентификатор компонента в RFC
oid (string)OID компонента в RFC
updated (instant),Время обновления (ISO 8601)
created (instant),Время создания (ISO 8601)
appendSubjectSId (boolean),Флаг: включать SID субъекта в сертификат
publication (boolean)Флаг: публиковать сертификат в РС

Методы работы с Центрами сертификации

Заголовок раздела «Методы работы с Центрами сертификации»

Метод получения активного Центра сертификации

Заголовок раздела «Метод получения активного Центра сертификации»
GET API – Получение активного ЦС
Метод доступен администратору и оператору.
Если активным является центр сертификации, у которого криптопровайдером алгоритма ГОСТ Р 34.10-2012 является Aladdin JCP, в ответе метода данный криптопровайдер будет указан как “UNKNOWN”.
В ответе данного метода в полях “subjectDN” и “issuerDN” компоненты “ROLE” (роль), “DATEOFBIRTH” (дата рождения) и “PLACEOFBIRTH” (место рождения) в случае их наличия в SDN запрашиваемого ЦС или издателя сертификата данного ЦС будут указаны как “UNKNOWN”.
Данные компоненты поддерживаются в публичном API начиная с версии v4.
URL – certificate-authority-service/api/v3/public/certificate-authorities/active
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/[v3] Контроллер%3A Центры сертификации/active
Query -
Request -
Response ResponseEntity -> ItemResponse ->Ответ JSON в HTTP-body
id (UUID),ID ЦС
isActive (boolean),Флаг: активный ЦС
active (boolean),Флаг: активный ЦС
isManagement (boolean),Флаг: технологический ЦС
management (boolean),Флаг: технологический ЦС
certificate:Сертификат ЦС
id (UUID),Идентификатор сертификата ЦС
issuerId (UUID),Идентификатор издателя сертификата ЦС
issuerFingerprint (string),Фингерпринт издателя сертификата ЦС
serialnumber (string),Серийный номер сертификата ЦС
fingerprint (string),Фингерпринт сертификата ЦС
issuerDN:Имя субъекта издателя сертификата ЦС
(enum: CN,
UID,
E,
EMAILADDRESS,
MAIL,
SN,
GIVENNAME,
INITIALS,
SURNAME,
OU,
O,
L,
ST,
DC,
C,
UNSTRUCTUREDADDRESS,
UNSTRUCTUREDNAME,
POSTALCODE,
BUSINESSCATEGORY,
TELEPHONENUMBER,
PSEUDONYM,
POSTALADDRESS,
STREET,
NAME,
T,
DN,
DESCRIPTION,
INN,
OGRN,
OGRNIP,
SNILS,
INNLE,
UNKNOWN): string		Поля разделенного имени субъекта издателя из сертификата.
В формате key-value.
Где key – один из перечисленных в enum параметров, а value – значение параметра
subjectDN:Имя субъекта сертификата ЦС
(enum: CN,
UID,
E,
EMAILADDRESS,
MAIL,
SN,
GIVENNAME,
INITIALS,
SURNAME,
OU,
O,
L,
ST,
DC,
C,
UNSTRUCTUREDADDRESS,
UNSTRUCTUREDNAME,
POSTALCODE,
BUSINESSCATEGORY,
TELEPHONENUMBER,
PSEUDONYM,
POSTALADDRESS,
STREET,
NAME,
T,
DN,
DESCRIPTION,
INN,
OGRN,
OGRNIP,
SNILS,
INNLE,
UNKNOWN): string		Поля разделенного имени субъекта из сертификата.
В формате key-value.
Где key – один из перечисленных в enum параметров, а value – значение параметра
subjectAltName:Альтернативное имя субъекта сертификата ЦС
(enum: RFC822NAME,
DNS_NAME,
IPADDRESS,
DIRECTORY_NAME,
UNIFORM_RESOURCE_ID,
REGISTERED_ID,
MS_UPN,
MS_GUID,
KRB5PRINCIPAL,
PERMANENT_IDENTIFIER,
XMPP_ADDR,
SRV_NAME,
SUBJECT_IDENTIFICATION_METHOD,
UNKNOWN): string		Поля альтернативного имени субъекта из сертификата.
В формате key-value.
Где key – один из перечисленных в enum параметров, а value – значение параметра
name (string),Имя сертификата ЦС (на основе CN)
templateId (UUID),Идентификатор шаблона
templateName (string),Имя шаблона
validFrom (instant),Дата начала действия сертификата ЦС (ISO 8601)
validTo (instant),Дата окончания действия сертификата ЦС (ISO 8601)
status (enum: ACTIVE, HOLD, REVOKE, REQUEST, UNKNOWN),Статус сертификата ЦС
isValid (boolean),Флаг: сертификат ЦС действует
isExpired (boolean),Флаг: сертификат ЦС истек
actions:Доступные действия по выгрузке
p12 (boolean),Флаг: выгрузка pkcs12
csr (boolean),Флаг: выгрузка pkcs10
pem (boolean)Флаг: выгрузка сертификата
revocation:Сведения об отзыве сертификата ЦС
date (instant),Дата отзыва
number (int32),Код причины отзыва
value (string)Значение причины отзыва
hashAlgorithm (enum: SHA1, SHA256, SHA384, SHA512, SHA3_256, SHA3_384, SHA3_512, RSASSA_PSS, MD5, GOST_R_34_11_2012, UNKNOWN),Алгоритм подписи сертификата ЦС
keyAlgorithm (enum: RSA, ECDSA, GOST_R_34_10_2012, UNKNOWN),Алгоритм ключа сертификата ЦС
keyBits (int32),Длина ключа сертификата ЦС
subjectKeyIdentifier (string),Идентификатор ключа сертификата ЦС
authorityKeyIdentifier (string),Идентификатор ключа издателя сертификата ЦС
updated (instant),Время обновления (ISO 8601)
created (instant)Время создания (ISO 8601)
chain:Цепочка сертификатов ЦС (рекурсивный объект)
id (UUID),Идентификатор сертификата
name (string),Имя сертификата (на основе CN)
subjectDN:Имя субъекта сертификата ЦС
(enum: CN,
UID,
E,
EMAILADDRESS,
MAIL,
SN,
GIVENNAME,
INITIALS,
SURNAME,
OU,
O,
L,
ST,
DC,
C,
UNSTRUCTUREDADDRESS,
UNSTRUCTUREDNAME,
POSTALCODE,
BUSINESSCATEGORY,
TELEPHONENUMBER,
PSEUDONYM,
POSTALADDRESS,
STREET,
NAME,
T,
DN,
DESCRIPTION,
INN,
OGRN,
OGRNIP,
SNILS,
INNLE,
UNKNOWN): string		Поля разделенного имени субъекта из сертификата.
В формате key-value.
Где key – один из перечисленных в enum параметров, а value – значение параметра
issuer: {…Издатель сертификата (вложенный объект)
certificateCount (int64),Число выпущенных сертификатов
title (string),Отображаемое имя ЦС
cryptographyProviders:Конфигурация криптопровайдеров алгоритмов ЦС
(enum: RSA, ECDSA, GOST_R_34_10_2012, UNKNOWN):Название алгоритма
cryptographyProvider (enum: DEFAULT, CRYPTO_PRO, UNKNOWN),Название криптопровайдера
isAvailable (boolean),Флаг: Доступность криптопровайдера
primaryCryptographyProvider:Криптопровайдер закрытого ключа
cryptographyProvider (enum: DEFAULT, CRYPTO_PRO, UNKNOWN),Название криптопровайдера
isAvailable (boolean),Флаг: Доступность криптопровайдера
isAvailable (boolean),Флаг: Доступность ЦС
updated (instant),Время обновления (ISO 8601)
created (instant)Время создания (ISO 8601)

Метод получения Центра сертификации по идентификатору

Заголовок раздела «Метод получения Центра сертификации по идентификатору»
GET API – Получение ЦС по идентификатору
Метод доступен администратору.
Если с помощью данного метода будет запрошен центр сертификации, у которого криптопровайдером алгоритма ГОСТ Р 34.10-2012 является Aladdin JCP, в ответе метода данный криптопровайдер будет указан как “UNKNOWN”.
В ответе данного метода в полях “subjectDN” и “issuerDN” компоненты “ROLE” (роль), “DATEOFBIRTH” (дата рождения) и “PLACEOFBIRTH” (место рождения) в случае их наличия в SDN запрашиваемого ЦС или издателя сертификата данного ЦС будут указаны как “UNKNOWN”.
Данные компоненты поддерживаются в публичном API начиная с версии v4.
URL – certificate-authority-service/api/v3/public/certificate-authorities/{id
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/[v3] Контроллер%3A Центры сертификации/findById_14
Query
id (UUID)ID ЦС
Request -
Response ResponseEntity -> ItemResponse ->Ответ JSON в HTTP-body
id (UUID),ID ЦС
isActive (boolean),Флаг: активный ЦС
active (boolean),Флаг: активный ЦС
isManagement (boolean),Флаг: технологический ЦС
management (boolean),Флаг: технологический ЦС
certificate:Сертификат ЦС
id (UUID),Идентификатор сертификата ЦС
issuerId (UUID),Идентификатор издателя сертификата ЦС
issuerFingerprint (string),Фингерпринт издателя сертификата ЦС
serialnumber (string),Серийный номер сертификата ЦС
fingerprint (string),Фингерпринт сертификата ЦС
issuerDN:Имя субъекта издателя сертификата ЦС
(enum: CN,
UID,
E,
EMAILADDRESS,
MAIL,
SN,
GIVENNAME,
INITIALS,
SURNAME,
OU,
O,
L,
ST,
DC,
C,
UNSTRUCTUREDADDRESS,
UNSTRUCTUREDNAME,
POSTALCODE,
BUSINESSCATEGORY,
TELEPHONENUMBER,
PSEUDONYM,
POSTALADDRESS,
STREET,
NAME,
T,
DN,
DESCRIPTION,
INN,
OGRN,
OGRNIP,
SNILS,
INNLE,
UNKNOWN): string		Поля разделенного имени субъекта издателя из сертификата.
В формате key-value.
Где key – один из перечисленных в enum параметров, а value – значение параметра
subjectDN:Имя субъекта сертификата ЦС
(enum: CN,
UID,
E,
EMAILADDRESS,
MAIL,
SN,
GIVENNAME,
INITIALS,
SURNAME,
OU,
O,
L,
ST,
DC,
C,
UNSTRUCTUREDADDRESS,
UNSTRUCTUREDNAME,
POSTALCODE,
BUSINESSCATEGORY,
TELEPHONENUMBER,
PSEUDONYM,
POSTALADDRESS,
STREET,
NAME,
T,
DN,
DESCRIPTION,
INN,
OGRN,
OGRNIP,
SNILS,
INNLE,
UNKNOWN): string		Поля разделенного имени субъекта из сертификата.
В формате key-value.
Где key – один из перечисленных в enum параметров, а value – значение параметра
subjectAltName:Альтернативное имя субъекта сертификата ЦС
(enum: RFC822NAME,
DNS_NAME,
IPADDRESS,
DIRECTORY_NAME,
UNIFORM_RESOURCE_ID,
REGISTERED_ID,
MS_UPN,
MS_GUID,
KRB5PRINCIPAL,
PERMANENT_IDENTIFIER,
XMPP_ADDR,
SRV_NAME,
SUBJECT_IDENTIFICATION_METHOD,
UNKNOWN): string		Поля альтернативного имени субъекта из сертификата.
В формате key-value.
Где key – один из перечисленных в enum параметров, а value – значение параметра
name (string),Имя сертификата ЦС (на основе CN)
templateId (UUID),Идентификатор шаблона
templateName (string),Имя шаблона
validFrom (instant),Дата начала действия сертификата ЦС (ISO 8601)
validTo (instant),Дата окончания действия сертификата ЦС (ISO 8601)
status (enum: ACTIVE, HOLD, REVOKE, REQUEST, UNKNOWN),Статус сертификата ЦС
isValid (boolean),Флаг: сертификат ЦС действует
isExpired (boolean),Флаг: сертификат ЦС истек
actions:Доступные действия по выгрузке
p12 (boolean),Флаг: выгрузка pkcs12
csr (boolean),Флаг: выгрузка pkcs10
pem (boolean)Флаг: выгрузка сертификата
revocation:Сведения об отзыве сертификата ЦС
date (instant),Дата отзыва
number (int32),Код причины отзыва
value (string)Значение причины отзыва
hashAlgorithm (enum: SHA1, SHA256, SHA384, SHA512, SHA3_256, SHA3_384, SHA3_512, RSASSA_PSS, MD5, GOST_R_34_11_2012, UNKNOWN),Алгоритм подписи сертификата ЦС
keyAlgorithm (enum: RSA, ECDSA, GOST_R_34_10_2012, UNKNOWN),Алгоритм ключа сертификата ЦС
keyBits (int32),Длина ключа сертификата ЦС
subjectKeyIdentifier (string),Идентификатор ключа сертификата ЦС
authorityKeyIdentifier (string),Идентификатор ключа издателя сертификата ЦС
updated (instant),Время обновления (ISO 8601)
created (instant)Время создания (ISO 8601)
chain:Цепочка сертификатов ЦС (рекурсивный объект)
id (UUID),Идентификатор сертификата
name (string),Имя сертификата (на основе CN)
subjectDN:Имя субъекта сертификата ЦС
(enum: CN,
UID,
E,
EMAILADDRESS,
MAIL,
SN,
GIVENNAME,
INITIALS,
SURNAME,
OU,
O,
L,
ST,
DC,
C,
UNSTRUCTUREDADDRESS,
UNSTRUCTUREDNAME,
POSTALCODE,
BUSINESSCATEGORY,
TELEPHONENUMBER,
PSEUDONYM,
POSTALADDRESS,
STREET,
NAME,
T,
DN,
DESCRIPTION,
INN,
OGRN,
OGRNIP,
SNILS,
INNLE,
UNKNOWN): string		Поля разделенного имени субъекта из сертификата.
В формате key-value.
Где key – один из перечисленных в enum параметров, а value – значение параметра
issuer: {…Издатель сертификата (вложенный объект)
certificateCount (int64),Число выпущенных сертификатов
title (string),Отображаемое имя ЦС
cryptographyProviders:Конфигурация криптопровайдеров алгоритмов ЦС
(enum: RSA, ECDSA, GOST_R_34_10_2012, UNKNOWN):Название алгоритма
cryptographyProvider (enum: DEFAULT, CRYPTO_PRO, UNKNOWN),Название криптопровайдера
isAvailable (boolean),Флаг: Доступность криптопровайдера
primaryCryptographyProvider:Криптопровайдер закрытого ключа
cryptographyProvider (enum: DEFAULT, CRYPTO_PRO, UNKNOWN),Название криптопровайдера
isAvailable (boolean),Флаг: Доступность криптопровайдера
isAvailable (boolean),Флаг: Доступность ЦС
updated (instant),Время обновления (ISO 8601)
created (instant)Время создания (ISO 8601)

Метод получения Центров сертификации

Заголовок раздела «Метод получения Центров сертификации»
GET API – Получение ЦС
Метод доступен администратору Для центров сертификации, у которых криптопровайдером алгоритма ГОСТ Р 34.10-2012 является Aladdin JCP, в ответе метода данный криптопровайдер будет указан как “UNKNOWN”.
В ответе данного метода в полях “subjectDN” и “issuerDN” компоненты “ROLE” (роль), “DATEOFBIRTH” (дата рождения) и “PLACEOFBIRTH” (место рождения) в случае их наличия в SDN запрашиваемого ЦС или издателя сертификата данного ЦС будут указаны как “UNKNOWN”.
Данные компоненты поддерживаются в публичном API начиная с версии v4.
URL – certificate-authority-service/api/v3/public/certificate-authorities
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/[v3] Контроллер%3A Центры сертификации/findAll_15
Query
status (enum[]:ACTIVE, HOLD, REVOKE, REQUEST, UNKNOWN) [опционально],Статус сертификата ЦС
type (enum[]: CERTIFICATE[9], ROOT_CA, SUB_CA, UNKNOWN) [опционально],Тип сертификата ЦС
search (string) [опционально],Полнотекстовый поиск по имени ЦС
isManagement (boolean) [опционально],Флаг: технологический ЦС
isActive (boolean) [опционально],Флаг: активный ЦС
isValid (boolean) [опционально],Флаг: сертификат ЦС действителен
isExpired (boolean) [опционально],Флаг: сертификат ЦС истек
Id (UUID[])[опционально],Id ЦС
notIds (UUID[])[опционально],Исключая ID ЦС
sortDirection (string) [опционально],Направления сортировки (ASC;DESC)
endEntityType (enum[]: ROOT_CA, SUB_CA, USER, DEVICE, UNKNOWN) [опционально],Тип субъекта
sortBy (string[])[опционально],Список полей, к которым применяется сортировка
pageOffset (integer) [опционально],Смещение от начала списка (пагинация)
pageLimit (integer) [опциональноОграничение на размер выборки (пагинация)
Request -
Response ResponseEntity -> CollectionResponse ->Ответ JSON в HTTP-body
id (UUID),ID ЦС
isActive (boolean),Флаг: активный ЦС
active (boolean),Флаг: активный ЦС
isManagement (boolean),Флаг: технологический ЦС
management (boolean),Флаг: технологический ЦС
certificate:Сертификат ЦС
id (UUID),Идентификатор сертификата ЦС
issuerId (UUID),Идентификатор издателя сертификата ЦС
issuerFingerprint (string),Фингерпринт издателя сертификата ЦС
serialnumber (string),Серийный номер сертификата ЦС
fingerprint (string),Фингерпринт сертификата ЦС
issuerDN:Имя субъекта издателя сертификата ЦС
(enum: CN,
UID,
E,
EMAILADDRESS,
MAIL,
SN,
GIVENNAME,
INITIALS,
SURNAME,
OU,
O,
L,
ST,
DC,
C,
UNSTRUCTUREDADDRESS,
UNSTRUCTUREDNAME,
POSTALCODE,
BUSINESSCATEGORY,
TELEPHONENUMBER,
PSEUDONYM,
POSTALADDRESS,
STREET,
NAME,
T,
DN,
DESCRIPTION,
INN,
OGRN,
OGRNIP,
SNILS,
INNLE,
UNKNOWN): string		Поля разделенного имени субъекта издателя из сертификата.
В формате key-value.
Где key – один из перечисленных в enum параметров, а value – значение параметра
subjectDN:Имя субъекта сертификата ЦС
(enum: CN,
UID,
E,
EMAILADDRESS,
MAIL,
SN,
GIVENNAME,
INITIALS,
SURNAME,
OU,
O,
L,
ST,
DC,
C,
UNSTRUCTUREDADDRESS,
UNSTRUCTUREDNAME,
POSTALCODE,
BUSINESSCATEGORY,
TELEPHONENUMBER,
PSEUDONYM,
POSTALADDRESS,
STREET,
NAME,
T,
DN,
DESCRIPTION,
INN,
OGRN,
OGRNIP,
SNILS,
INNLE,
UNKNOWN): string		Поля разделенного имени субъекта из сертификата.
В формате key-value.
Где key – один из перечисленных в enum параметров, а value – значение параметра
subjectAltName:Альтернативное имя субъекта сертификата ЦС
(enum: RFC822NAME,
DNS_NAME,
IPADDRESS,
DIRECTORY_NAME,
UNIFORM_RESOURCE_ID,
REGISTERED_ID,
MS_UPN,
MS_GUID,
KRB5PRINCIPAL,
PERMANENT_IDENTIFIER,
XMPP_ADDR,
SRV_NAME,
SUBJECT_IDENTIFICATION_METHOD,
UNKNOWN): string		Поля альтернативного имени субъекта из сертификата.
В формате key-value.
Где key – один из перечисленных в enum параметров, а value – значение параметра
name (string),Имя сертификата ЦС (на основе CN)
templateId (UUID),Идентификатор шаблона
templateName (string),Имя шаблона
validFrom (instant),Дата начала действия сертификата ЦС (ISO 8601)
validTo (instant),Дата окончания действия сертификата ЦС (ISO 8601)
status (enum: ACTIVE, HOLD, REVOKE, REQUEST, UNKNOWN),Статус сертификата ЦС
isValid (boolean),Флаг: сертификат ЦС действует
isExpired (boolean),Флаг: сертификат ЦС истек
actions:Доступные действия по выгрузке
p12 (boolean),Флаг: выгрузка pkcs12
csr (boolean),Флаг: выгрузка pkcs10
pem (boolean)Флаг: выгрузка сертификата
revocation:Сведения об отзыве сертификата ЦС
date (instant),Дата отзыва
number (int32),Код причины отзыва
value (string)Значение причины отзыва
hashAlgorithm (enum: SHA1, SHA256, SHA384, SHA512, SHA3_256, SHA3_384, SHA3_512, RSASSA_PSS, MD5, GOST_R_34_11_2012, UNKNOWN),Алгоритм подписи сертификата ЦС
keyAlgorithm (enum: RSA, ECDSA, GOST_R_34_10_2012, UNKNOWN),Алгоритм ключа сертификата ЦС
keyBits (int32),Длина ключа сертификата ЦС
subjectKeyIdentifier (string),Идентификатор ключа сертификата ЦС
authorityKeyIdentifier (string),Идентификатор ключа издателя сертификата ЦС
updated (instant),Время обновления (ISO 8601)
created (instant)Время создания (ISO 8601)
chain:Цепочка сертификатов ЦС (рекурсивный объект)
id (UUID),Идентификатор сертификата
name (string),Имя сертификата (на основе CN)
subjectDN:Имя субъекта сертификата ЦС
(enum: CN,
UID,
E,
EMAILADDRESS,
MAIL,
SN,
GIVENNAME,
INITIALS,
SURNAME,
OU,
O,
L,
ST,
DC,
C,
UNSTRUCTUREDADDRESS,
UNSTRUCTUREDNAME,
POSTALCODE,
BUSINESSCATEGORY,
TELEPHONENUMBER,
PSEUDONYM,
POSTALADDRESS,
STREET,
NAME,
T,
DN,
DESCRIPTION,
INN,
OGRN,
OGRNIP,
SNILS,
INNLE,
UNKNOWN): string		Поля разделенного имени субъекта из сертификата.
В формате key-value.
Где key – один из перечисленных в enum параметров, а value – значение параметра
issuer: {…Издатель сертификата (вложенный объект)
certificateCount (int64),Число выпущенных сертификатов
title (string),Отображаемое имя ЦС
cryptographyProviders:Конфигурация криптопровайдеров алгоритмов ЦС
(enum: RSA, ECDSA, GOST_R_34_10_2012, UNKNOWN):Название алгоритма
cryptographyProvider (enum: DEFAULT, CRYPTO_PRO, UNKNOWN),Название криптопровайдера
isAvailable (boolean),Флаг: Доступность криптопровайдера
primaryCryptographyProvider:Криптопровайдер закрытого ключа
cryptographyProvider (enum: DEFAULT, CRYPTO_PRO, UNKNOWN),Название криптопровайдера
isAvailable (boolean),Флаг: Доступность криптопровайдера
isAvailable (boolean),Флаг: Доступность ЦС
updated (instant),Время обновления (ISO 8601)
created (instant)Время создания (ISO 8601)

Методы работы с сертификатами

Заголовок раздела «Методы работы с сертификатами»

Метод выпуска сертификата в контейнере pkcs#12

Заголовок раздела «Метод выпуска сертификата в контейнере pkcs#12»
POST API – Выпуск сертификата в контейнере pkcs#12
Метод доступен:администратору;, оператору при наличии полномочий на управление сертификатами субъектов и использование шаблона, идентификаторы которых передаются во входных параметрах.Использование данного метода оператором для создания сертификатов для учетных записей запрещено.
В используемом шаблоне должна быть включена опция “Выпуск сертификатов с закрытым ключом (PKCS#12)”, иначе метод вернет сообщение об ошибке с кодом 400 и текстом “Выпуск сертификатов с закрытым ключом (PKCS#12) недоступен по данному шаблону”.
Указываемый во входных параметрах пароль от контейнера должен соответствовать требованиям регулярного выражения по шаблону, иначе метод вернет сообщение об ошибке с кодом 400 и текстом “Пароль не соответствует регулярному выражению, указанному в шаблоне”.
URL – certificate-authority-service/api/v3/public/certificates/enroll/{caId
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/[v3] Контроллер%3A сертификаты/enrollByCaId
Query
caId (UUID),ID ЦС
subjectId (UUID) [обязателен, если не указан userId],ID субъекта
userId (UUID) [обязателен, если не указан subjectIdID учетной записи
Request
templateId (UUID),Идентификатор шаблона[10]
subjectDN: { (enum: CN, UID, E, EMAILADDRESS, MAIL, SN, GIVENNAME, INITIALS, SURNAME, OU, O, L, ST, DC, C, UNSTRUCTUREDADDRESS, UNSTRUCTUREDNAME, POSTALCODE, BUSINESSCATEGORY, TELEPHONENUMBER, PSEUDONYM, POSTALADDRESS, STREET, NAME, T, DN, DESCRIPTION, INN, OGRN, OGRNIP, SNILS, INNLE, UNKNOWN): string[] },Поля разделенного имени субъекта, которое должно попасть в сертификат.
В формате key-value.
Где key – один из перечисленных в enum параметров, а value – значение параметра.
При использовании шаблона с включенной опцией “Контролировать соответствие полей в сертификате атрибутам субъекта” указываемые значения полей должны соответствовать значениям аналогичных атрибутов субъекта.
Отключение данной опции в шаблоне позволяет записывать в поля сертификата любые (в соответствии с регулярными выражениями полей) значения, не соответствующие атрибутам субъекта.
subjectAltName: { (enum: RFC822NAME, DNS_NAME, IPADDRESS, DIRECTORY_NAME, UNIFORM_RESOURCE_ID, REGISTERED_ID, MS_UPN, MS_GUID, KRB5PRINCIPAL, PERMANENT_IDENTIFIER, XMPP_ADDR, SRV_NAME, SUBJECT_IDENTIFICATION_METHOD, UNKNOWN): string[] },Поля альтернативного имени субъекта, которое должно попасть в сертификат.
В формате key-value.
Где key – один из перечисленных в enum параметров, а value – значение параметра.
При использовании шаблона с включенной опцией “Контролировать соответствие полей в сертификате атрибутам субъекта” указываемые значения полей должны соответствовать значениям аналогичных атрибутов субъекта.
Отключение данной опции в шаблоне позволяет записывать в поля сертификата любые (в соответствии с регулярными выражениями полей) значения, не соответствующие атрибутам субъекта.
keyBits (integer),Длина ключа
keyAlgorithm (enum: RSA, ECDSA, GOST_R_34_10_2012, UNKNOWN),Алгоритм ключевой пары сертификата
password (string)Пароль контейнера
Response ResponseEntity -> ItemResponse ->Ответ JSON в HTTP-body
id (UUID),ID сертификата
downloadActions:Доступные действия по выгрузке
p12 (boolean),Флаг: выгрузка pkcs12
csr (boolean),Флаг: выгрузка pkcs10
pem (boolean)Флаг: выгрузка сертификата
fingerprint (string),Фингерпринт шаблона
serialNumber (string),Серийный номер сертификата
templateId (UUID),ID шаблона
templateName (string),Имя шаблона
name (string),Имя сертификата (на основе CN)
issuerDN: { (enum: CN, UID, E, EMAILADDRESS, MAIL, SN, GIVENNAME, INITIALS, SURNAME, OU, O, L, ST, DC, C, UNSTRUCTUREDADDRESS, UNSTRUCTUREDNAME, POSTALCODE, BUSINESSCATEGORY, TELEPHONENUMBER, PSEUDONYM, POSTALADDRESS, STREET, NAME, T, DN, DESCRIPTION, INN, OGRN, OGRNIP, SNILS, INNLE, UNKNOWN): string[] },Поля разделенного имени субъекта издателя из сертификата.
В формате key-value.
Где key – один из перечисленных в enum параметров, а value – значение параметра
subjectDN: { (enum: CN, UID, E, EMAILADDRESS, MAIL, SN, GIVENNAME, INITIALS, SURNAME, OU, O, L, ST, DC, C, UNSTRUCTUREDADDRESS, UNSTRUCTUREDNAME, POSTALCODE, BUSINESSCATEGORY, TELEPHONENUMBER, PSEUDONYM, POSTALADDRESS, STREET, NAME, T, DN, DESCRIPTION, INN, OGRN, OGRNIP, SNILS, INNLE, UNKNOWN): string[] },Поля разделенного имени субъекта из сертификата.
В формате key-value.
Где key – один из перечисленных в enum параметров, а value – значение параметра
subjectAltName: { (enum: RFC822NAME, DNS_NAME, IPADDRESS, DIRECTORY_NAME, UNIFORM_RESOURCE_ID, REGISTERED_ID, MS_UPN, MS_GUID, KRB5PRINCIPAL, PERMANENT_IDENTIFIER, XMPP_ADDR, SRV_NAME, SUBJECT_IDENTIFICATION_METHOD, UNKNOWN): string[] },Поля альтернативного имени субъекта из сертификата.
В формате key-value.
Где key – один из перечисленных в enum параметров, а value – значение параметра
validFrom (instant),Дата начала действия сертификата (ISO 8601)
validTo (instant)Дата окончания действия сертификата (ISO 8601)

Методы выпуска сертификата по запросу pkcs#10

Заголовок раздела «Методы выпуска сертификата по запросу pkcs#10»

Выпуск сертификата по запросу pkcs#10 (формат запроса на сертификат из входных параметров – multipart/form-data)

Заголовок раздела «Выпуск сертификата по запросу pkcs#10 (формат запроса на сертификат из входных параметров – multipart/form-data)»
POST API – Выпуск сертификата по запросу pkcs#10 (multipart/form-data)
Метод доступен:администратору;, оператору при наличии полномочий на управление сертификатами субъектов и использование шаблона, идентификаторы которых передаются во входных параметрах.Использование данного метода оператором для создания сертификатов для учетных записей запрещено.
URL – certificate-authority-service/api/v3/public/certificates/enroll/{caId}/pkcs10
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/[v3] Контроллер%3A сертификаты/enrollRequestByCaId_1
Query
caId (UUID),ID ЦС
subjectId (UUID) [обязателен, если не указан userId],ID субъекта
userId (UUID) [обязателен, если не указан subjectIdID учетной записи
Request
templateId (UUID),Идентификатор шаблона[11]
request (binary),Файл запроса на сертификат (см. пример использования метода ниже.
При использовании шаблона с включенной опцией “Контролировать соответствие полей в сертификате атрибутам субъекта” значения полей запроса на сертификат должны соответствовать значениям аналогичных атрибутов субъекта.
Отключение данной опции в шаблоне позволяет записывать в поля сертификата любые (в соответствии с регулярными выражениями полей) значения, не соответствующие атрибутам субъекта.
Допустимые форматы запроса на сертификат: • PEM; • PEM без хидера и футера (“-----BEGIN CERTIFICATE-----” и “-----END CERTIFICATE---“).
subjectName: { (enum: CN, UID, E, EMAILADDRESS, MAIL, SN, GIVENNAME, INITIALS, SURNAME, OU, O, L, ST, DC, C, UNSTRUCTUREDADDRESS, UNSTRUCTUREDNAME, POSTALCODE, BUSINESSCATEGORY, TELEPHONENUMBER, PSEUDONYM, POSTALADDRESS, STREET, NAME, T, DN, DESCRIPTION, INN, OGRN, OGRNIP, SNILS, INNLE, UNKNOWN): string[] },[опционально\Поля отличительного имени субъекта, которое должно попасть в сертификат.
В формате key-value.
Где key – один из перечисленных в enum параметров, а value – значение параметра.
Значения полей, указанные в subjectName, переопределяют значения соответствующих полей SDN запроса на сертификат, при условии, что они соответствуют значениям атрибутов субъекта.
При использовании шаблона с включенной опцией “Контролировать соответствие полей в сертификате атрибутам субъекта” указываемые значения полей должны соответствовать значениям аналогичных атрибутов субъекта.
Отключение данной опции в шаблоне позволяет записывать в поля сертификата любые (в соответствии с регулярными выражениями полей) значения, не соответствующие атрибутам субъекта.
subjectAltName: { (enum: RFC822NAME, DNS_NAME, IPADDRESS, DIRECTORY_NAME, UNIFORM_RESOURCE_ID, REGISTERED_ID, MS_UPN, MS_GUID, KRB5PRINCIPAL, PERMANENT_IDENTIFIER, XMPP_ADDR, SRV_NAME, SUBJECT_IDENTIFICATION_METHOD, UNKNOWN): string[] } [опционально\Поля альтернативного имени субъекта, которое должно попасть в сертификат.
В формате key-value.
Где key – один из перечисленных в enum параметров, а value – значение параметра.
Значения полей, указанные в subjectAltName, переопределяют значения соответствующих полей SAN запроса на сертификат, при условии, что они соответствуют значениям атрибутов субъекта.
При использовании шаблона с включенной опцией “Контролировать соответствие полей в сертификате атрибутам субъекта” указываемые значения полей должны соответствовать значениям аналогичных атрибутов субъекта.
Отключение данной опции в шаблоне позволяет записывать в поля сертификата любые (в соответствии с регулярными выражениями полей) значения, не соответствующие атрибутам субъекта.
Response ResponseEntity -> ItemResponse ->Ответ JSON в HTTP-body
id (UUID),ID сертификата
downloadActions:Доступные действия по выгрузке
p12 (boolean),Флаг: выгрузка pkcs12
csr (boolean),Флаг: выгрузка pkcs10
pem (boolean)Флаг: выгрузка сертификата
fingerprint (string),Фингерпринт шаблона
serialNumber (string),Серийный номер сертификата
templateId (UUID),ID шаблона
templateName (string),Имя шаблона
name (string),Имя сертификата (на основе CN)
issuerDN: { (enum: CN, UID, E, EMAILADDRESS, MAIL, SN, GIVENNAME, INITIALS, SURNAME, OU, O, L, ST, DC, C, UNSTRUCTUREDADDRESS, UNSTRUCTUREDNAME, POSTALCODE, BUSINESSCATEGORY, TELEPHONENUMBER, PSEUDONYM, POSTALADDRESS, STREET, NAME, T, DN, DESCRIPTION, INN, OGRN, OGRNIP, SNILS, INNLE, UNKNOWN): string[] },Поля разделенного имени субъекта издателя из сертификата.
В формате key-value.
Где key – один из перечисленных в enum параметров, а value – значение параметра
subjectDN: { (enum: CN, UID, E, EMAILADDRESS, MAIL, SN, GIVENNAME, INITIALS, SURNAME, OU, O, L, ST, DC, C, UNSTRUCTUREDADDRESS, UNSTRUCTUREDNAME, POSTALCODE, BUSINESSCATEGORY, TELEPHONENUMBER, PSEUDONYM, POSTALADDRESS, STREET, NAME, T, DN, DESCRIPTION, INN, OGRN, OGRNIP, SNILS, INNLE, UNKNOWN): string[] },Поля разделенного имени субъекта из сертификата.
В формате key-value.
Где key – один из перечисленных в enum параметров, а value – значение параметра
subjectAltName: { (enum: RFC822NAME, DNS_NAME, IPADDRESS, DIRECTORY_NAME, UNIFORM_RESOURCE_ID, REGISTERED_ID, MS_UPN, MS_GUID, KRB5PRINCIPAL, PERMANENT_IDENTIFIER, XMPP_ADDR, SRV_NAME, SUBJECT_IDENTIFICATION_METHOD, UNKNOWN): string[] },Поля альтернативного имени субъекта из сертификата.
В формате key-value.
Где key – один из перечисленных в enum параметров, а value – значение параметра
validFrom (instant),Дата начала действия сертификата (ISO 8601)
validTo (instant)Дата окончания действия сертификата (ISO 8601)

Выпуск сертификата по запросу pkcs#10 (формат запроса на сертификат из входных параметров – application/json)

Заголовок раздела «Выпуск сертификата по запросу pkcs#10 (формат запроса на сертификат из входных параметров – application/json)»

Примечание: отличается от метода выше форматом передаваемого во входных параметрах запроса на сертификат. В данном методе на вход поступает содержимое файла запроса на сертификат в формате PEM (содержимое в Base64).

POST API – Выпуск сертификата по запросу pkcs#10 (application/json)
Метод доступен:администратору;, оператору при наличии полномочий на управление сертификатами субъектов и использование шаблона, идентификаторы которых передаются во входных параметрах.Использование данного метода оператором для создания сертификатов для учетных записей запрещено.
URL – certificate-authority-service/api/v3/public/certificates/enroll/{caId}/pkcs10
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/[v3] Контроллер%3A сертификаты/enrollRequestByCaId_1
Query
caId (UUID),ID ЦС
subjectId (UUID) [обязателен, если не указан userId],ID субъекта
userId (UUID) [обязателен, если не указан subjectIdID учетной записи
Request
templateId (UUID),Идентификатор шаблона[12]
request:Запрос на сертификат
contentType(string) [опционально],Тип загружаемого файла (HTTP MediaType) - application/octet-stream)
fileName (string) [опционально],Имя загружаемого файла
data (string:binary)Содержимое PEM файла запроса на сертификат (массив байт в Base64) – см. пример использования метода ниже.
При использовании шаблона с включенной опцией “Контролировать соответствие полей в сертификате атрибутам субъекта” значения полей запроса на сертификат должны соответствовать значениям аналогичных атрибутов субъекта.
Отключение данной опции в шаблоне позволяет записывать в поля сертификата любые (в соответствии с регулярными выражениями полей) значения, не соответствующие атрибутам субъекта.
Допустимые форматы запроса на сертификат: • PEM; • PEM без хидера и футера (“-----BEGIN CERTIFICATE-----” и “-----END CERTIFICATE---“).
subjectName: { (enum: CN, UID, E, EMAILADDRESS, MAIL, SN, GIVENNAME, INITIALS, SURNAME, OU, O, L, ST, DC, C, UNSTRUCTUREDADDRESS, UNSTRUCTUREDNAME, POSTALCODE, BUSINESSCATEGORY, TELEPHONENUMBER, PSEUDONYM, POSTALADDRESS, STREET, NAME, T, DN, DESCRIPTION, INN, OGRN, OGRNIP, SNILS, INNLE, UNKNOWN): string[] },[опционально\Поля отличительного имени субъекта, которое должно попасть в сертификат.
В формате key-value.
Где key – один из перечисленных в enum параметров, а value – значение параметра.
Значения полей, указанные в subjectName, переопределяют значения соответствующих полей SDN запроса на сертификат, при условии, что они соответствуют значениям атрибутов субъекта.
При использовании шаблона с включенной опцией “Контролировать соответствие полей в сертификате атрибутам субъекта” указываемые значения полей должны соответствовать значениям аналогичных атрибутов субъекта.
Отключение данной опции в шаблоне позволяет записывать в поля сертификата любые (в соответствии с регулярными выражениями полей) значения, не соответствующие атрибутам субъекта.
subjectAltName: { (enum: RFC822NAME, DNS_NAME, IPADDRESS, DIRECTORY_NAME, UNIFORM_RESOURCE_ID, REGISTERED_ID, MS_UPN, MS_GUID, KRB5PRINCIPAL, PERMANENT_IDENTIFIER, XMPP_ADDR, SRV_NAME, SUBJECT_IDENTIFICATION_METHOD, UNKNOWN): string[] } [опционально\Поля альтернативного имени субъекта, которое должно попасть в сертификат.
В формате key-value.
Где key – один из перечисленных в enum параметров, а value – значение параметра.
Значения полей, указанные в subjectAltName, переопределяют значения соответствующих полей SAN запроса на сертификат, при условии, что они соответствуют значениям атрибутов субъекта.
При использовании шаблона с включенной опцией “Контролировать соответствие полей в сертификате атрибутам субъекта” указываемые значения полей должны соответствовать значениям аналогичных атрибутов субъекта.
Отключение данной опции в шаблоне позволяет записывать в поля сертификата любые (в соответствии с регулярными выражениями полей) значения, не соответствующие атрибутам субъекта.
Response ResponseEntity -> ItemResponse ->Ответ JSON в HTTP-body
id (UUID),ID сертификата
downloadActions:Доступные действия по выгрузке
p12 (boolean),Флаг: выгрузка pkcs12
csr (boolean),Флаг: выгрузка pkcs10
pem (boolean)Флаг: выгрузка сертификата
fingerprint (string),Фингерпринт шаблона
serialNumber (string),Серийный номер сертификата
templateId (UUID),ID шаблона
templateName (string),Имя шаблона
name (string),Имя сертификата (на основе CN)
issuerDN: { (enum: CN, UID, E, EMAILADDRESS, MAIL, SN, GIVENNAME, INITIALS, SURNAME, OU, O, L, ST, DC, C, UNSTRUCTUREDADDRESS, UNSTRUCTUREDNAME, POSTALCODE, BUSINESSCATEGORY, TELEPHONENUMBER, PSEUDONYM, POSTALADDRESS, STREET, NAME, T, DN, DESCRIPTION, INN, OGRN, OGRNIP, SNILS, INNLE, UNKNOWN): string[] },Поля разделенного имени субъекта издателя из сертификата.
В формате key-value.
Где key – один из перечисленных в enum параметров, а value – значение параметра
subjectDN: { (enum: CN, UID, E, EMAILADDRESS, MAIL, SN, GIVENNAME, INITIALS, SURNAME, OU, O, L, ST, DC, C, UNSTRUCTUREDADDRESS, UNSTRUCTUREDNAME, POSTALCODE, BUSINESSCATEGORY, TELEPHONENUMBER, PSEUDONYM, POSTALADDRESS, STREET, NAME, T, DN, DESCRIPTION, INN, OGRN, OGRNIP, SNILS, INNLE, UNKNOWN): string[] },Поля разделенного имени субъекта из сертификата.
В формате key-value.
Где key – один из перечисленных в enum параметров, а value – значение параметра
subjectAltName: { (enum: RFC822NAME, DNS_NAME, IPADDRESS, DIRECTORY_NAME, UNIFORM_RESOURCE_ID, REGISTERED_ID, MS_UPN, MS_GUID, KRB5PRINCIPAL, PERMANENT_IDENTIFIER, XMPP_ADDR, SRV_NAME, SUBJECT_IDENTIFICATION_METHOD, UNKNOWN): string[] },Поля альтернативного имени субъекта из сертификата.
В формате key-value.
Где key – один из перечисленных в enum параметров, а value – значение параметра
validFrom (instant),Дата начала действия сертификата (ISO 8601)
validTo (instant)Дата окончания действия сертификата (ISO 8601)

Методы перевыпуска сертификата по запросу pkcs#10

Заголовок раздела «Методы перевыпуска сертификата по запросу pkcs#10»

Перевыпуск сертификата по запросу pkcs#10 (формат запроса на сертификат из входных параметров – multipart/form-data)

Заголовок раздела «Перевыпуск сертификата по запросу pkcs#10 (формат запроса на сертификат из входных параметров – multipart/form-data)»
POST API – Перевыпуск сертификата по запросу pkcs#10 (multipart/form-data)
Метод доступен:администратору;, оператору при наличии полномочий на управление сертификатами субъектов и использование шаблона, идентификаторы которых передаются во входных параметрах.Использование данного метода оператором для создания сертификатов для учетных записей запрещено.
Метод позволяет перевыпустить сертификат по запросу, по которому ранее уже был выпущен сертификат.
При использовании метода проверяется наличие в базе данных программы выпущенного сертификата, имеющего “Subject Key Identifier” аналогичный указанному в запросе на сертификат из входных параметров.
Если такой сертификат не будет найден, данный метод осуществит выпуск нового сертификата по запросу аналогично методу выпуска сертификата по запросу (см. раздел 5.2).
Если сертификат с аналогичным указанному в запросе на сертификат “Subject Key Identifier” будет найден, программа: 1) проверит статус найденного сертификата.
Если срок действия данного сертификата истек, запрос пользователя будет отклонен. 2) проверит соответствие значений в полях SDN и SAN, указанных в запросе (или во входных параметрах метода), значениям в полях SDN и SAN в найденном сертификате.
При соответствии значений будет осуществлен выпуск сертификата по запросу на сертификат из входных параметров метода, иначе запрос пользователя будет отклонен.
URL – certificate-authority-service/api/v3/public/certificates/renewal/{caId}/pkcs10
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/[v3] Контроллер%3A сертификаты/renewalRequestByCaId_1
Query
caId (UUID),ID ЦС
subjectId (UUID) [обязателен, если не указан userId],ID субъекта
userId (UUID) [обязателен, если не указан subjectIdID учетной записи
Request
templateId (UUID),Идентификатор шаблона
request (binary),Файл запроса на сертификат.
При использовании шаблона с включенной опцией “Контролировать соответствие полей в сертификате атрибутам субъекта” значения полей запроса на сертификат должны соответствовать значениям аналогичных атрибутов субъекта.
Отключение данной опции в шаблоне позволяет записывать в поля сертификата любые (в соответствии с регулярными выражениями полей) значения, не соответствующие атрибутам субъекта.
Допустимые форматы запроса на сертификат: • PEM; • PEM без хидера и футера (“-----BEGIN CERTIFICATE-----” и “-----END CERTIFICATE---“).
subjectName: { (enum: CN, UID, E, EMAILADDRESS, MAIL, SN, GIVENNAME, INITIALS, SURNAME, OU, O, L, ST, DC, C, UNSTRUCTUREDADDRESS, UNSTRUCTUREDNAME, POSTALCODE, BUSINESSCATEGORY, TELEPHONENUMBER, PSEUDONYM, POSTALADDRESS, STREET, NAME, T, DN, DESCRIPTION, INN, OGRN, OGRNIP, SNILS, INNLE, UNKNOWN): string[] },[опционально\Поля отличительного имени субъекта, которое должно попасть в сертификат.
В формате key-value.
Где key – один из перечисленных в enum параметров, а value – значение параметра.
Значения полей, указанные в subjectName, переопределяют значения соответствующих полей SDN запроса на сертификат, при условии, что они соответствуют значениям атрибутов субъекта.
При использовании шаблона с включенной опцией “Контролировать соответствие полей в сертификате атрибутам субъекта” указываемые значения полей должны соответствовать значениям аналогичных атрибутов субъекта.
Отключение данной опции в шаблоне позволяет записывать в поля сертификата любые (в соответствии с регулярными выражениями полей) значения, не соответствующие атрибутам субъекта.
subjectAltName: { (enum: RFC822NAME, DNS_NAME, IPADDRESS, DIRECTORY_NAME, UNIFORM_RESOURCE_ID, REGISTERED_ID, MS_UPN, MS_GUID, KRB5PRINCIPAL, PERMANENT_IDENTIFIER, XMPP_ADDR, SRV_NAME, SUBJECT_IDENTIFICATION_METHOD, UNKNOWN): string[] } [опционально\Поля альтернативного имени субъекта, которое должно попасть в сертификат.
В формате key-value.
Где key – один из перечисленных в enum параметров, а value – значение параметра.
Значения полей, указанные в subjectAltName, переопределяют значения соответствующих полей SAN запроса на сертификат, при условии, что они соответствуют значениям атрибутов субъекта.
При использовании шаблона с включенной опцией “Контролировать соответствие полей в сертификате атрибутам субъекта” указываемые значения полей должны соответствовать значениям аналогичных атрибутов субъекта.
Отключение данной опции в шаблоне позволяет записывать в поля сертификата любые (в соответствии с регулярными выражениями полей) значения, не соответствующие атрибутам субъекта.
Response ResponseEntity -> ItemResponse ->Ответ JSON в HTTP-body
id (UUID),ID сертификата
downloadActions:Доступные действия по выгрузке
p12 (boolean),Флаг: выгрузка pkcs12
csr (boolean),Флаг: выгрузка pkcs10
pem (boolean)Флаг: выгрузка сертификата
fingerprint (string),Фингерпринт шаблона
serialNumber (string),Серийный номер сертификата
templateId (UUID),ID шаблона
templateName (string),Имя шаблона
name (string),Имя сертификата (на основе CN)
issuerDN: { (enum: CN, UID, E, EMAILADDRESS, MAIL, SN, GIVENNAME, INITIALS, SURNAME, OU, O, L, ST, DC, C, UNSTRUCTUREDADDRESS, UNSTRUCTUREDNAME, POSTALCODE, BUSINESSCATEGORY, TELEPHONENUMBER, PSEUDONYM, POSTALADDRESS, STREET, NAME, T, DN, DESCRIPTION, INN, OGRN, OGRNIP, SNILS, INNLE, UNKNOWN): string[] },Поля разделенного имени субъекта издателя из сертификата.
В формате key-value.
Где key – один из перечисленных в enum параметров, а value – значение параметра
subjectDN: { (enum: CN, UID, E, EMAILADDRESS, MAIL, SN, GIVENNAME, INITIALS, SURNAME, OU, O, L, ST, DC, C, UNSTRUCTUREDADDRESS, UNSTRUCTUREDNAME, POSTALCODE, BUSINESSCATEGORY, TELEPHONENUMBER, PSEUDONYM, POSTALADDRESS, STREET, NAME, T, DN, DESCRIPTION, INN, OGRN, OGRNIP, SNILS, INNLE, UNKNOWN): string[] },Поля разделенного имени субъекта из сертификата.
В формате key-value.
Где key – один из перечисленных в enum параметров, а value – значение параметра
subjectAltName: { (enum: RFC822NAME, DNS_NAME, IPADDRESS, DIRECTORY_NAME, UNIFORM_RESOURCE_ID, REGISTERED_ID, MS_UPN, MS_GUID, KRB5PRINCIPAL, PERMANENT_IDENTIFIER, XMPP_ADDR, SRV_NAME, SUBJECT_IDENTIFICATION_METHOD, UNKNOWN): string[] },Поля альтернативного имени субъекта из сертификата.
В формате key-value.
Где key – один из перечисленных в enum параметров, а value – значение параметра
validFrom (instant),Дата начала действия сертификата (ISO 8601)
validTo (instant)Дата окончания действия сертификата (ISO 8601)

Перевыпуск сертификата по запросу pkcs#10 (формат запроса на сертификат из входных параметров – application/json)

Заголовок раздела «Перевыпуск сертификата по запросу pkcs#10 (формат запроса на сертификат из входных параметров – application/json)»

Примечание: отличается от метода выше форматом передаваемого во входных параметрах запроса на сертификат. В данном методе на вход поступает содержимое файла запроса на сертификат в формате PEM (содержимое в Base64).

POST API – Перевыпуск сертификата в по запросу pkcs#10 (application/json)
Метод доступен:администратору;, оператору при наличии полномочий на управление сертификатами субъектов и использование шаблона, идентификаторы которых передаются во входных параметрах.Использование данного метода оператором для создания сертификатов для учетных записей запрещено.
Метод позволяет перевыпустить сертификат по запросу, по которому ранее уже был выпущен сертификат.
При использовании метода проверяется наличие в базе данных программы выпущенного сертификата, имеющего “Subject Key Identifier” аналогичный указанному в запросе на сертификат из входных параметров.
Если такой сертификат не будет найден, данный метод осуществит выпуск нового сертификата по запросу аналогично методу выпуска сертификата по запросу.
Если сертификат с аналогичным указанному в запросе на сертификат “Subject Key Identifier” будет найден, программа: 1) проверит статус найденного сертификата.
Если срок действия данного сертификата истек, запрос пользователя будет отклонен. 2) проверит соответствие значений в полях SDN и SAN, указанных в запросе (или во входных параметрах метода), значениям в полях SDN и SAN в найденном сертификате.
При соответствии значений будет осуществлен выпуск сертификата по запросу на сертификат из входных параметров метода, иначе запрос пользователя будет отклонен.
URL – certificate-authority-service/api/v3/public/certificates/renewal/{caId}/pkcs10
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/[v3] Контроллер%3A сертификаты/renewalRequestByCaId_1
Query
caId (UUID),ID ЦС
subjectId (UUID) [обязателен, если не указан userId],ID субъекта
userId (UUID) [обязателен, если не указан subjectIdID учетной записи
Request
templateId (UUID),Идентификатор шаблона
request:Запрос на сертификат
contentType(string) [опционально],Тип загружаемого файла (HTTP MediaType) - application/octet-stream)
fileName (string) [опционально],Имя загружаемого файла
data (string:binary)Содержимое PEM файла запроса на сертификат (массив байт в Base64) – см. пример использования метода ниже.
При использовании шаблона с включенной опцией “Контролировать соответствие полей в сертификате атрибутам субъекта” значения полей запроса на сертификат должны соответствовать значениям аналогичных атрибутов субъекта.
Отключение данной опции в шаблоне позволяет записывать в поля сертификата любые (в соответствии с регулярными выражениями полей) значения, не соответствующие атрибутам субъекта.
Допустимые форматы запроса на сертификат: • PEM; • PEM без хидера и футера (“-----BEGIN CERTIFICATE-----” и “-----END CERTIFICATE---“).
subjectName: { (enum: CN, UID, E, EMAILADDRESS, MAIL, SN, GIVENNAME, INITIALS, SURNAME, OU, O, L, ST, DC, C, UNSTRUCTUREDADDRESS, UNSTRUCTUREDNAME, POSTALCODE, BUSINESSCATEGORY, TELEPHONENUMBER, PSEUDONYM, POSTALADDRESS, STREET, NAME, T, DN, DESCRIPTION, INN, OGRN, OGRNIP, SNILS, INNLE, UNKNOWN): string[] },[опционально\Поля отличительного имени субъекта, которое должно попасть в сертификат.
В формате key-value.
Где key – один из перечисленных в enum параметров, а value – значение параметра.
Значения полей, указанные в subjectName, переопределяют значения соответствующих полей SDN запроса на сертификат, при условии, что они соответствуют значениям атрибутов субъекта.
При использовании шаблона с включенной опцией “Контролировать соответствие полей в сертификате атрибутам субъекта” указываемые значения полей должны соответствовать значениям аналогичных атрибутов субъекта.
Отключение данной опции в шаблоне позволяет записывать в поля сертификата любые (в соответствии с регулярными выражениями полей) значения, не соответствующие атрибутам субъекта.
subjectAltName: { (enum: RFC822NAME, DNS_NAME, IPADDRESS, DIRECTORY_NAME, UNIFORM_RESOURCE_ID, REGISTERED_ID, MS_UPN, MS_GUID, KRB5PRINCIPAL, PERMANENT_IDENTIFIER, XMPP_ADDR, SRV_NAME, SUBJECT_IDENTIFICATION_METHOD, UNKNOWN): string[] } [опционально\Поля альтернативного имени субъекта, которое должно попасть в сертификат.
В формате key-value.
Где key – один из перечисленных в enum параметров, а value – значение параметра.
Значения полей, указанные в subjectAltName, переопределяют значения соответствующих полей SAN запроса на сертификат, при условии, что они соответствуют значениям атрибутов субъекта.
При использовании шаблона с включенной опцией “Контролировать соответствие полей в сертификате атрибутам субъекта” указываемые значения полей должны соответствовать значениям аналогичных атрибутов субъекта.
Отключение данной опции в шаблоне позволяет записывать в поля сертификата любые (в соответствии с регулярными выражениями полей) значения, не соответствующие атрибутам субъекта.
Response ResponseEntity -> ItemResponse ->Ответ JSON в HTTP-body
id (UUID),ID сертификата
downloadActions:Доступные действия по выгрузке
p12 (boolean),Флаг: выгрузка pkcs12
csr (boolean),Флаг: выгрузка pkcs10
pem (boolean)Флаг: выгрузка сертификата
fingerprint (string),Фингерпринт шаблона
serialNumber (string),Серийный номер сертификата
templateId (UUID),ID шаблона
templateName (string),Имя шаблона
name (string),Имя сертификата (на основе CN)
issuerDN: { (enum: CN, UID, E, EMAILADDRESS, MAIL, SN, GIVENNAME, INITIALS, SURNAME, OU, O, L, ST, DC, C, UNSTRUCTUREDADDRESS, UNSTRUCTUREDNAME, POSTALCODE, BUSINESSCATEGORY, TELEPHONENUMBER, PSEUDONYM, POSTALADDRESS, STREET, NAME, T, DN, DESCRIPTION, INN, OGRN, OGRNIP, SNILS, INNLE, UNKNOWN): string[] },Поля разделенного имени субъекта издателя из сертификата.
В формате key-value.
Где key – один из перечисленных в enum параметров, а value – значение параметра
subjectDN: { (enum: CN, UID, E, EMAILADDRESS, MAIL, SN, GIVENNAME, INITIALS, SURNAME, OU, O, L, ST, DC, C, UNSTRUCTUREDADDRESS, UNSTRUCTUREDNAME, POSTALCODE, BUSINESSCATEGORY, TELEPHONENUMBER, PSEUDONYM, POSTALADDRESS, STREET, NAME, T, DN, DESCRIPTION, INN, OGRN, OGRNIP, SNILS, INNLE, UNKNOWN): string[] },Поля разделенного имени субъекта из сертификата.
В формате key-value.
Где key – один из перечисленных в enum параметров, а value – значение параметра
subjectAltName: { (enum: RFC822NAME, DNS_NAME, IPADDRESS, DIRECTORY_NAME, UNIFORM_RESOURCE_ID, REGISTERED_ID, MS_UPN, MS_GUID, KRB5PRINCIPAL, PERMANENT_IDENTIFIER, XMPP_ADDR, SRV_NAME, SUBJECT_IDENTIFICATION_METHOD, UNKNOWN): string[] },Поля альтернативного имени субъекта из сертификата.
В формате key-value.
Где key – один из перечисленных в enum параметров, а value – значение параметра
validFrom (instant),Дата начала действия сертификата (ISO 8601)
validTo (instant)Дата окончания действия сертификата (ISO 8601)

Методы валидации запроса pkcs#10

Заголовок раздела «Методы валидации запроса pkcs#10»

Метод валидации запроса pkcs#10 (формат запроса на сертификат из входных параметров – multipart/form-data)

Заголовок раздела «Метод валидации запроса pkcs#10 (формат запроса на сертификат из входных параметров – multipart/form-data)»
POST API – Валидация запроса pkcs#10 (multipart/form-data)
Метод доступен:администратору;, оператору при наличии полномочий на управление сертификатами субъектов и использование шаблона, идентификаторы которых передаются во входных параметрах.Использование данного метода оператором для валидации запросов на сертификат для учетных записей запрещено.
URL – certificate-authority-service/api/v3/public/certificates/validate/{caId}/pkcs10
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/[v3] Контроллер%3A сертификаты/validate_1
Query
caId (UUID)ID ЦС
subjectId (UUID) [обязателен, если не указан accountId],ID субъекта
accountId (UUID) [обязателен, если не указан subjectIdID учетной записи
Request
templateId (UUID),Идентификатор шаблона
request (binary),Файл запроса на сертификат.
Допустимые форматы запроса на сертификат: • PEM; • PEM без хидера и футера (“-----BEGIN CERTIFICATE-----” и “-----END CERTIFICATE---“).
subjectName: { (enum: CN, UID, E, EMAILADDRESS, MAIL, SN, GIVENNAME, INITIALS, SURNAME, OU, O, L, ST, DC, C, UNSTRUCTUREDADDRESS, UNSTRUCTUREDNAME, POSTALCODE, BUSINESSCATEGORY, TELEPHONENUMBER, PSEUDONYM, POSTALADDRESS, STREET, NAME, T, DN, DESCRIPTION, INN, OGRN, OGRNIP, SNILS, INNLE, UNKNOWN): string[] },[опционально\Поля отличительного имени субъекта, которое должно попасть в сертификат.
В формате key-value.
Где key – один из перечисленных в enum параметров, а value – значение параметра.
Значения полей, указанные в subjectName, переопределяют значения соответствующих полей SDN запроса на сертификат, при условии, что они соответствуют значениям атрибутов субъекта.
subjectAltName: { (enum: RFC822NAME, DNS_NAME, IPADDRESS, DIRECTORY_NAME, UNIFORM_RESOURCE_ID, REGISTERED_ID, MS_UPN, MS_GUID, KRB5PRINCIPAL, PERMANENT_IDENTIFIER, XMPP_ADDR, SRV_NAME, SUBJECT_IDENTIFICATION_METHOD, UNKNOWN): string[] } [опционально\Поля альтернативного имени субъекта, которое должно попасть в сертификат.
В формате key-value.
Где key – один из перечисленных в enum параметров, а value – значение параметра.
Значения полей, указанные в subjectAltName, переопределяют значения соответствующих полей SAN запроса на сертификат, при условии, что они соответствуют значениям атрибутов субъекта.
Response ResponseEntity -> ItemResponse ->Ответ JSON в HTTP-body
name (string),Имя сертификата (на основе CN)
templateId (UUID),ID шаблона
templateName (string),Имя шаблона
subjectId (UUID)ID субъекта (может отсутствовать, если в Query указан accountId, а не subjectId)
valid (boolean),Флаг: запрос прошел валидацию
subjectNames:Компоненты имени субъекта сертификата
fieldName (enum: CN, UID, E, EMAILADDRESS, MAIL, SN, GIVENNAME, INITIALS, SURNAME, OU, O, L, ST, DC, C, UNSTRUCTUREDADDRESS, UNSTRUCTUREDNAME, POSTALCODE, BUSINESSCATEGORY, TELEPHONENUMBER, PSEUDONYM, POSTALADDRESS, STREET, NAME, T, DN, DESCRIPTION, INN, OGRN, OGRNIP, SNILS, INNLE, UNKNOWN),Имя компонента
fieldValue (string),Значение компонента
required (boolean),Флаг: компонент обязательный
additional (boolean),Флаг: компонент дополнительный
valid (boolean),Флаг: компонент прошел валидацию
message (string)Дополнительное сообщение
subjectAltNames:Компоненты расширенного имени субъекта сертификата
fieldName (enum: RFC822NAME, DNS_NAME, IPADDRESS, DIRECTORY_NAME, UNIFORM_RESOURCE_ID, REGISTERED_ID, MS_UPN, MS_GUID, KRB5PRINCIPAL, PERMANENT_IDENTIFIER, XMPP_ADDR, SRV_NAME, SUBJECT_IDENTIFICATION_METHOD, UNKNOWN),Имя компонента
fieldValue (string),Значение компонента
required (boolean),Флаг: компонент обязательный
additional (boolean),Флаг: компонент дополнительный
valid (boolean),Флаг: компонент прошел валидацию
message (string)Дополнительное сообщение

Метод валидации запроса pkcs#10 (формат запроса на сертификат из входных параметров – application/json)

Заголовок раздела «Метод валидации запроса pkcs#10 (формат запроса на сертификат из входных параметров – application/json)»

Примечание: отличается от метода выше форматом передаваемого во входных параметрах запроса на сертификат. В данном методе на вход поступает содержимое файла запроса на сертификат в формате PEM (содержимое в Base64).

POST API – Валидация запроса pkcs#10 (application/json)
Метод доступен:администратору;, оператору при наличии полномочий на управление сертификатами субъектов и использование шаблона, идентификаторы которых передаются во входных параметрах.Использование данного метода оператором для валидации запросов на сертификат для учетных записей запрещено.
URL – certificate-authority-service/api/v3/public/certificates/validate/{caId}/pkcs10
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/[v3] Контроллер%3A сертификаты/validate_1
Query
caId (UUID)ID ЦС
subjectId (UUID) [обязателен, если не указан accountId],ID субъекта
accountId (UUID) [обязателен, если не указан subjectIdID учетной записи
Request
templateId (UUID),Идентификатор шаблона
request:Файл запроса на сертификат
contentType (string),Тип загружаемого файла (HTTP MediaType) - application/octet-stream)
fileName (string),Имя загружаемого файла
data (string:binary)Содержимое загружаемого файла (массив байт в Base64).
Допустимые форматы запроса на сертификат: • PEM; • PEM без хидера и футера (“-----BEGIN CERTIFICATE-----” и “-----END CERTIFICATE---“).
subjectName: { (enum: CN, UID, E, EMAILADDRESS, MAIL, SN, GIVENNAME, INITIALS, SURNAME, OU, O, L, ST, DC, C, UNSTRUCTUREDADDRESS, UNSTRUCTUREDNAME, POSTALCODE, BUSINESSCATEGORY, TELEPHONENUMBER, PSEUDONYM, POSTALADDRESS, STREET, NAME, T, DN, DESCRIPTION, INN, OGRN, OGRNIP, SNILS, INNLE, UNKNOWN): string[] },[опционально\Поля отличительного имени субъекта, которое должно попасть в сертификат.
В формате key-value.
Где key – один из перечисленных в enum параметров, а value – значение параметра.
Значения полей, указанные в subjectName, переопределяют значения соответствующих полей SDN запроса на сертификат, при условии, что они соответствуют значениям атрибутов субъекта.
subjectAltName: { (enum: RFC822NAME, DNS_NAME, IPADDRESS, DIRECTORY_NAME, UNIFORM_RESOURCE_ID, REGISTERED_ID, MS_UPN, MS_GUID, KRB5PRINCIPAL, PERMANENT_IDENTIFIER, XMPP_ADDR, SRV_NAME, SUBJECT_IDENTIFICATION_METHOD, UNKNOWN): string[] } [опционально\Поля альтернативного имени субъекта, которое должно попасть в сертификат.
В формате key-value.
Где key – один из перечисленных в enum параметров, а value – значение параметра.
Значения полей, указанные в subjectAltName, переопределяют значения соответствующих полей SAN запроса на сертификат, при условии, что они соответствуют значениям атрибутов субъекта.
Response ResponseEntity -> ItemResponse ->Ответ JSON в HTTP-body
name (string),Имя сертификата (на основе CN)
templateId (UUID),ID шаблона
templateName (string),Имя шаблона
subjectId (UUID)ID субъекта (может отсутствовать, если в Query указан accountId, а не subjectId)
valid (boolean),Флаг: запрос прошел валидацию
subjectNames:Компоненты имени субъекта сертификата
fieldName (enum: CN, UID, E, EMAILADDRESS, MAIL, SN, GIVENNAME, INITIALS, SURNAME, OU, O, L, ST, DC, C, UNSTRUCTUREDADDRESS, UNSTRUCTUREDNAME, POSTALCODE, BUSINESSCATEGORY, TELEPHONENUMBER, PSEUDONYM, POSTALADDRESS, STREET, NAME, T, DN, DESCRIPTION, INN, OGRN, OGRNIP, SNILS, INNLE, UNKNOWN),Имя компонента
fieldValue (string),Значение компонента
required (boolean),Флаг: компонент обязательный
additional (boolean),Флаг: компонент дополнительный
valid (boolean),Флаг: компонент прошел валидацию
message (string)Дополнительное сообщение
subjectAltNames:Компоненты расширенного имени субъекта сертификата
fieldName (enum: RFC822NAME, DNS_NAME, IPADDRESS, DIRECTORY_NAME, UNIFORM_RESOURCE_ID, REGISTERED_ID, MS_UPN, MS_GUID, KRB5PRINCIPAL, PERMANENT_IDENTIFIER, XMPP_ADDR, SRV_NAME, SUBJECT_IDENTIFICATION_METHOD, UNKNOWN),Имя компонента
fieldValue (string),Значение компонента
required (boolean),Флаг: компонент обязательный
additional (boolean),Флаг: компонент дополнительный
valid (boolean),Флаг: компонент прошел валидацию
message (string)Дополнительное сообщение

Метод поиска сертификатов

Заголовок раздела «Метод поиска сертификатов»
GET API – Поиск сертификатов
Метод доступен администратору и оператору.
В ответе для оператора содержатся только сертификаты субъектов, к которым ему предоставлен доступ.
В ответе данного метода в полях “subjectDN” и “issuerDN” компоненты “ROLE” (роль), “DATEOFBIRTH” (дата рождения) и “PLACEOFBIRTH” (место рождения) в случае их наличия в сертификате будут указаны как “UNKNOWN”.
Данные компоненты поддерживаются в публичном API начиная с версии v4.
URL – certificate-authority-service/api/v3/public/certificates
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/[v3] Контроллер%3A сертификаты/findAll_14
Query
search (string) [опционально],Полнотекстовый поиск (имя или серийный номер)
issuerId (UUID) [опционально],ID сертификата издателя
templateId (UUID) [опционально],ID шаблона
status (enum[]: ACTIVE, HOLD, REVOKE, REQUEST, UNKNOWN) [опционально],Статус сертификата
type (enum[]:CERTIFICATE, ROOT_CA, SUB_CA, UNKNOWN) [опционально],Тип сертификата
revocationReason (enum[]:UNSPECIFIED, KEY_COMPROMISE, CA_COMPROMISE, AFFILIATION_CHANGED, SUPERSEDED, CESSATION_OF_OPERATION, CERTIFICATE_HOLD, REMOVE_FROM_CRL, PRIVILEGE_WITHDRAWN, AA_COMPROMISE, UNKNOWN) [опционально],Причина отзыва
notRevocationReason (enum[]:UNSPECIFIED, KEY_COMPROMISE, CA_COMPROMISE, AFFILIATION_CHANGED, SUPERSEDED, CESSATION_OF_OPERATION, CERTIFICATE_HOLD, REMOVE_FROM_CRL, PRIVILEGE_WITHDRAWN, AA_COMPROMISE, UNKNOWN) [опционально],Исключая причину отзыва
revocationDateFrom (instant) [опционально],Дата отзыва (начало)
revocationDateTo (instant) [опционально],Дата отзыва (окончание)
hasRevocationReason (boolean) [опционально],Флаг: наличие причины отзыва
hasRequest (boolean) [опционально],Флаг: наличие pkcs10
hasCA (boolean) [опционально],Флаг: наличие ЦС
isManagementCA (boolean) [опционально],Флаг: технологический ЦС
isValid (boolean) [опционально],Флаг: сертификат действует
isExpired (boolean) [опционально],Флаг: сертификат истек
validFromFrom (instant) [опционально],Дата начала действия (начало)
validFromTo (instant) [опционально],Дата начала действия (окончание)
validToFrom (instant) [опционально],Дата окончания действия (начало)
validToTo (instant) [опционально],Дата окончания действия (окончание)
updatedFrom (instant) [опционально],Дата обновления сертификата (начало)
updatedTo (instant) [опционально],Дата обновления сертификата (конец)
subjectId (UUID[])[опционально],ID субъекта
userId (UUID[])[опционально],ID учетной записи
serialnumber (string[])[опционально],Серийный номер
fingerprint (string[])[опционально],Отпечаток
subjectKeyIdentifier (string[])[опционально],Идентификатор ключа субъекта
notId (UUID[])[опционально],Исключая ID сертификата
endEntityType(string[])(enum[]:ROOT_CA, SUB_CA, USER, DEVICE, UNKNOWN) [опционально],Фильтр: Тип субъекта
sortDirection (string) [опционально],Направления сортировки (ASC;DESC)
sortBy (string[])[опционально],Список полей, к которым применяется сортировка
pageOffset (integer) [опционально],Смещение от начала списка (пагинация)
pageLimit (integer) [опциональноОграничение на размер выборки (пагинация)
Request -
Response ResponseEntity -> CollectionResponse ->Ответ JSON в HTTP-body
id (UUID),Идентификатор сертификата
issuerId (UUID),Идентификатор издателя сертификата
issuerFingerprint (string),Фингерпринт издателя сертификата
serialnumber (string),Серийный номер сертификата
fingerprint (string),Фингерпринт сертификата
issuerDN:Имя субъекта издателя сертификата
(enum: CN,
UID,
E,
EMAILADDRESS,
MAIL,
SN,
GIVENNAME,
INITIALS,
SURNAME,
OU,
O,
L,
ST,
DC,
C,
UNSTRUCTUREDADDRESS,
UNSTRUCTUREDNAME,
POSTALCODE,
BUSINESSCATEGORY,
TELEPHONENUMBER,
PSEUDONYM,
POSTALADDRESS,
STREET,
NAME,
T,
DN,
DESCRIPTION,
INN,
OGRN,
OGRNIP,
SNILS,
INNLE,
UNKNOWN): string		Поля разделенного имени субъекта издателя из сертификата.
В формате key-value.
Где key – один из перечисленных в enum параметров, а value – значение параметра
subjectDN:Имя субъекта сертификата
(enum: CN,
UID,
E,
EMAILADDRESS,
MAIL,
SN,
GIVENNAME,
INITIALS,
SURNAME,
OU,
O,
L,
ST,
DC,
C,
UNSTRUCTUREDADDRESS,
UNSTRUCTUREDNAME,
POSTALCODE,
BUSINESSCATEGORY,
TELEPHONENUMBER,
PSEUDONYM,
POSTALADDRESS,
STREET,
NAME,
T,
DN,
DESCRIPTION,
INN,
OGRN,
OGRNIP,
SNILS,
INNLE,
UNKNOWN): string		Поля разделенного имени субъекта из сертификата.
В формате key-value.
Где key – один из перечисленных в enum параметров, а value – значение параметра
subjectAltName:Альтернативное имя субъекта сертификата
(enum: RFC822NAME,
DNS_NAME,
IPADDRESS,
DIRECTORY_NAME,
UNIFORM_RESOURCE_ID,
REGISTERED_ID,
MS_UPN,
MS_GUID,
KRB5PRINCIPAL,
PERMANENT_IDENTIFIER,
XMPP_ADDR,
SRV_NAME,
SUBJECT_IDENTIFICATION_METHOD,
UNKNOWN): string		Поля альтернативного имени субъекта из сертификата.
В формате key-value.
Где key – один из перечисленных в enum параметров, а value – значение параметра
name (string),Имя сертификата (на основе CN)
templateId (UUID),Идентификатор шаблона
templateName (string),Имя шаблона
validFrom (instant),Дата начала действия сертификата (ISO 8601)
validTo (instant),Дата окончания действия сертификата (ISO 8601)
status (enum: ACTIVE, HOLD, REVOKE, REQUEST, UNKNOWN),Статус сертификата ЦС
isValid (boolean),Флаг: сертификат действует
isExpired (boolean),Флаг: сертификат истек
actions:Доступные действия по выгрузке
p12(boolean),Флаг: выгрузка pkcs12
csr(boolean),Флаг: выгрузка pkcs10
pem(boolean)Флаг: выгрузка сертификата
revocation:Сведения об отзыве сертификата
date (instant),Дата отзыва
number (int32),Код причины отзыва
value (string)Значение причины отзыва
hashAlgorithm (enum: SHA1, SHA256, SHA384, SHA512, SHA3_256, SHA3_384, SHA3_512, RSASSA_PSS, MD5, GOST_R_34_11_2012, UNKNOWN),Алгоритм подписи сертификата
keyAlgorithm (enum: RSA, ECDSA, GOST_R_34_10_2012, UNKNOWN),Алгоритм ключа сертификата
keyBits (int4),Длина ключа сертификата
subjectKeyIdentifier (string),Идентификатор ключа сертификата
authorityKeyIdentifier (string),Идентификатор ключа издателя сертификата
updated (instant),Время обновления (ISO 8601)
created (instant)Время создания (ISO 8601)

Метод получения сертификата по идентификатору

Заголовок раздела «Метод получения сертификата по идентификатору»
GET API – Получение сертификата по идентификатору
Метод доступен администратору и оператору при наличии полномочий на управление сертификатом, идентификатор которого передается во входных параметрах.
В ответе данного метода в полях “subjectDN” и “issuerDN” компоненты “ROLE” (роль), “DATEOFBIRTH” (дата рождения) и “PLACEOFBIRTH” (место рождения) в случае их наличия в сертификате будут указаны как “UNKNOWN”.
Данные компоненты поддерживаются в публичном API начиная с версии v4.
URL – certificate-authority-service/api/v3/public/certificates/{id
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/[v3] Контроллер%3A сертификаты/findById_13
Query
id (UUID)ID сертификата
Request -
Response ResponseEntity -> CollectionResponse ->Ответ JSON в HTTP-body
id (UUID),Идентификатор сертификата
chain:Цепочка сертификатов (рекурсивный объект)
id (UUID),Идентификатор сертификата
name (string),Имя сертификата (на основе CN)
subjectDN:Имя субъекта сертификата
(enum: CN,
UID,
E,
EMAILADDRESS,
MAIL,
SN,
GIVENNAME,
INITIALS,
SURNAME,
OU,
O,
L,
ST,
DC,
C,
UNSTRUCTUREDADDRESS,
UNSTRUCTUREDNAME,
POSTALCODE,
BUSINESSCATEGORY,
TELEPHONENUMBER,
PSEUDONYM,
POSTALADDRESS,
STREET,
NAME,
T,
DN,
DESCRIPTION,
INN,
OGRN,
OGRNIP,
SNILS,
INNLE,
UNKNOWN): string		Поля разделенного имени субъекта из сертификата.
В формате key-value.
Где key – один из перечисленных в enum параметров, а value – значение параметра
issuer: {…Издатель сертификата (вложенный объект)
serialnumber (string),Серийный номер сертификата
fingerprint (string),Фингерпринт сертификата
name (string),Имя сертификата (на основе CN)
issuerId (UUID),Идентификатор издателя сертификата
issuerDN:Имя субъекта издателя сертификата
(enum: CN,
UID,
E,
EMAILADDRESS,
MAIL,
SN,
GIVENNAME,
INITIALS,
SURNAME,
OU,
O,
L,
ST,
DC,
C,
UNSTRUCTUREDADDRESS,
UNSTRUCTUREDNAME,
POSTALCODE,
BUSINESSCATEGORY,
TELEPHONENUMBER,
PSEUDONYM,
POSTALADDRESS,
STREET,
NAME,
T,
DN,
DESCRIPTION,
INN,
OGRN,
OGRNIP,
SNILS,
INNLE,
UNKNOWN): string		Поля разделенного имени субъекта издателя из сертификата.
В формате key-value.
Где key – один из перечисленных в enum параметров, а value – значение параметра
subjectDN:Имя субъекта сертификата
(enum: CN,
UID,
E,
EMAILADDRESS,
MAIL,
SN,
GIVENNAME,
INITIALS,
SURNAME,
OU,
O,
L,
ST,
DC,
C,
UNSTRUCTUREDADDRESS,
UNSTRUCTUREDNAME,
POSTALCODE,
BUSINESSCATEGORY,
TELEPHONENUMBER,
PSEUDONYM,
POSTALADDRESS,
STREET,
NAME,
T,
DN,
DESCRIPTION,
INN,
OGRN,
OGRNIP,
SNILS,
INNLE,
UNKNOWN): string		Поля разделенного имени субъекта из сертификата.
В формате key-value.
Где key – один из перечисленных в enum параметров, а value – значение параметра
subjectAltName:Альтернативное имя субъекта сертификата
(enum: RFC822NAME,
DNS_NAME,
IPADDRESS,
DIRECTORY_NAME,
UNIFORM_RESOURCE_ID,
REGISTERED_ID,
MS_UPN,
MS_GUID,
KRB5PRINCIPAL,
PERMANENT_IDENTIFIER,
XMPP_ADDR,
SRV_NAME,
SUBJECT_IDENTIFICATION_METHOD,
UNKNOWN): string		Поля альтернативного имени субъекта из сертификата.
В формате key-value.
Где key – один из перечисленных в enum параметров, а value – значение параметра
keyAlgorithm (enum: RSA, ECDSA, GOST_R_34_10_2012, UNKNOWN),Алгоритм ключа сертификата ЦС
hashAlgorithm (enum: SHA1, SHA256, SHA384, SHA512, SHA3_256, SHA3_384, SHA3_512, RSASSA_PSS, MD5, GOST_R_34_11_2012, UNKNOWN),Алгоритм подписи сертификата ЦС
keyBits (int32),Длина ключа сертификата ЦС
templateId (UUID),Идентификатор шаблона
templateName (string),Имя шаблона
type (enum: CERTIFICATE, ROOT_CA, SUB_CA, UNKNOWN),Тип сертификата
endEntityType (enum: ROOT_CA, SUB_CA, USER, DEVICE, UNKNOWN),Тип субъекта
validFrom (instant),Дата начала действия сертификата (ISO 8601)
validTo (instant),Дата окончания действия сертификата(ISO 8601)
status (enum: ACTIVE, HOLD, REVOKE, REQUEST, UNKNOWN),Статус сертификата
isValid (boolean),Флаг: сертификат действует
isExpired (boolean),Флаг: сертификат истек
actions:Доступные действия по выгрузке
p12 (boolean),Флаг: выгрузка pkcs12
csr (boolean),Флаг: выгрузка pkcs10
pem (boolean)Флаг: выгрузка сертификата
publicKey (string),Открытый ключ
certificateType (string),Тип сертификата (X.509)
version (int32),Версия сертификата
subjectKeyIdentifier (string),Идентификатор ключа сертификата
authorityKeyIdentifier (string)Идентификатор ключа издателя сертификата
keyUsages:Назначение ключа сертификата
id (uuid),Идентификатор элемента
code (enum: DIGITAL_SIGNATURE,
NON_REPUDIATION,
KEY_ENCIPHERMENT,
DATA_ENCIPHERMENT,
KEY_AGREEMENT,
KEY_CERT_SIGN,
CRL_SIGN,
ENCIPHER_ONLY,
DECIPHER_ONLY,
UNKNOWN),		Перечисление использования ключа
value (string),Наименование элемента
description (string)Описание использования ключа
extendedKeyUsages:Расширенное назначение ключа сертификата
id (uuid),Идентификатор назначения
value (string),Наименование элемента
oid (string),OID назначения
description (string),Описание использования ключа
updated (instant),Время обновления (ISO 8601)
created (instant),Время создания (ISO 8601)
default (boolean)Флаг: расширенное использование по умолчанию
ca (boolean),Флаг: сертификат ЦС
revocation:Сведения об отзыве сертификата ЦС
date (instant),Дата отзыва
number (int4),Код причины отзыва
value (string)Значение причины отзыва
aiaUrls (string[]),URL AIA
ocspUrls (string[]),URL OCSP
crlUrls (string[]),URL CRL
deltaCrlUrls (string[]),URL Delta CRL
userId (uuid),Идентификатор субъекта
subjectId (uuid),Идентификатор субъекта
created (instant)Время создания (ISO 8601)
updated (instant),Время обновления (ISO 8601)

Метод получения сертификата по серийному номеру

Заголовок раздела «Метод получения сертификата по серийному номеру»
GET API – Получение сертификата по его серийному номеру
Метод доступен администратору и оператору при наличии полномочий на управление сертификатом, серийный номер которого передается во входных параметрах.
В ответе данного метода в полях “subjectDN” и “issuerDN” компоненты “ROLE” (роль), “DATEOFBIRTH” (дата рождения) и “PLACEOFBIRTH” (место рождения) в случае их наличия в сертификате будут указаны как “UNKNOWN”.
Данные компоненты поддерживаются в публичном API начиная с версии v4.
URL – certificate-authority-service/api/v3/public/certificates/serialNumber/{serialnumber
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/[v3] Контроллер%3A сертификаты/getBySerialNumber
Query
serialnumber (string)Серийный номер сертификата (формат: 40 символов, нижний регистр)
Request -
Response ResponseEntity -> CollectionResponse ->Ответ JSON в HTTP-body
id (UUID),Идентификатор сертификата
chain:Цепочка сертификатов (рекурсивный объект)
id (UUID),Идентификатор сертификата
name (string),Имя сертификата (на основе CN)
subjectDN:Имя субъекта сертификата
(enum: CN,
UID,
E,
EMAILADDRESS,
MAIL,
SN,
GIVENNAME,
INITIALS,
SURNAME,
OU,
O,
L,
ST,
DC,
C,
UNSTRUCTUREDADDRESS,
UNSTRUCTUREDNAME,
POSTALCODE,
BUSINESSCATEGORY,
TELEPHONENUMBER,
PSEUDONYM,
POSTALADDRESS,
STREET,
NAME,
T,
DN,
DESCRIPTION,
INN,
OGRN,
OGRNIP,
SNILS,
INNLE,
UNKNOWN): string		Поля разделенного имени субъекта из сертификата.
В формате key-value.
Где key – один из перечисленных в enum параметров, а value – значение параметра
issuer: {…Издатель сертификата (вложенный объект)
serialnumber (string),Серийный номер сертификата
fingerprint (string),Фингерпринт сертификата
name (string),Имя сертификата (на основе CN)
issuerId (UUID),Идентификатор издателя сертификата
issuerDN:Имя субъекта издателя сертификата
(enum: CN,
UID,
E,
EMAILADDRESS,
MAIL,
SN,
GIVENNAME,
INITIALS,
SURNAME,
OU,
O,
L,
ST,
DC,
C,
UNSTRUCTUREDADDRESS,
UNSTRUCTUREDNAME,
POSTALCODE,
BUSINESSCATEGORY,
TELEPHONENUMBER,
PSEUDONYM,
POSTALADDRESS,
STREET,
NAME,
T,
DN,
DESCRIPTION,
INN,
OGRN,
OGRNIP,
SNILS,
INNLE,
UNKNOWN): string		Поля разделенного имени субъекта издателя из сертификата.
В формате key-value.
Где key – один из перечисленных в enum параметров, а value – значение параметра
subjectDN:Имя субъекта сертификата
(enum: CN,
UID,
E,
EMAILADDRESS,
MAIL,
SN,
GIVENNAME,
INITIALS,
SURNAME,
OU,
O,
L,
ST,
DC,
C,
UNSTRUCTUREDADDRESS,
UNSTRUCTUREDNAME,
POSTALCODE,
BUSINESSCATEGORY,
TELEPHONENUMBER,
PSEUDONYM,
POSTALADDRESS,
STREET,
NAME,
T,
DN,
DESCRIPTION,
INN,
OGRN,
OGRNIP,
SNILS,
INNLE,
UNKNOWN): string		Поля разделенного имени субъекта из сертификата.
В формате key-value.
Где key – один из перечисленных в enum параметров, а value – значение параметра
subjectAltName:Альтернативное имя субъекта сертификата
(enum: RFC822NAME,
DNS_NAME,
IPADDRESS,
DIRECTORY_NAME,
UNIFORM_RESOURCE_ID,
REGISTERED_ID,
MS_UPN,
MS_GUID,
KRB5PRINCIPAL,
PERMANENT_IDENTIFIER,
XMPP_ADDR,
SRV_NAME,
SUBJECT_IDENTIFICATION_METHOD,
UNKNOWN): string		Поля альтернативного имени субъекта из сертификата.
В формате key-value.
Где key – один из перечисленных в enum параметров, а value – значение параметра
keyAlgorithm (enum: RSA, ECDSA, GOST_R_34_10_2012, UNKNOWN),Алгоритм ключа сертификата ЦС
hashAlgorithm (enum: SHA1, SHA256, SHA384, SHA512, SHA3_256, SHA3_384, SHA3_512, RSASSA_PSS, MD5, GOST_R_34_11_2012, UNKNOWN),Алгоритм подписи сертификата ЦС
keyBits (int32),Длина ключа сертификата ЦС
templateId (UUID),Идентификатор шаблона
templateName (string),Имя шаблона
type (enum: CERTIFICATE, ROOT_CA, SUB_CA, UNKNOWN),Тип сертификата
endEntityType (enum: ROOT_CA, SUB_CA, USER, DEVICE, UNKNOWN),Тип субъекта
validFrom (instant),Дата начала действия сертификата (ISO 8601)
validTo (instant),Дата окончания действия сертификата(ISO 8601)
status (enum: ACTIVE, HOLD, REVOKE, REQUEST, UNKNOWN),Статус сертификата
isValid (boolean),Флаг: сертификат действует
isExpired (boolean),Флаг: сертификат истек
actions:Доступные действия по выгрузке
p12 (boolean),Флаг: выгрузка pkcs12
csr (boolean),Флаг: выгрузка pkcs10
pem (boolean)Флаг: выгрузка сертификата
publicKey (string),Открытый ключ
certificateType (string),Тип сертификата (X.509)
version (int32),Версия сертификата
subjectKeyIdentifier (string),Идентификатор ключа сертификата
authorityKeyIdentifier (string)Идентификатор ключа издателя сертификата
keyUsages:Назначение ключа сертификата
id (uuid),Идентификатор элемента
code (enum: DIGITAL_SIGNATURE,
NON_REPUDIATION,
KEY_ENCIPHERMENT,
DATA_ENCIPHERMENT,
KEY_AGREEMENT,
KEY_CERT_SIGN,
CRL_SIGN,
ENCIPHER_ONLY,
DECIPHER_ONLY,
UNKNOWN),		Перечисление использования ключа
value (string),Наименование элемента
description (string)Описание использования ключа
extendedKeyUsages:Расширенное назначение ключа сертификата
id (uuid),Идентификатор элемента
value (string),Наименование элемента
oid (string),OID назначения
description, (string)Описание использования ключа
updated (instant),Время обновления (ISO 8601)
created (instant),Время создания (ISO 8601)
default (boolean)Флаг: расширенное использование по умолчанию
ca (boolean),Флаг: сертификат ЦС
revocation:Сведения об отзыве сертификата ЦС
date (instant),Дата отзыва
number (int4),Код причины отзыва
value (string)Значение причины отзыва
aiaUrls (string[]),URL AIA
ocspUrls (string[]),URL OCSP
crlUrls (string[]),URL CRL
deltaCrlUrls (string[]),URL Delta CRL
userId (uuid),Идентификатор субъекта
subjectId (uuid),Идентификатор субъекта
created (instant)Время создания (ISO 8601)
updated (instant),Время обновления (ISO 8601)

Метод получения сертификата по его отпечатку

Заголовок раздела «Метод получения сертификата по его отпечатку»
GET API – Получение сертификата по его отпечатку
Метод доступен администратору и оператору при наличии полномочий на управление сертификатом, отпечаток которого передается во входных параметрах.
В ответе данного метода в полях “subjectDN” и “issuerDN” компоненты “ROLE” (роль), “DATEOFBIRTH” (дата рождения) и “PLACEOFBIRTH” (место рождения) в случае их наличия в сертификате будут указаны как “UNKNOWN”.
Данные компоненты поддерживаются в публичном API начиная с версии v4.
URL – certificate-authority-service/api/v3/public/certificates/fingerprint/{fingerprint
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/[v3] Контроллер%3A сертификаты/getByFingerprint_1
Query
fingerprint (String)Отпечаток сертификата
Request -
Response ResponseEntity -> CollectionResponse ->Ответ JSON в HTTP-body
id (UUID),Идентификатор сертификата
chain:Цепочка сертификатов (рекурсивный объект)
id (UUID),Идентификатор сертификата
name (string),Имя сертификата (на основе CN)
subjectDN:Имя субъекта сертификата
(enum: CN,
UID,
E,
EMAILADDRESS,
MAIL,
SN,
GIVENNAME,
INITIALS,
SURNAME,
OU,
O,
L,
ST,
DC,
C,
UNSTRUCTUREDADDRESS,
UNSTRUCTUREDNAME,
POSTALCODE,
BUSINESSCATEGORY,
TELEPHONENUMBER,
PSEUDONYM,
POSTALADDRESS,
STREET,
NAME,
T,
DN,
DESCRIPTION,
INN,
OGRN,
OGRNIP,
SNILS,
INNLE,
UNKNOWN): string		Поля разделенного имени субъекта из сертификата.
В формате key-value.
Где key – один из перечисленных в enum параметров, а value – значение параметра
issuer: {…Издатель сертификата (вложенный объект)
serialnumber (string),Серийный номер сертификата
fingerprint (string),Фингерпринт сертификата
name (string),Имя сертификата (на основе CN)
issuerId (UUID),Идентификатор издателя сертификата
issuerDN:Имя субъекта издателя сертификата
(enum: CN,
UID,
E,
EMAILADDRESS,
MAIL,
SN,
GIVENNAME,
INITIALS,
SURNAME,
OU,
O,
L,
ST,
DC,
C,
UNSTRUCTUREDADDRESS,
UNSTRUCTUREDNAME,
POSTALCODE,
BUSINESSCATEGORY,
TELEPHONENUMBER,
PSEUDONYM,
POSTALADDRESS,
STREET,
NAME,
T,
DN,
DESCRIPTION,
INN,
OGRN,
OGRNIP,
SNILS,
INNLE,
UNKNOWN): string		Поля разделенного имени субъекта издателя из сертификата.
В формате key-value.
Где key – один из перечисленных в enum параметров, а value – значение параметра
subjectDN:Имя субъекта сертификата
(enum: CN,
UID,
E,
EMAILADDRESS,
MAIL,
SN,
GIVENNAME,
INITIALS,
SURNAME,
OU,
O,
L,
ST,
DC,
C,
UNSTRUCTUREDADDRESS,
UNSTRUCTUREDNAME,
POSTALCODE,
BUSINESSCATEGORY,
TELEPHONENUMBER,
PSEUDONYM,
POSTALADDRESS,
STREET,
NAME,
T,
DN,
DESCRIPTION,
INN,
OGRN,
OGRNIP,
SNILS,
INNLE,
UNKNOWN): string		Поля разделенного имени субъекта из сертификата.
В формате key-value.
Где key – один из перечисленных в enum параметров, а value – значение параметра
subjectAltName:Альтернативное имя субъекта сертификата
(enum: RFC822NAME,
DNS_NAME,
IPADDRESS,
DIRECTORY_NAME,
UNIFORM_RESOURCE_ID,
REGISTERED_ID,
MS_UPN,
MS_GUID,
KRB5PRINCIPAL,
PERMANENT_IDENTIFIER,
XMPP_ADDR,
SRV_NAME,
SUBJECT_IDENTIFICATION_METHOD,
UNKNOWN): string		Поля альтернативного имени субъекта из сертификата.
В формате key-value.
Где key – один из перечисленных в enum параметров, а value – значение параметра
keyAlgorithm (enum: RSA, ECDSA, GOST_R_34_10_2012, UNKNOWN),Алгоритм ключа сертификата ЦС
hashAlgorithm (enum: SHA1, SHA256, SHA384, SHA512, SHA3_256, SHA3_384, SHA3_512, RSASSA_PSS, MD5, GOST_R_34_11_2012, UNKNOWN),Алгоритм подписи сертификата ЦС
keyBits (int32),Длина ключа сертификата ЦС
templateId (UUID),Идентификатор шаблона
templateName (string),Имя шаблона
type (enum: CERTIFICATE, ROOT_CA, SUB_CA, UNKNOWN),Тип сертификата
endEntityType (enum: ROOT_CA, SUB_CA, USER, DEVICE, UNKNOWN),Тип субъекта
validFrom (instant),Дата начала действия сертификата (ISO 8601)
validTo (instant),Дата окончания действия сертификата(ISO 8601)
status (enum: ACTIVE, HOLD, REVOKE, REQUEST, UNKNOWN),Статус сертификата
isValid (boolean),Флаг: сертификат действует
isExpired (boolean),Флаг: сертификат истек
actions:Доступные действия по выгрузке
p12 (boolean),Флаг: выгрузка pkcs12
csr (boolean),Флаг: выгрузка pkcs10
pem (boolean)Флаг: выгрузка сертификата
publicKey (string),Открытый ключ
certificateType (string),Тип сертификата (X.509)
version (int32),Версия сертификата
subjectKeyIdentifier (string),Идентификатор ключа сертификата
authorityKeyIdentifier (string)Идентификатор ключа издателя сертификата
keyUsages:Назначение ключа сертификата
id (uuid),Идентификатор элемента
code (enum: DIGITAL_SIGNATURE,
NON_REPUDIATION,
KEY_ENCIPHERMENT,
DATA_ENCIPHERMENT,
KEY_AGREEMENT,
KEY_CERT_SIGN,
CRL_SIGN,
ENCIPHER_ONLY,
DECIPHER_ONLY,
UNKNOWN),		Перечисление использования ключа
value (string),Наименование элемента
description (string)Описание использования ключа
extendedKeyUsages:Расширенное назначение ключа сертификата
id (uuid),Идентификатор элемента
value (string),Наименование элемента
oid (string),OID назначения
description, (string)Описание использования ключа
updated (instant),Время обновления (ISO 8601)
created (instant),Время создания (ISO 8601)
default (boolean)Флаг: расширенное использование по умолчанию
ca (boolean),Флаг: сертификат ЦС
revocation:Сведения об отзыве сертификата ЦС
date (instant),Дата отзыва
number (int4),Код причины отзыва
value (string)Значение причины отзыва
aiaUrls (string[]),URL AIA
ocspUrls (string[]),URL OCSP
crlUrls (string[]),URL CRL
deltaCrlUrls (string[]),URL Delta CRL
userId (uuid),Идентификатор субъекта
subjectId (uuid),Идентификатор субъекта
created (instant)Время создания (ISO 8601)
updated (instant),Время обновления (ISO 8601)

Метод отзыва (приостановки) сертификата по идентификатору

Заголовок раздела «Метод отзыва (приостановки) сертификата по идентификатору»
PUT API – Отзыв (приостановка) сертификата по идентификатору
Метод доступен администратору и оператору при наличии полномочий на управление сертификатом, идентификатор которого передается во входных параметрах
URL – certificate-authority-service/api/v3/public/certificates/{id}/revoke
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/[v3] Контроллер%3A сертификаты/revokeById
Query
id (UUID)ID сертификата
Request
reason (enum: UNSPECIFIED,
KEY_COMPROMISE,
CA_COMPROMISE,
AFFILIATION_CHANGED,
SUPERSEDED,
CESSATION_OF_OPERATION,
CERTIFICATE_HOLD,
REMOVE_FROM_CRL,
PRIVILEGE_WITHDRAWN,
AA_COMPROMISE,
UNKNOWN)		Причина отзыва (приостановки)
Response -
При указании значения “CERTIFICATE_HOLD” в параметре reason сертификат будет приостановлен, а не отозван.

Метод активации сертификата по идентификатору

Заголовок раздела «Метод активации сертификата по идентификатору»
PUT API – Активация сертификата по идентификатору
Метод доступен администратору и оператору при наличии полномочий на управление сертификатом, идентификатор которого передается во входных параметрах
URL – certificate-authority-service/api/v3/public/certificates/{id}/reactivate
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/[v3] Контроллер%3A сертификаты/reactivateById
Query
id (UUID)ID сертификата
Request -
Response -

Метод публикации сертификата в РС по идентификатору

Заголовок раздела «Метод публикации сертификата в РС по идентификатору»
PUT API – Активация сертификата по идентификатору
Метод доступен администратору и оператору при наличии полномочий на управление сертификатом, идентификатор которого передается во входных параметрах
URL – certificate-authority-service/api/v3/public/certificates/{id}/reactivate
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/[v3] Контроллер%3A сертификаты/reactivateById
Query
id (UUID)ID сертификата
Request -
Response -

Метод расшифровки контейнера сертификата

Заголовок раздела «Метод расшифровки контейнера сертификата»
POST API – Расшифровка контейнера сертификата
Метод доступен администратору.
В ответе данного метода в полях “subjectDN” и “issuerDN” компоненты “ROLE” (роль), “DATEOFBIRTH” (дата рождения) и “PLACEOFBIRTH” (место рождения) в случае их наличия в каком-либо сертификате из состава контейнера будут указаны как “UNKNOWN”.
Данные компоненты поддерживаются в публичном API начиная с версии v4.
URL – certificate-authority-service/api/v3/public/parse/pkcs12
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/[v3] Контроллер%3A контейнеры сертификатов/parse
Query
Request
container:Файл контейнера
contentType (string) [опционально],Тип загружаемого файла (HTTP MediaType) - application/octet-stream)
fileName (string) [опционально],Имя загружаемого файла
data (string:binary)Содержимое загружаемого файла (массив байт в Base64)
password(string),Пароль от контейнера
templateId (UUID)Идентификатор шаблона
ResponseОтвет JSON в HTTP-body
serialnumber (string),Серийный номер сертификата
fingerprint (string),Фингерпринт сертификата
name (string),Имя сертификата (на основе CN)
issuerDN:Имя субъекта издателя сертификата
(enum: CN,
UID,
E,
EMAILADDRESS,
MAIL,
SN,
GIVENNAME,
INITIALS,
SURNAME,
OU,
O,
L,
ST,
DC,
C,
UNSTRUCTUREDADDRESS,
UNSTRUCTUREDNAME,
POSTALCODE,
BUSINESSCATEGORY,
TELEPHONENUMBER,
PSEUDONYM,
POSTALADDRESS,
STREET,
NAME,
T,
DN,
DESCRIPTION,
INN,
OGRN,
OGRNIP,
SNILS,
INNLE,
UNKNOWN): string		Поля разделенного имени субъекта издателя из сертификата.
В формате key-value.
Где key – один из перечисленных в enum параметров, а value – значение параметра
subjectDN:Имя субъекта сертификата
(enum: CN,
UID,
E,
EMAILADDRESS,
MAIL,
SN,
GIVENNAME,
INITIALS,
SURNAME,
OU,
O,
L,
ST,
DC,
C,
UNSTRUCTUREDADDRESS,
UNSTRUCTUREDNAME,
POSTALCODE,
BUSINESSCATEGORY,
TELEPHONENUMBER,
PSEUDONYM,
POSTALADDRESS,
STREET,
NAME,
T,
DN,
DESCRIPTION,
INN,
OGRN,
OGRNIP,
SNILS,
INNLE,
UNKNOWN): string		Поля разделенного имени субъекта из сертификата.
В формате key-value.
Где key – один из перечисленных в enum параметров, а value – значение параметра
subjectAltName:Альтернативное имя субъекта сертификата
(enum: RFC822NAME,
DNS_NAME,
IPADDRESS,
DIRECTORY_NAME,
UNIFORM_RESOURCE_ID,
REGISTERED_ID,
MS_UPN,
MS_GUID,
KRB5PRINCIPAL,
PERMANENT_IDENTIFIER,
XMPP_ADDR,
SRV_NAME,
SUBJECT_IDENTIFICATION_METHOD,
UNKNOWN): string		Поля альтернативного имени субъекта из сертификата.
В формате key-value.
Где key – один из перечисленных в enum параметров, а value – значение параметра
validFrom (instant),Дата начала действия сертификата (ISO 8601)
validTo (instant),Дата окончания действия сертификата(ISO 8601)
privateKey:Файл закрытого ключа
contentType (string),Тип загружаемого файла (HTTP MediaType)
fileName (string),Имя загружаемого файла
data (string:binary)Содержимое загружаемого файла (массив байт в Base64)
certificate:Файл сертификата
contentType (string),Тип загружаемого файла (HTTP MediaType)
fileName (string),Имя загружаемого файла
data (string:binary)Содержимое загружаемого файла (массив байт в Base64)
keyUsages:Назначение ключа сертификата
id (uuid),Идентификатор элемента
code (enum: DIGITAL_SIGNATURE,
NON_REPUDIATION,
KEY_ENCIPHERMENT,
DATA_ENCIPHERMENT,
KEY_AGREEMENT,
KEY_CERT_SIGN,
CRL_SIGN,
ENCIPHER_ONLY,
DECIPHER_ONLY,
UNKNOWN),		Перечисление использования ключа
value (string),Наименование элемента
description (string)Описание использования ключа
extendedKeyUsages:Расширенное назначение ключа сертификата
id (uuid),Идентификатор назначения
value (string),Наименование элемента
oid (string),OID назначения
description (string),Описание использования ключа
updated (instant),Время обновления (ISO 8601)
created (instant),Время создания (ISO 8601)
default (boolean)Флаг: расширенное использование по умолчанию
ca (boolean)Флаг: сертификат ЦС

Метод расшифровки сертификата

Заголовок раздела «Метод расшифровки сертификата»
POST API – Расшифровка сертификата
Метод доступен администратору.
В ответе данного метода в полях “subjectDN” и “issuerDN” компоненты “ROLE” (роль), “DATEOFBIRTH” (дата рождения) и “PLACEOFBIRTH” (место рождения) в случае их наличия в сертификате будут указаны как “UNKNOWN”.
Данные компоненты поддерживаются в публичном API начиная с версии v4.
URL – certificate-authority-service/api/v3/public/parse/pem
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/[v3] Контроллер%3A контейнеры сертификатов/parse_2
Query
Request
request:Файл сертификата
contentType (string) [опционально],Тип загружаемого файла (HTTP MediaType) - application/octet-stream)
fileName (string) [опционально],Имя загружаемого файла
data (string:binary)Содержимое загружаемого файла (массив байт в Base64)
ResponseОтвет JSON в HTTP-body
id (UUID),Идентификатор сертификата
chain:Цепочка сертификатов (рекурсивный объект)
id (UUID),Идентификатор сертификата
name (string),Имя сертификата (на основе CN)
subjectDN:Имя субъекта сертификата
(enum: CN,
UID,
E,
EMAILADDRESS,
MAIL,
SN,
GIVENNAME,
INITIALS,
SURNAME,
OU,
O,
L,
ST,
DC,
C,
UNSTRUCTUREDADDRESS,
UNSTRUCTUREDNAME,
POSTALCODE,
BUSINESSCATEGORY,
TELEPHONENUMBER,
PSEUDONYM,
POSTALADDRESS,
STREET,
NAME,
T,
DN,
DESCRIPTION,
INN,
OGRN,
OGRNIP,
SNILS,
INNLE,
UNKNOWN): string		Поля разделенного имени субъекта из сертификата.
В формате key-value.
Где key – один из перечисленных в enum параметров, а value – значение параметра
issuer: {…Издатель сертификата (вложенный объект)
serialnumber (string),Серийный номер сертификата
fingerprint (string),Фингерпринт сертификата
name (string),Имя сертификата (на основе CN)
issuerId (UUID),Идентификатор издателя сертификата
issuerDN:Имя субъекта издателя сертификата
(enum: CN,
UID,
E,
EMAILADDRESS,
MAIL,
SN,
GIVENNAME,
INITIALS,
SURNAME,
OU,
O,
L,
ST,
DC,
C,
UNSTRUCTUREDADDRESS,
UNSTRUCTUREDNAME,
POSTALCODE,
BUSINESSCATEGORY,
TELEPHONENUMBER,
PSEUDONYM,
POSTALADDRESS,
STREET,
NAME,
T,
DN,
DESCRIPTION,
INN,
OGRN,
OGRNIP,
SNILS,
INNLE,
UNKNOWN): string		Поля разделенного имени субъекта издателя из сертификата.
В формате key-value.
Где key – один из перечисленных в enum параметров, а value – значение параметра
subjectDN:Имя субъекта сертификата
(enum: CN,
UID,
E,
EMAILADDRESS,
MAIL,
SN,
GIVENNAME,
INITIALS,
SURNAME,
OU,
O,
L,
ST,
DC,
C,
UNSTRUCTUREDADDRESS,
UNSTRUCTUREDNAME,
POSTALCODE,
BUSINESSCATEGORY,
TELEPHONENUMBER,
PSEUDONYM,
POSTALADDRESS,
STREET,
NAME,
T,
DN,
DESCRIPTION,
INN,
OGRN,
OGRNIP,
SNILS,
INNLE,
UNKNOWN): string		Поля разделенного имени субъекта из сертификата.
В формате key-value.
Где key – один из перечисленных в enum параметров, а value – значение параметра
subjectAltName:Альтернативное имя субъекта сертификата
(enum: RFC822NAME,
DNS_NAME,
IPADDRESS,
DIRECTORY_NAME,
UNIFORM_RESOURCE_ID,
REGISTERED_ID,
MS_UPN,
MS_GUID,
KRB5PRINCIPAL,
PERMANENT_IDENTIFIER,
XMPP_ADDR,
SRV_NAME,
SUBJECT_IDENTIFICATION_METHOD,
UNKNOWN): string		Поля альтернативного имени субъекта из сертификата.
В формате key-value.
Где key – один из перечисленных в enum параметров, а value – значение параметра
keyAlgorithm (enum: RSA, ECDSA, GOST_R_34_10_2012, UNKNOWN),Алгоритм ключа сертификата ЦС
hashAlgorithm (enum: SHA1, SHA256, SHA384, SHA512, SHA3_256, SHA3_384, SHA3_512, RSASSA_PSS, MD5, GOST_R_34_11_2012, UNKNOWN),Алгоритм подписи сертификата ЦС
keyBits (int32),Длина ключа сертификата ЦС
templateId (UUID),Идентификатор шаблона
templateName (string),Имя шаблона
type (enum: CERTIFICATE, ROOT_CA, SUB_CA, UNKNOWN),Тип сертификата
endEntityType (enum: ROOT_CA, SUB_CA, USER, DEVICE, UNKNOWN),Тип субъекта
validFrom (instant),Дата начала действия сертификата (ISO 8601)
validTo (instant),Дата окончания действия сертификата(ISO 8601)
status (enum: ACTIVE, HOLD, REVOKE, REQUEST, UNKNOWN),Статус сертификата
isValid (boolean),Флаг: сертификат действует
isExpired (boolean),Флаг: сертификат истек
actions:Доступные действия по выгрузке
p12 (boolean),Флаг: выгрузка pkcs12
csr (boolean),Флаг: выгрузка pkcs10
pem (boolean)Флаг: выгрузка сертификата
publicKey (string),Открытый ключ
certificateType (string),Тип сертификата (X.509)
version (int32),Версия сертификата
subjectKeyIdentifier (string),Идентификатор ключа сертификата
authorityKeyIdentifier (string)Идентификатор ключа издателя сертификата
keyUsages:Назначение ключа сертификата
id (uuid),Идентификатор элемента
code (enum: DIGITAL_SIGNATURE,
NON_REPUDIATION,
KEY_ENCIPHERMENT,
DATA_ENCIPHERMENT,
KEY_AGREEMENT,
KEY_CERT_SIGN,
CRL_SIGN,
ENCIPHER_ONLY,
DECIPHER_ONLY,
UNKNOWN),		Перечисление использования ключа
value (string),Наименование элемента
description (string)Описание использования ключа
extendedKeyUsages:Расширенное назначение ключа сертификата
id (uuid),Идентификатор назначения
value (string),Наименование элемента
oid (string),OID назначения
description (string),Описание использования ключа
updated (instant),Время обновления (ISO 8601)
created (instant),Время создания (ISO 8601)
default (boolean)Флаг: расширенное использование по умолчанию
ca (boolean),Флаг: сертификат ЦС
revocation:Сведения об отзыве сертификата ЦС
date (instant),Дата отзыва
number (int4),Код причины отзыва
value (string)Значение причины отзыва
aiaUrls (string[]),URL AIA
ocspUrls (string[]),URL OCSP
crlUrls (string[]),URL CRL
deltaCrlUrls (string[]),URL Delta CRL
userId (uuid),Идентификатор субъекта
subjectId (uuid),Идентификатор субъекта
created (instant)Время создания (ISO 8601)
updated (instant),Время обновления (ISO 8601)

Метод расшифровки запроса на сертификат

Заголовок раздела «Метод расшифровки запроса на сертификат»
POST API – Расшифровка запроса на сертификат
Метод доступен администратору.
В ответе данного метода в поле “subjectDN” компоненты “ROLE” (роль), “DATEOFBIRTH” (дата рождения) и “PLACEOFBIRTH” (место рождения) в случае их наличия в запросе будут указаны как “UNKNOWN”.
Данные компоненты поддерживаются в публичном API начиная с версии v4.
URL – certificate-authority-service/api/v3/public/parse/pkcs10
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/[v3] Контроллер%3A контейнеры сертификатов/parse_1
Query
Request
request:Файл сертификата
contentType (string) [опционально],Тип загружаемого файла (HTTP MediaType) - application/octet-stream)
fileName (string) [опционально],Имя загружаемого файла
data (string:binary)Содержимое загружаемого файла (массив байт в Base64).
Допустимые форматы запроса на сертификат: • PEM; • PEM без хидера и футера (“-----BEGIN CERTIFICATE-----” и “-----END CERTIFICATE---“).
subjectName: { (enum: CN, UID, E, EMAILADDRESS, MAIL, SN, GIVENNAME, INITIALS, SURNAME, OU, O, L, ST, DC, C, UNSTRUCTUREDADDRESS, UNSTRUCTUREDNAME, POSTALCODE, BUSINESSCATEGORY, TELEPHONENUMBER, PSEUDONYM, POSTALADDRESS, STREET, NAME, T, DN, DESCRIPTION, INN, OGRN, OGRNIP, SNILS, INNLE, UNKNOWN): string[] },[опционально\Поля отличительного имени субъекта, которое должно попасть в сертификат.
В формате key-value.
Где key – один из перечисленных в enum параметров, а value – значение параметра.
Значения полей, указанные в subjectName, переопределяют значения соответствующих полей SDN запроса на сертификат, при условии, что они соответствуют значениям атрибутов субъекта.
subjectAltName: { (enum: RFC822NAME, DNS_NAME, IPADDRESS, DIRECTORY_NAME, UNIFORM_RESOURCE_ID, REGISTERED_ID, MS_UPN, MS_GUID, KRB5PRINCIPAL, PERMANENT_IDENTIFIER, XMPP_ADDR, SRV_NAME, SUBJECT_IDENTIFICATION_METHOD, UNKNOWN): string[] } [опционально\Поля альтернативного имени субъекта, которое должно попасть в сертификат.
В формате key-value.
Где key – один из перечисленных в enum параметров, а value – значение параметра.
Значения полей, указанные в subjectAltName, переопределяют значения соответствующих полей SAN запроса на сертификат, при условии, что они соответствуют значениям атрибутов субъекта.
ResponseОтвет JSON в HTTP-body
name (string),Имя сертификата (на основе CN)
subjectDN:Имя субъекта сертификата
(enum: CN,
UID,
E,
EMAILADDRESS,
MAIL,
SN,
GIVENNAME,
INITIALS,
SURNAME,
OU,
O,
L,
ST,
DC,
C,
UNSTRUCTUREDADDRESS,
UNSTRUCTUREDNAME,
POSTALCODE,
BUSINESSCATEGORY,
TELEPHONENUMBER,
PSEUDONYM,
POSTALADDRESS,
STREET,
NAME,
T,
DN,
DESCRIPTION,
INN,
OGRN,
OGRNIP,
SNILS,
INNLE,
UNKNOWN): string		Поля разделенного имени субъекта из сертификата.
В формате key-value.
Где key – один из перечисленных в enum параметров, а value – значение параметра
subjectAltName:Альтернативное имя субъекта сертификата
(enum: RFC822NAME,
DNS_NAME,
IPADDRESS,
DIRECTORY_NAME,
UNIFORM_RESOURCE_ID,
REGISTERED_ID,
MS_UPN,
MS_GUID,
KRB5PRINCIPAL,
PERMANENT_IDENTIFIER,
XMPP_ADDR,
SRV_NAME,
SUBJECT_IDENTIFICATION_METHOD,
UNKNOWN): string		Поля альтернативного имени субъекта из сертификата.
В формате key-value.
Где key – один из перечисленных в enum параметров, а value – значение параметра
keyAlgorithm (enum: RSA, ECDSA, GOST_R_34_10_2012, UNKNOWN),Алгоритм ключа сертификата ЦС
keyBits (int32),Длина ключа сертификата ЦС
subjectKeyIdentifier (string)Идентификатор ключа сертификата

Методы экспорта файлов

Заголовок раздела «Методы экспорта файлов»

Метод получения сертификата по идентификатору сертификата

Заголовок раздела «Метод получения сертификата по идентификатору сертификата»
GET API – Получение сертификата по идентификатору сертификата
Метод доступен администратору и оператору при наличии полномочий на управление сертификатом, идентификатор которого передается во входных параметрах
URL – export-service/api/v3/public/export/certificates/{certificateId}/certificate
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/[v3] Контроллер экспорта/findCertificateById
Query
certificateId (UUID)ID сертификата
Request -
Response ResponseEntity->byte[\

Метод получения запроса на сертификат по идентификатору сертификата

Заголовок раздела «Метод получения запроса на сертификат по идентификатору сертификата»
GET API – Получение запроса на сертификат по идентификатору сертификата
Метод доступен администратору и оператору при наличии полномочий на управление сертификатом, идентификатор которого передается во входных параметрах
URL – export-service/api/v3/public/export/certificates/{certificateId}/pkcs10
Swagger: https://HOST/ external-integration-service/swagger/swagger-ui/index.html#/[v3] Контроллер экспорта/findRequestById
Query
certificateId (UUID)ID сертификата
Request -
Response ResponseEntity->byte[\

Метод получения цепочки сертификата по идентификатору сертификата

Заголовок раздела «Метод получения цепочки сертификата по идентификатору сертификата»
GET API – Получение цепочки сертификатов по идентификатору сертификата
Метод доступен администратору и оператору при наличии полномочий на управление сертификатом, идентификатор которого передается во входных параметрах
URL – export-service/api/v3/public/export/certificates/{certificateId}/chain
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/[v3] Контроллер экспорта/findChainById
Query
certificateId (UUID)ID сертификата
Request -
Response ResponseEntity->byte[\

Метод получения контейнера PKCS#12 по идентификатору сертификата

Заголовок раздела «Метод получения контейнера PKCS#12 по идентификатору сертификата»
GET API – Получение контейнера pkcs12 по идентификатору сертификата
Метод доступен администратору и оператору при наличии полномочий на управление сертификатом, идентификатор которого передается во входных параметрах
URL – export-service/api/v3/public/export/certificates/{certificateId}/pkcs12
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/[v3] Контроллер экспорта/findP12ById
Query
certificateId (UUID)ID сертификата
Request -
Response ResponseEntity->byte[\

Метод получения сертификата Центра сертификации по идентификатору

Заголовок раздела «Метод получения сертификата Центра сертификации по идентификатору»
GET API – Получение сертификата по идентификатору Центра сертификации
Метод доступен администратору
URL – export-service/api/v3/public/export/certificate-authorities/{caId}/certificate
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/[v3] Контроллер экспорта/findCertificateByCaId
Query
caId (UUID)ID ЦС
Request -
Response ResponseEntity->byte[\

Метод получения цепочки сертификатов Центра сертификации по идентификатору

Заголовок раздела «Метод получения цепочки сертификатов Центра сертификации по идентификатору»
GET API – Получение цепочки сертификатов по идентификатору Центра сертификации
Метод доступен администратору
URL – export-service/api/v3/public/export/certificate-authorities/{caId}/chain
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/[v3] Контроллер экспорта/findChainByCaId
Query
caId (UUID)ID ЦС
Request -
Response ResponseEntity->byte[\

Метод получения CRL по идентификатору Центра сертификации

Заголовок раздела «Метод получения CRL по идентификатору Центра сертификации»
GET API – Получение CRL по идентификатору Центра сертификации
Метод доступен администратору и оператору
URL – export-service/api/v3/public/export/certificate-authorities/{caId}/crl
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/[v3] Контроллер экспорта/findCrlByCaId
Query -
Request -
Response ResponseEntity->byte[\

Метод получения DeltaCRL по идентификатору Центра сертификации

Заголовок раздела «Метод получения DeltaCRL по идентификатору Центра сертификации»
GET API – Получение DeltaCRL по идентификатору Центра сертификации
Метод доступен администратору и оператору
URL – export-service/api/v3/public/export/certificate-authorities/{caId}/delta-crl
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/[v3] Контроллер экспорта/findDeltaCrlByCaId
Query
caId (UUID)ID ЦС
Request -
Response ResponseEntity->byte[\

Методы работы с точками распространения

Заголовок раздела «Методы работы с точками распространения»

Метод генерации и публикации CRL по идентификатору Центра сертификации

Заголовок раздела «Метод генерации и публикации CRL по идентификатору Центра сертификации»
POST API – Генерация и публикация CRL по идентификатору Центра сертификации
Метод доступен администратору
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/[v3] Контроллер%3A Конфигурации CRL для ЦС/generate
URL – publisher-service/api/v3/public/certificate-authorities/{caId}/crl-configuration/generate
Query
id (UUID)ID ЦС
Request -
Response -

Метод генерации и публикации CRL по идентификатору Центра сертификации (устаревший)

Заголовок раздела «Метод генерации и публикации CRL по идентификатору Центра сертификации (устаревший)»
POST API – Генерация и публикация CRL по идентификатору Центра сертификации
Данный метод является устаревшим и будет исключен из публичного API в последующих версиях.
Метод доступен администратору
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/[v3] Контроллер%3A Конфигурации CRL для ЦС/generateDeprecated
URL – publisher-service/api/v3/ui/certificate-authorities/{caId}/crl-configuration/generate
Query
id (UUID)ID ЦС
Request -
Response -

Методы работы с точками подключения и ресурсными системами

Заголовок раздела «Методы работы с точками подключения и ресурсными системами»

Метод поиска зарегистрированных ресурсных систем

Заголовок раздела «Метод поиска зарегистрированных ресурсных систем»
GET API – Поиск ресурсных систем
Метод доступен администратору и оператору.
В ответе для оператора содержатся только те ресурсные системы, к субъектам которых ему предоставлен доступ.
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/[v3] Контроллер%3A ресурсные системы/findAll_4
URL – subjects-service/api/v3/public/resources
Query
id (uuid) [опционально],Фильтр: ID ресурсной системы
securityGroupId (uuid) [опционально],Фильтр: ID группы безопасности
subjectId (uuid) [опционально],Фильтр: ID субъекта
search (string) [опционально],Фильтр: полнотекстовый поиск по отображаемому имени
isConnected(boolean) [опционально],Фильтр: подключенная ресурсная система
isDefault (boolean) [опционально],Фильтр: ресурсная система по умолчанию
status (string) [опционально],Фильтр: статус ресурсной системы
inQueue (boolean) [опционально],Фильтр: ресурсная система в очереди
lastSynchronizationSuccessDate (instant) [опциональноФильтр: дата и время последней синхронизации
Request -
Response ResponseEntity -> CollectionResponse ->Ответ JSON в HTTP-body
id (UUID),ID ресурсной системы
commonName (string),Имя ресурсной системы
distinguishedName (string),DN ресурсной системы
subjectsCount (int64),Количество субъектов ресурсной системы
isConnected (boolean),Флаг: ресурсная система подключена
isDefault (boolean),Флаг: локальная ресурсная система
updated (instant),Время обновления (ISO 8601)
created (instant),Время создания (ISO 8601)
status (string),Статус ресурсной системы
inQueue (boolean),Флаг: ресурсная система в очереди
lastSynchronizationSuccessDate (instant)Дата и время последней синхронизации

Метод получения ресурсной системы по идентификатору

Заголовок раздела «Метод получения ресурсной системы по идентификатору»
GET API – Получение ресурсной системы по идентификатору
Метод доступен администратору и оператору при наличии доступа к субъектам РС, идентификатор которой передается во входных параметрах
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/[v3] Контроллер%3A ресурсные системы/findById_4
URL – subjects-service/api/v3/public/resources/{id
Query
id (uuid) [опциональноID ресурсной системы
Request -
Response ResponseEntity -> CollectionResponse ->Ответ JSON в HTTP-body
id (UUID),ID ресурсной системы
commonName (string),Имя ресурсной системы
distinguishedName (string),DN ресурсной системы
subjectsCount (int64),Количество субъектов ресурсной системы
isConnected (boolean),Флаг: ресурсная система подключена
isDefault (boolean),Флаг: локальная ресурсная система
updated (instant),Время обновления (ISO 8601)
created (instant),Время создания (ISO 8601)
status (string),Статус ресурсной системы
inQueue (boolean),Флаг: ресурсная система в очереди
lastSynchronizationSuccessDate (instant)Дата и время последней синхронизации

Метод полной синхронизации ресурсной системы

Заголовок раздела «Метод полной синхронизации ресурсной системы»
PUT API – Полная синхронизация РС
Метод доступен администратору и оператору при наличии полномочий на субъектов данной РС
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/[v3] Контроллер%3A ресурсные системы/synchronize
URL – ldap-service/api/v3/public/resources/{resourceId}/synchronize
Query
resourceId (UUID)ID ресурсной системы
Request -
Response -

Метод поиска идентификаторов ресурсных систем

Заголовок раздела «Метод поиска идентификаторов ресурсных систем»
GET API – Поиск ID ресурсных систем
Метод доступен администратору и оператору
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/[v3] Контроллер%3A словарь субъектов/findResources
URL – subjects-service/api/v3/public/subjects/dict/resources
Query
id (string[])[опционально],Фильтр: ID субъекта
notId (string[])[опционально],Фильтр: исключая ID субъекта
resourceId (string[])[опционально],Фильтр: ID ресурсной системы
securityGroupId (string[])[опционально],Фильтр: ID группы безопасности
search (string),Фильтр: полнотекстовый поиск по имени
isConnected(boolean),Фильтр: подключение субъекта к ресурсной системе
isBlocked(boolean)Фильтр: блокировка субъекта в ресурсной системе
Request -
Response ResponseEntity -> CollectionResponse ->Ответ JSON в HTTP-body
id (UUID),ID ресурсной системы
value (string)Имя ресурсной системы

Метод поиска точек подключения к ресурсной системе

Заголовок раздела «Метод поиска точек подключения к ресурсной системе»
GET API – Поиск точек подключения к РС
Метод доступен администратору и оператору
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/[v3] Контроллер%3A Точки подключения ресурсных систем/findAll_12
URL – ldap-service/api/v3/public/connection-points
Query
id (uuid) [опционально],Фильтр: ID точки подключения
resourceId (uuid) [опционально],Фильтр: ID ресурсной системы
search (string),Фильтр: полнотекстовый поиск по отображаемому имени
sortDirection (string) [опционально],Направления сортировки (ASC;DESC)
sortBy (string[])[опционально],Список полей, к которым применяется сортировка
pageOffset (integer) [опционально],Смещение от начала списка (пагинация)
pageLimit (integer) [опционально],Ограничение на размер выборки (пагинация)
inQueue (boolean) [опциональноФильтр: точка подключения в очереди
Request -
Response ResponseEntity -> CollectionResponse ->Ответ JSON в HTTP-body
id (UUID),ID точки подключения
title (string),Имя точки подключения
domainType(enum: SAMBA_DC, MS_AD, RED_ADM, FREE_IPA, ALD_PRO, ALT_DOMAIN, UNKNOWN),Тип точки подключения[13]
connectionAddress (string),Адрес (хост) подключения
useTls (boolean),Флаг: использовать TLS при подключении
baseDn(string),BaseDN точки подключения
username (string),Имя пользователя ресурсной системы
status (string)Статут точки подключения
resourceId (UUID),ID ресурсной системы
updated (instant),Время обновления (ISO 8601)
created (instant),Время создания (ISO 8601)
inQueue (boolean)Флаг: точка подключения в очереди

Метод получения точки подключения по идентификатору

Заголовок раздела «Метод получения точки подключения по идентификатору»
GET API – Получение точки подключения по идентификатору
Метод доступен администратору и оператору
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/[v3] Контроллер%3A Точки подключения ресурсных систем/findById_11
URL – ldap-service/api/v3/public/connection-points/{id
Query
id (uuid)ID точки подключения
Request -
Response ResponseEntity -> CollectionResponse ->Ответ JSON в HTTP-body
id (UUID),ID точки подключения
title (string),Имя точки подключения
domainType(enum: SAMBA_DC, MS_AD, RED_ADM, FREE_IPA, ALD_PRO, ALT_DOMAIN, UNKNOWN),Тип точки подключения[14]
connectionAddress (string),Адрес (хост) подключения
useTls (boolean),Флаг: использовать TLS при подключении
baseDn(string),BaseDN точки подключения
username (string),Имя пользователя ресурсной системы
status (string)Статут точки подключения
resourceId (UUID),ID ресурсной системы
updated (instant),Время обновления (ISO 8601)
created (instant),Время создания (ISO 8601)
inQueue (boolean)Флаг: точка подключения в очереди

Метод частичной синхронизации точки подключения

Заголовок раздела «Метод частичной синхронизации точки подключения»
PUT API – Частичная синхронизация точки подключения
Метод доступен администратору и оператору при наличии полномочий.
У оператора имеется возможность выполнять синхронизацию с теми внешними ресурсными системами, к субъектам которых у него есть доступ
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/[v3] Контроллер%3A Точки подключения ресурсных систем/synchronize_1
URL – ldap-service/api/v3/public/connection-points/{pointId}/synchronize
Query
pointId (UUID)ID точки подключения
Request -
Response -

Методы получения информации о сервисах

Заголовок раздела «Методы получения информации о сервисах»

Методы получения информации о сервисе безопасности (security-service)

Заголовок раздела «Методы получения информации о сервисе безопасности (security-service)»

Метод получения эндпоинтов для запроса информации о сервисе безопасности (security-service)

Заголовок раздела «Метод получения эндпоинтов для запроса информации о сервисе безопасности (security-service)»
GET – Получение списка доступных эндпоинтов для запроса информации о сервисе безопасности
Доступность метода для неаутентифицированного пользователя зависит от значения параметра “actuator_authenticate” конфигурационного файла:если параметр имеет значение “true”, доступ к методу будет разрешен только аутентифицированным пользователям;, если параметр имеет значение “false” (по умолчанию), доступ к методу будет разрешен без аутентификации.
URL – security-service/actuator
Swagger: -
Query -
Request -
ResponseОтвет JSON в HTTP-body
”_links”:
“self”:
“href”: “https://HOST/security-service/actuator”,URL эндпоинта, который возвращает эндпоинты для запроса информации о сервисе, где HOST – адрес хоста eCA-СA
”templated”: falseФлаг наличия переменной в URL
”health”:
“href”: “https://HOST/security-service/actuator/health”,URL эндпоинта, который возвращает информацию о состоянии сервиса (подробнее см. ниже), где HOST – адрес хоста eCA-СA
”templated”: falseФлаг наличия переменной в URL
”health-path”:
“href”: “https://HOST/security-service/actuator/health/{*path}”,URL зарезервированного эндроинта под будущие реализации
”templated”: trueФлаг наличия переменной в URL
”info”:
“href”: “https://HOST/security-service/actuator/info”,URL эндпоинта, который возвращает информацию о сервисе (подробнее см. ниже), где HOST – адрес хоста eCA-СA
”templated”: falseФлаг наличия переменной в URL
”prometheus”:
“href”: “https://HOST/security-service/actuator/prometheus”,URL эндпоинта, который возвращает метрики сервиса в формате Prometheus (подробнее см. ниже), где HOST – адрес хоста eCA-СA
”templated”: falseФлаг наличия переменной в URL

Метод получения информации о состоянии сервиса безопасности (security-service)

Заголовок раздела «Метод получения информации о состоянии сервиса безопасности (security-service)»
GET – Получение информации о состоянии сервиса безопасности
Доступность метода для неаутентифицированного пользователя зависит от значения параметра “actuator_authenticate” конфигурационного файла:если параметр имеет значение “true”, доступ к методу будет разрешен только аутентифицированным пользователям;, если параметр имеет значение “false” (по умолчанию), доступ к методу будет разрешен без аутентификации.
URL – security-service/actuator/health
Swagger: -
Query -
Request -
ResponseОтвет JSON в HTTP-body
status (enum: UP, DOWN, OUT_OF_SERVICE, UNKNOWN)Статус (состояние) сервиса безопасности.
Возможные значения: - UP – работает; - DOWN – не работает; - OUT_OF_SERVICE – выключен; - UNKNOWN – нет информации.

Метод получения информации о сервисе безопасности (security-service)

Заголовок раздела «Метод получения информации о сервисе безопасности (security-service)»
GET – Получение информации о сервисе безопасности
Доступность метода для неаутентифицированного пользователя зависит от значения параметра “actuator_authenticate” конфигурационного файла:если параметр имеет значение “true”, доступ к методу будет разрешен только аутентифицированным пользователям;, если параметр имеет значение “false” (по умолчанию), доступ к методу будет разрешен без аутентификации.
URL – security-service/actuator/info
Swagger: -
Query -
Request -
ResponseОтвет JSON в HTTP-body
”application”:
name (string)Название сервиса
version (string)Версия сервиса

Метод получения Prometheus-метрик сервиса безопасности (security-service)

Заголовок раздела «Метод получения Prometheus-метрик сервиса безопасности (security-service)»
GET – Получение Prometheus-метрик сервиса безопасности
Доступность метода для неаутентифицированного пользователя зависит от значения параметра “actuator_authenticate” конфигурационного файла:если параметр имеет значение “true”, доступ к методу будет разрешен только аутентифицированным пользователям;, если параметр имеет значение “false” (по умолчанию), доступ к методу будет разрешен без аутентификации.
URL – security-service/actuator/prometheus
Swagger: -
Query -
Request -
Response
Метод возвращает метрики сервиса в формате Prometheus (text/plain)

Методы получения информации о сервисе лицензий (license-service)

Заголовок раздела «Методы получения информации о сервисе лицензий (license-service)»

Метод получения эндпоинтов для запроса информации о сервисе лицензий (license-service)

Заголовок раздела «Метод получения эндпоинтов для запроса информации о сервисе лицензий (license-service)»
GET – Получение списка доступных эндпоинтов для запроса информации о сервисе лицензий
Доступность метода для неаутентифицированного пользователя зависит от значения параметра “actuator_authenticate” конфигурационного файла:если параметр имеет значение “true”, доступ к методу будет разрешен только аутентифицированным пользователям;, если параметр имеет значение “false” (по умолчанию), доступ к методу будет разрешен без аутентификации.
URL – license-service/actuator
Swagger: -
Query -
Request -
ResponseОтвет JSON в HTTP-body
”_links”:
“self”:
“href”: “https://HOST/license-service/actuator”,URL эндпоинта, который возвращает эндпоинты для запроса информации о сервисе, где HOST – адрес хоста eCA-СA
”templated”: falseФлаг наличия переменной в URL
”health”:
“href”: “https://HOST/license-service/actuator/health”,URL эндпоинта, который возвращает информацию о состоянии сервиса (подробнее см. ниже), где HOST – адрес хоста eCA-СA
”templated”: falseФлаг наличия переменной в URL
”health-path”:
“href”: “https://HOST/license-service/actuator/health/{*path}”,URL зарезервированного эндроинта под будущие реализации
”templated”: trueФлаг наличия переменной в URL
”info”:
“href”: “https://HOST/license-service/actuator/info”,URL эндпоинта, который возвращает информацию о сервисе (подробнее см. ниже), где HOST – адрес хоста eCA-СA
”templated”: falseФлаг наличия переменной в URL
”prometheus”:
“href”: “https://HOST/license-service/actuator/prometheus”,URL эндпоинта, который возвращает метрики сервиса в формате Prometheus (подробнее см. ниже), где HOST – адрес хоста eCA-СA
”templated”: falseФлаг наличия переменной в URL

Метод получения информации о состоянии сервиса лицензий (license-service)

Заголовок раздела «Метод получения информации о состоянии сервиса лицензий (license-service)»
GET – Получение информации о состоянии сервиса лицензий
Доступность метода для неаутентифицированного пользователя зависит от значения параметра “actuator_authenticate” конфигурационного файла:если параметр имеет значение “true”, доступ к методу будет разрешен только аутентифицированным пользователям;, если параметр имеет значение “false” (по умолчанию), доступ к методу будет разрешен без аутентификации.
URL – license-service/actuator/health
Swagger: -
Query -
Request -
ResponseОтвет JSON в HTTP-body
status (enum: UP, DOWN, OUT_OF_SERVICE, UNKNOWN)Статус (состояние) сервиса безопасности.
Возможные значения: - UP – работает; - DOWN – не работает; - OUT_OF_SERVICE – выключен; - UNKNOWN – нет информации.

Метод получения информации о сервисе лицензий (license-service)

Заголовок раздела «Метод получения информации о сервисе лицензий (license-service)»
GET – Получение информации о сервисе лицензий
Доступность метода для неаутентифицированного пользователя зависит от значения параметра “actuator_authenticate” конфигурационного файла:если параметр имеет значение “true”, доступ к методу будет разрешен только аутентифицированным пользователям;, если параметр имеет значение “false” (по умолчанию), доступ к методу будет разрешен без аутентификации.
URL – license-service/actuator/info
Swagger: -
Query -
Request -
ResponseОтвет JSON в HTTP-body
”application”:
name (string)Название сервиса
version (string)Версия сервиса

Метод получения Prometheus-метрик сервиса лицензий (license-service)

Заголовок раздела «Метод получения Prometheus-метрик сервиса лицензий (license-service)»
GET – Получение Prometheus-метрик сервиса лицензий
Доступность метода для неаутентифицированного пользователя зависит от значения параметра “actuator_authenticate” конфигурационного файла:если параметр имеет значение “true”, доступ к методу будет разрешен только аутентифицированным пользователям;, если параметр имеет значение “false” (по умолчанию), доступ к методу будет разрешен без аутентификации.
URL – license-service/actuator/prometheus
Swagger: -
Query -
Request -
Response
Метод возвращает метрики сервиса в формате Prometheus (text/plain)

Методы получения информации о сервисе журнала событий (logs-service)

Заголовок раздела «Методы получения информации о сервисе журнала событий (logs-service)»

Метод получения эндпоинтов для запроса информации о сервисе журнала событий (logs-service)

Заголовок раздела «Метод получения эндпоинтов для запроса информации о сервисе журнала событий (logs-service)»
GET – Получение списка доступных эндпоинтов для запроса информации о сервисе журнала событий
Доступность метода для неаутентифицированного пользователя зависит от значения параметра “actuator_authenticate” конфигурационного файла:если параметр имеет значение “true”, доступ к методу будет разрешен только аутентифицированным пользователям;, если параметр имеет значение “false” (по умолчанию), доступ к методу будет разрешен без аутентификации.
URL – logs-service/actuator
Swagger: -
Query -
Request -
ResponseОтвет JSON в HTTP-body
”_links”:
“self”:
“href”: “https://HOST/logs-service/actuator”,URL эндпоинта, который возвращает эндпоинты для запроса информации о сервисе, где HOST – адрес хоста eCA-СA
”templated”: falseФлаг наличия переменной в URL
”health”:
“href”: “https://HOST/logs-service/actuator/health”,URL эндпоинта, который возвращает информацию о состоянии сервиса (подробнее см. ниже), где HOST – адрес хоста eCA-СA
”templated”: falseФлаг наличия переменной в URL
”health-path”:
“href”: “https://HOST/logs-service/actuator/health/{*path}”,URL зарезервированного эндроинта под будущие реализации
”templated”: trueФлаг наличия переменной в URL
”info”:
“href”: “https://HOST/logs-service/actuator/info”,URL эндпоинта, который возвращает информацию о сервисе (подробнее см. ниже), где HOST – адрес хоста eCA-СA
”templated”: falseФлаг наличия переменной в URL
”prometheus”:
“href”: “https://HOST/logs-service/actuator/prometheus”,URL эндпоинта, который возвращает метрики сервиса в формате Prometheus (подробнее см. ниже), где HOST – адрес хоста eCA-СA
”templated”: falseФлаг наличия переменной в URL

Метод получения информации о состоянии сервиса журнала событий (logs-service)

Заголовок раздела «Метод получения информации о состоянии сервиса журнала событий (logs-service)»
GET – Получение информации о состоянии сервиса журнала событий
Доступность метода для неаутентифицированного пользователя зависит от значения параметра “actuator_authenticate” конфигурационного файла:если параметр имеет значение “true”, доступ к методу будет разрешен только аутентифицированным пользователям;, если параметр имеет значение “false” (по умолчанию), доступ к методу будет разрешен без аутентификации.
URL – logs-service/actuator/health
Swagger: -
Query -
Request -
ResponseОтвет JSON в HTTP-body
status (enum: UP, DOWN, OUT_OF_SERVICE, UNKNOWN)Статус (состояние) сервиса безопасности.
Возможные значения: - UP – работает; - DOWN – не работает; - OUT_OF_SERVICE – выключен; - UNKNOWN – нет информации.

Метод получения информации о сервисе журнала событий (logs-service)

Заголовок раздела «Метод получения информации о сервисе журнала событий (logs-service)»
GET – Получение информации о сервисе журнала событий
Доступность метода для неаутентифицированного пользователя зависит от значения параметра “actuator_authenticate” конфигурационного файла:если параметр имеет значение “true”, доступ к методу будет разрешен только аутентифицированным пользователям;, если параметр имеет значение “false” (по умолчанию), доступ к методу будет разрешен без аутентификации.
URL – logs-service/actuator/info
Swagger: -
Query -
Request -
ResponseОтвет JSON в HTTP-body
”application”:
name (string)Название сервиса
version (string)Версия сервиса

Метод получения Prometheus-метрик сервиса журнала событий (logs-service)

Заголовок раздела «Метод получения Prometheus-метрик сервиса журнала событий (logs-service)»
GET – Получение Prometheus-метрик сервиса журнала событий
Доступность метода для неаутентифицированного пользователя зависит от значения параметра “actuator_authenticate” конфигурационного файла:если параметр имеет значение “true”, доступ к методу будет разрешен только аутентифицированным пользователям;, если параметр имеет значение “false” (по умолчанию), доступ к методу будет разрешен без аутентификации.
URL – logs-service/actuator/prometheus
Swagger: -
Query -
Request -
Response
Метод возвращает метрики сервиса в формате Prometheus (text/plain)

Методы получения информации о сервисе сертификатов (certificate-authority-service)

Заголовок раздела «Методы получения информации о сервисе сертификатов (certificate-authority-service)»

Метод получения эндпоинтов для запроса информации о сервисе сертификатов (certificate-authority-service)

Заголовок раздела «Метод получения эндпоинтов для запроса информации о сервисе сертификатов (certificate-authority-service)»
GET – Получение списка доступных эндпоинтов для запроса информации о сервисе сертификатов
Доступность метода для неаутентифицированного пользователя зависит от значения параметра “actuator_authenticate” конфигурационного файла:если параметр имеет значение “true”, доступ к методу будет разрешен только аутентифицированным пользователям;, если параметр имеет значение “false” (по умолчанию), доступ к методу будет разрешен без аутентификации.
URL – certificate-authority-service/actuator
Swagger: -
Query -
Request -
ResponseОтвет JSON в HTTP-body
”_links”:
“self”:
“href”: “https://HOST/certificate-authority-service /actuator”,URL эндпоинта, который возвращает эндпоинты для запроса информации о сервисе, где HOST – адрес хоста eCA-СA
”templated”: falseФлаг наличия переменной в URL
”health”:
“href”: “https://HOST/certificate-authority-service/actuator/health”,URL эндпоинта, который возвращает информацию о состоянии сервиса (подробнее см. ниже), где HOST – адрес хоста eCA-СA
”templated”: falseФлаг наличия переменной в URL
”health-path”:
“href”: “https://HOST/certificate-authority-service/actuator/health/{*path}”,URL зарезервированного эндроинта под будущие реализации
”templated”: trueФлаг наличия переменной в URL
”info”:
“href”: “https://HOST/certificate-authority-service/actuator/info”,URL эндпоинта, который возвращает информацию о сервисе (подробнее см. ниже), где HOST – адрес хоста eCA-СA
”templated”: falseФлаг наличия переменной в URL
”prometheus”:
“href”: “https://HOST/certificate-authority-service/actuator/prometheus”,URL эндпоинта, который возвращает метрики сервиса в формате Prometheus (подробнее см. ниже), где HOST – адрес хоста eCA-СA
”templated”: falseФлаг наличия переменной в URL

Метод получения информации о состоянии сервиса сертификатов (certificate-authority-service)

Заголовок раздела «Метод получения информации о состоянии сервиса сертификатов (certificate-authority-service)»
GET – Получение информации о состоянии сервиса сертификатов
Доступность метода для неаутентифицированного пользователя зависит от значения параметра “actuator_authenticate” конфигурационного файла:если параметр имеет значение “true”, доступ к методу будет разрешен только аутентифицированным пользователям;, если параметр имеет значение “false” (по умолчанию), доступ к методу будет разрешен без аутентификации.
URL – certificate-authority-service/actuator/health
Swagger: -
Query -
Request -
ResponseОтвет JSON в HTTP-body
status (enum: UP, DOWN, OUT_OF_SERVICE, UNKNOWN)Статус (состояние) сервиса безопасности.
Возможные значения: - UP – работает; - DOWN – не работает; - OUT_OF_SERVICE – выключен; - UNKNOWN – нет информации.

Метод получения информации о сервисе сертификатов (certificate-authority-service)

Заголовок раздела «Метод получения информации о сервисе сертификатов (certificate-authority-service)»
GET – Получение информации о сервисе сертификатов
Доступность метода для неаутентифицированного пользователя зависит от значения параметра “actuator_authenticate” конфигурационного файла:если параметр имеет значение “true”, доступ к методу будет разрешен только аутентифицированным пользователям;, если параметр имеет значение “false” (по умолчанию), доступ к методу будет разрешен без аутентификации.
URL – certificate-authority-service/actuator/info
Swagger: -
Query -
Request -
ResponseОтвет JSON в HTTP-body
”application”:
name (string)Название сервиса
version (string)Версия сервиса

Метод получения Prometheus-метрик сервиса сертификатов (certificate-authority-service)

Заголовок раздела «Метод получения Prometheus-метрик сервиса сертификатов (certificate-authority-service)»
GET – Получение Prometheus-метрик сервиса сертификатов
Доступность метода для неаутентифицированного пользователя зависит от значения параметра “actuator_authenticate” конфигурационного файла:если параметр имеет значение “true”, доступ к методу будет разрешен только аутентифицированным пользователям;, если параметр имеет значение “false” (по умолчанию), доступ к методу будет разрешен без аутентификации.
URL – certificate-authority-service/actuator/prometheus
Swagger: -
Query -
Request -
Response
Метод возвращает метрики сервиса в формате Prometheus (text/plain)

Методы получения информации о сервисе настроек (settings-service)

Заголовок раздела «Методы получения информации о сервисе настроек (settings-service)»

Метод получения эндпоинтов для запроса информации о сервисе настроек (settings-service)

Заголовок раздела «Метод получения эндпоинтов для запроса информации о сервисе настроек (settings-service)»
GET – Получение списка доступных эндпоинтов для запроса информации о сервисе настроек
Доступность метода для неаутентифицированного пользователя зависит от значения параметра “actuator_authenticate” конфигурационного файла:если параметр имеет значение “true”, доступ к методу будет разрешен только аутентифицированным пользователям;, если параметр имеет значение “false” (по умолчанию), доступ к методу будет разрешен без аутентификации.
URL – settings-service/actuator
Swagger: -
Query -
Request -
ResponseОтвет JSON в HTTP-body
”_links”:
“self”:
“href”: “https://HOST/settings-service/actuator”,URL эндпоинта, который возвращает эндпоинты для запроса информации о сервисе, где HOST – адрес хоста eCA-СA
”templated”: falseФлаг наличия переменной в URL
”health”:
“href”: “https://HOST/settings-service/actuator/health”,URL эндпоинта, который возвращает информацию о состоянии сервиса (подробнее см. ниже), где HOST – адрес хоста eCA-СA
”templated”: falseФлаг наличия переменной в URL
”health-path”:
“href”: “https://HOST/settings-service/actuator/health/{*path}”,URL зарезервированного эндроинта под будущие реализации
”templated”: trueФлаг наличия переменной в URL
”info”:
“href”: “https://HOST/settings-service/actuator/info”,URL эндпоинта, который возвращает информацию о сервисе (подробнее см. ниже), где HOST – адрес хоста eCA-СA
”templated”: falseФлаг наличия переменной в URL
”prometheus”:
“href”: “https://HOST/settings-service/actuator/prometheus”,URL эндпоинта, который возвращает метрики сервиса в формате Prometheus (подробнее см. ниже), где HOST – адрес хоста eCA-СA
”templated”: falseФлаг наличия переменной в URL

Метод получения информации о состоянии сервиса настроек (settings-service)

Заголовок раздела «Метод получения информации о состоянии сервиса настроек (settings-service)»
GET – Получение информации о состоянии сервиса настроек
Доступность метода для неаутентифицированного пользователя зависит от значения параметра “actuator_authenticate” конфигурационного файла:если параметр имеет значение “true”, доступ к методу будет разрешен только аутентифицированным пользователям;, если параметр имеет значение “false” (по умолчанию), доступ к методу будет разрешен без аутентификации.
URL – settings-service/actuator/health
Swagger: -
Query -
Request -
ResponseОтвет JSON в HTTP-body
status (enum: UP, DOWN, OUT_OF_SERVICE, UNKNOWN)Статус (состояние) сервиса безопасности.
Возможные значения: - UP – работает; - DOWN – не работает; - OUT_OF_SERVICE – выключен; - UNKNOWN – нет информации.

Метод получения информации о сервисе настроек (settings-service)

Заголовок раздела «Метод получения информации о сервисе настроек (settings-service)»
GET – Получение информации о сервисе настроек
Доступность метода для неаутентифицированного пользователя зависит от значения параметра “actuator_authenticate” конфигурационного файла:если параметр имеет значение “true”, доступ к методу будет разрешен только аутентифицированным пользователям;, если параметр имеет значение “false” (по умолчанию), доступ к методу будет разрешен без аутентификации.
URL – settings-service/actuator/info
Swagger: -
Query -
Request -
ResponseОтвет JSON в HTTP-body
”application”:
name (string)Название сервиса
version (string)Версия сервиса

Метод получения Prometheus-метрик сервиса настроек (settings-service)

Заголовок раздела «Метод получения Prometheus-метрик сервиса настроек (settings-service)»
GET – Получение Prometheus-метрик сервиса настроек
Доступность метода для неаутентифицированного пользователя зависит от значения параметра “actuator_authenticate” конфигурационного файла:если параметр имеет значение “true”, доступ к методу будет разрешен только аутентифицированным пользователям;, если параметр имеет значение “false” (по умолчанию), доступ к методу будет разрешен без аутентификации.
URL – settings-service/actuator/prometheus
Swagger: -
Query -
Request -
Response
Метод возвращает метрики сервиса в формате Prometheus (text/plain)

Методы получения информации о сервисе хранения данных (storage-service)

Заголовок раздела «Методы получения информации о сервисе хранения данных (storage-service)»

Метод получения эндпоинтов для запроса информации о сервисе хранения данных (storage-service)

Заголовок раздела «Метод получения эндпоинтов для запроса информации о сервисе хранения данных (storage-service)»
GET – Получение списка доступных эндпоинтов для запроса информации о сервисе хранения данных
Доступность метода для неаутентифицированного пользователя зависит от значения параметра “actuator_authenticate” конфигурационного файла:если параметр имеет значение “true”, доступ к методу будет разрешен только аутентифицированным пользователям;, если параметр имеет значение “false” (по умолчанию), доступ к методу будет разрешен без аутентификации.
URL – storage-service/actuator
Swagger: -
Query -
Request -
ResponseОтвет JSON в HTTP-body
”_links”:
“self”:
“href”: “https://HOST/storage-service/actuator”,URL эндпоинта, который возвращает эндпоинты для запроса информации о сервисе, где HOST – адрес хоста eCA-СA
”templated”: falseФлаг наличия переменной в URL
”health”:
“href”: “https://HOST/storage-service/actuator/health”,URL эндпоинта, который возвращает информацию о состоянии сервиса (подробнее см. ниже), где HOST – адрес хоста eCA-СA
”templated”: falseФлаг наличия переменной в URL
”health-path”:
“href”: “https://HOST/storage-service/actuator/health/{*path}”,URL зарезервированного эндроинта под будущие реализации
”templated”: trueФлаг наличия переменной в URL
”info”:
“href”: “https://HOST/storage-service/actuator/info”,URL эндпоинта, который возвращает информацию о сервисе (подробнее см. ниже), где HOST – адрес хоста eCA-СA
”templated”: falseФлаг наличия переменной в URL
”prometheus”:
“href”: “https://HOST/storage-service/actuator/prometheus”,URL эндпоинта, который возвращает метрики сервиса в формате Prometheus (подробнее см. ниже), где HOST – адрес хоста eCA-СA
”templated”: falseФлаг наличия переменной в URL

Метод получения информации о состоянии сервиса хранения данных (storage-service)

Заголовок раздела «Метод получения информации о состоянии сервиса хранения данных (storage-service)»
GET – Получение информации о состоянии сервиса хранения данных
Доступность метода для неаутентифицированного пользователя зависит от значения параметра “actuator_authenticate” конфигурационного файла:если параметр имеет значение “true”, доступ к методу будет разрешен только аутентифицированным пользователям;, если параметр имеет значение “false” (по умолчанию), доступ к методу будет разрешен без аутентификации.
URL – storage-service/actuator/health
Swagger: -
Query -
Request -
ResponseОтвет JSON в HTTP-body
status (enum: UP, DOWN, OUT_OF_SERVICE, UNKNOWN)Статус (состояние) сервиса безопасности.
Возможные значения: - UP – работает; - DOWN – не работает; - OUT_OF_SERVICE – выключен; - UNKNOWN – нет информации.

Метод получения информации о сервисе хранения данных (storage-service)

Заголовок раздела «Метод получения информации о сервисе хранения данных (storage-service)»
GET – Получение информации о сервисе хранения данных
Доступность метода для неаутентифицированного пользователя зависит от значения параметра “actuator_authenticate” конфигурационного файла:если параметр имеет значение “true”, доступ к методу будет разрешен только аутентифицированным пользователям;, если параметр имеет значение “false” (по умолчанию), доступ к методу будет разрешен без аутентификации.
URL – storage-service/actuator/info
Swagger: -
Query -
Request -
ResponseОтвет JSON в HTTP-body
”application”:
name (string)Название сервиса
version (string)Версия сервиса

Метод получения Prometheus-метрик сервиса хранения данных (storage-service)

Заголовок раздела «Метод получения Prometheus-метрик сервиса хранения данных (storage-service)»
GET – Получение Prometheus-метрик сервиса хранения данных
Доступность метода для неаутентифицированного пользователя зависит от значения параметра “actuator_authenticate” конфигурационного файла:если параметр имеет значение “true”, доступ к методу будет разрешен только аутентифицированным пользователям;, если параметр имеет значение “false” (по умолчанию), доступ к методу будет разрешен без аутентификации.
URL – storage-service/actuator/prometheus
Swagger: -
Query -
Request -
Response
Метод возвращает метрики сервиса в формате Prometheus (text/plain)

Методы получения информации о сервисе оповещения пользователей (event-delivery-service)

Заголовок раздела «Методы получения информации о сервисе оповещения пользователей (event-delivery-service)»

Метод получения эндпоинтов для запроса информации о сервисе оповещения пользователей (event-delivery-service)

Заголовок раздела «Метод получения эндпоинтов для запроса информации о сервисе оповещения пользователей (event-delivery-service)»
GET – Получение списка доступных эндпоинтов для запроса информации о сервисе оповещения пользователей
Доступность метода для неаутентифицированного пользователя зависит от значения параметра “actuator_authenticate” конфигурационного файла:если параметр имеет значение “true”, доступ к методу будет разрешен только аутентифицированным пользователям;, если параметр имеет значение “false” (по умолчанию), доступ к методу будет разрешен без аутентификации.
URL – event-delivery-service/actuator
Swagger: -
Query -
Request -
ResponseОтвет JSON в HTTP-body
”_links”:
“self”:
“href”: “https://HOST/event-delivery-service/actuator”,URL эндпоинта, который возвращает эндпоинты для запроса информации о сервисе, где HOST – адрес хоста eCA-СA
”templated”: falseФлаг наличия переменной в URL
”health”:
“href”: “https://HOST/event-delivery-service/actuator/health”,URL эндпоинта, который возвращает информацию о состоянии сервиса (подробнее см. ниже), где HOST – адрес хоста eCA-СA
”templated”: falseФлаг наличия переменной в URL
”health-path”:
“href”: “https://HOST/event-delivery-service/actuator/health/{*path}”,URL зарезервированного эндроинта под будущие реализации
”templated”: trueФлаг наличия переменной в URL
”info”:
“href”: “https://HOST/event-delivery-service/actuator/info”,URL эндпоинта, который возвращает информацию о сервисе (подробнее см. ниже), где HOST – адрес хоста eCA-СA
”templated”: falseФлаг наличия переменной в URL
”prometheus”:
“href”: “https://HOST/event-delivery-service/actuator/prometheus”,URL эндпоинта, который возвращает метрики сервиса в формате Prometheus (подробнее см. ниже), где HOST – адрес хоста eCA-СA
”templated”: falseФлаг наличия переменной в URL

Метод получения информации о состоянии сервиса оповещения пользователей (event-delivery-service)

Заголовок раздела «Метод получения информации о состоянии сервиса оповещения пользователей (event-delivery-service)»
GET – Получение информации о состоянии сервиса оповещения пользователей
Доступность метода для неаутентифицированного пользователя зависит от значения параметра “actuator_authenticate” конфигурационного файла:если параметр имеет значение “true”, доступ к методу будет разрешен только аутентифицированным пользователям;, если параметр имеет значение “false” (по умолчанию), доступ к методу будет разрешен без аутентификации.
URL – event-delivery-service/actuator/health
Swagger: -
Query -
Request -
ResponseОтвет JSON в HTTP-body
status (enum: UP, DOWN, OUT_OF_SERVICE, UNKNOWN)Статус (состояние) сервиса безопасности.
Возможные значения: - UP – работает; - DOWN – не работает; - OUT_OF_SERVICE – выключен; - UNKNOWN – нет информации.

Метод получения информации о сервисе оповещения пользователей (event-delivery-service)

Заголовок раздела «Метод получения информации о сервисе оповещения пользователей (event-delivery-service)»
GET – Получение информации о сервисе оповещения пользователей
Доступность метода для неаутентифицированного пользователя зависит от значения параметра “actuator_authenticate” конфигурационного файла:если параметр имеет значение “true”, доступ к методу будет разрешен только аутентифицированным пользователям;, если параметр имеет значение “false” (по умолчанию), доступ к методу будет разрешен без аутентификации.
URL – event-delivery-service/actuator/info
Swagger: -
Query -
Request -
ResponseОтвет JSON в HTTP-body
”application”:
name (string)Название сервиса
version (string)Версия сервиса

Метод получения Prometheus-метрик сервиса оповещения пользователей (event-delivery-service)

Заголовок раздела «Метод получения Prometheus-метрик сервиса оповещения пользователей (event-delivery-service)»
GET – Получение Prometheus-метрик сервиса оповещения пользователей
Доступность метода для неаутентифицированного пользователя зависит от значения параметра “actuator_authenticate” конфигурационного файла:если параметр имеет значение “true”, доступ к методу будет разрешен только аутентифицированным пользователям;, если параметр имеет значение “false” (по умолчанию), доступ к методу будет разрешен без аутентификации.
URL – event-delivery-service/actuator/prometheus
Swagger: -
Query -
Request -
Response
Метод возвращает метрики сервиса в формате Prometheus (text/plain)

Методы получения информации о сервисе внешних интеграций (external-integration-service)

Заголовок раздела «Методы получения информации о сервисе внешних интеграций (external-integration-service)»

Метод получения эндпоинтов для запроса информации о сервисе внешних интеграций (external-integration-service)

Заголовок раздела «Метод получения эндпоинтов для запроса информации о сервисе внешних интеграций (external-integration-service)»
GET – Получение списка доступных эндпоинтов для запроса информации о сервисе внешних интеграций
Доступность метода для неаутентифицированного пользователя зависит от значения параметра “actuator_authenticate” конфигурационного файла:если параметр имеет значение “true”, доступ к методу будет разрешен только аутентифицированным пользователям;, если параметр имеет значение “false” (по умолчанию), доступ к методу будет разрешен без аутентификации.
URL – external-integration-service/actuator
Swagger: -
Query -
Request -
ResponseОтвет JSON в HTTP-body
”_links”:
“self”:
“href”: “https://HOST/external-integration-service/actuator”,URL эндпоинта, который возвращает эндпоинты для запроса информации о сервисе, где HOST – адрес хоста eCA-СA
”templated”: falseФлаг наличия переменной в URL
”health”:
“href”: “https://HOST/external-integration-service/actuator/health”,URL эндпоинта, который возвращает информацию о состоянии сервиса (подробнее см. ниже), где HOST – адрес хоста eCA-СA
”templated”: falseФлаг наличия переменной в URL
”health-path”:
“href”: “https://HOST/external-integration-service/actuator/health/{*path}”,URL зарезервированного эндроинта под будущие реализации
”templated”: trueФлаг наличия переменной в URL
”info”:
“href”: “https://HOST/external-integration-service/actuator/info”,URL эндпоинта, который возвращает информацию о сервисе (подробнее см. ниже), где HOST – адрес хоста eCA-СA
”templated”: falseФлаг наличия переменной в URL
”prometheus”:
“href”: “https://HOST/external-integration-service/actuator/prometheus”,URL эндпоинта, который возвращает метрики сервиса в формате Prometheus (подробнее см. ниже), где HOST – адрес хоста eCA-СA
”templated”: falseФлаг наличия переменной в URL

Метод получения информации о состоянии сервиса внешних интеграций (external-integration-service)

Заголовок раздела «Метод получения информации о состоянии сервиса внешних интеграций (external-integration-service)»
GET – Получение информации о состоянии сервиса внешних интеграций
Доступность метода для неаутентифицированного пользователя зависит от значения параметра “actuator_authenticate” конфигурационного файла:если параметр имеет значение “true”, доступ к методу будет разрешен только аутентифицированным пользователям;, если параметр имеет значение “false” (по умолчанию), доступ к методу будет разрешен без аутентификации.
URL – external-integration-service/actuator/health
Swagger: -
Query -
Request -
ResponseОтвет JSON в HTTP-body
status (enum: UP, DOWN, OUT_OF_SERVICE, UNKNOWN)Статус (состояние) сервиса безопасности.
Возможные значения: - UP – работает; - DOWN – не работает; - OUT_OF_SERVICE – выключен; - UNKNOWN – нет информации.

Метод получения информации о сервисе внешних интеграций (external-integration-service)

Заголовок раздела «Метод получения информации о сервисе внешних интеграций (external-integration-service)»
GET – Получение информации о сервисе внешних интеграций
Доступность метода для неаутентифицированного пользователя зависит от значения параметра “actuator_authenticate” конфигурационного файла:если параметр имеет значение “true”, доступ к методу будет разрешен только аутентифицированным пользователям;, если параметр имеет значение “false” (по умолчанию), доступ к методу будет разрешен без аутентификации.
URL – external-integration-service/actuator/info
Swagger: -
Query -
Request -
ResponseОтвет JSON в HTTP-body
”application”:
name (string)Название сервиса
version (string)Версия сервиса

Метод получения Prometheus-метрик сервиса внешних интеграций (external-integration-service)

Заголовок раздела «Метод получения Prometheus-метрик сервиса внешних интеграций (external-integration-service)»
GET – Получение Prometheus-метрик сервиса внешних интеграций
Доступность метода для неаутентифицированного пользователя зависит от значения параметра “actuator_authenticate” конфигурационного файла:если параметр имеет значение “true”, доступ к методу будет разрешен только аутентифицированным пользователям;, если параметр имеет значение “false” (по умолчанию), доступ к методу будет разрешен без аутентификации.
URL – external-integration-service/actuator/prometheus
Swagger: -
Query -
Request -
Response
Метод возвращает метрики сервиса в формате Prometheus (text/plain)

Методы работы с Syslog-серверами

Заголовок раздела «Методы работы с Syslog-серверами»

Метод поиска Syslog-серверов

Заголовок раздела «Метод поиска Syslog-серверов»
GET API – Поиск Syslog-серверов
Метод доступен только администратору
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/[v3] Контроллер%3A Syslog сервера/findAll_10
URL – logs-service/api/v3/public/syslog
Query -
Request -
Response ResponseEntity -> CollectionResponse ->Ответ JSON в HTTP-body
id (UUID),ID Syslog-сервера
host (string),Имя хоста Syslog-сервера
port (int32),Порт Syslog-сервера
protocol (enum: UDP, TCP, UNKNOWN),Протокол Syslog-сервера
active (boolean)Флаг: состояние настройки публикации событий

Метод получения Syslog-сервера по идентификатору

Заголовок раздела «Метод получения Syslog-сервера по идентификатору»
GET API – Получение Syslog-сервера по идентификатору
Метод доступен только администратору
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/[v3] Контроллер%3A Syslog сервера/findById_9
URL – logs-service/api/v3/public/syslog/{id
Query
id (uuid)ID Syslog-сервера
Request -
ResponseОтвет JSON в HTTP-body
id (UUID),ID Syslog-сервера
host (string),Имя хоста Syslog-сервера
port (int32),Порт Syslog-сервера
protocol (enum: UDP, TCP, UNKNOWN),Протокол Syslog-сервера
active (boolean)Флаг: состояние настройки публикации событий

Метод создания Syslog-сервера

Заголовок раздела «Метод создания Syslog-сервера»
POST API – Создание Syslog-сервера
Метод доступен только администратору
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/[v3] Контроллер%3A Syslog сервера/create
URL – logs-service/api/v3/public/syslog
Query -
Request
host (string),Имя хоста Syslog-сервера
port (int32),Порт Syslog-сервера
protocol (enum: UDP, TCP, UNKNOWN)Протокол Syslog-сервера
ResponseОтвет JSON в HTTP-body
id (UUID),ID Syslog-сервера
host (string),Имя хоста Syslog-сервера
port (int32),Порт Syslog-сервера
protocol (enum: UDP, TCP, UNKNOWN),Протокол Syslog-сервера
active (boolean)Флаг: состояние настройки публикации событий

Метод обновления Syslog-сервера

Заголовок раздела «Метод обновления Syslog-сервера»
PUT API – Обновление Syslog-сервера
Метод доступен только администратору
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/[v3] Контроллер%3A Syslog сервера/updateById
URL – logs-service/api/v3/public/syslog/{id
Query
id (uuid)ID Syslog-сервера
Request
host (string),Имя хоста Syslog-сервера
port (int32),Порт Syslog-сервера
protocol (enum: UDP, TCP, UNKNOWN)Протокол Syslog-сервера
ResponseОтвет JSON в HTTP-body
id (UUID),ID Syslog-сервера
host (string),Имя хоста Syslog-сервера
port (int32),Порт Syslog-сервера
protocol (enum: UDP, TCP, UNKNOWN),Протокол Syslog-сервера
active (boolean)Флаг: состояние настройки публикации событий

Метод деактивации Syslog-сервера

Заголовок раздела «Метод деактивации Syslog-сервера»
PATCH API – Деактивация Syslog-сервера
Метод доступен только администратору
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/[v3] Контроллер%3A Syslog сервера/deactivate
URL – logs-service/api/v3/public/syslog/{id}/deactivate
Query
id (uuid)ID Syslog-сервера
Request -
Response -

Метод активации Syslog-сервера

Заголовок раздела «Метод активации Syslog-сервера»
PATCH API – Активация Syslog-сервера
Метод доступен только администратору
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/[v3] Контроллер%3A Syslog сервера/activate
URL – logs-service/api/v3/public/syslog/{id}/activate
Query
id (uuid)ID Syslog-сервера
Request -
Response -

Метод удаления Syslog-сервера

Заголовок раздела «Метод удаления Syslog-сервера»
DELETE API – Удаление Syslog-сервера
Метод доступен только администратору
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/[v3] Контроллер%3A Syslog сервера/deleteById_2
URL – logs-service/api/v3/public/syslog/{id
Query
id (uuid)ID Syslog-сервера
Request -
Response -

Методы работы с учетными записями

Заголовок раздела «Методы работы с учетными записями»

Метод поиска учетных записей

Заголовок раздела «Метод поиска учетных записей»
GET API – Поиск учетных записей
Метод доступен администратору
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/[v3] Контроллер%3A Учетные записи/findAll_9
URL – security-service/api/v3/public/accounts
Query
id (uuid[]) [опционально],Фильтр: ID учетной записи
notId (uuid[]) [опционально],Фильтр: ID учетной записи (исключающий)
logins (uuid[]) [опционально],Фильтр: логин учетной записи
search (string) [опциональноФильтр: полнотекстовый поиск по отображаемому имени
Request -
Response ResponseEntity -> CollectionResponse ->Ответ JSON в HTTP-body
id (UUID),ID учетной записи
login (string),Логин учетной записи
principalName (string),Отображаемое учетной записи
role (enum: ADMINISTRATOR, OPERATOR, UNKNOWN),Роль учетной записи
status (enum: ACTIVE, BLOCKED, UNKNOWN),Статус учетной записи
created (instant),Время создания (ISO 8601)
isLinked (boolean)Флаг: связь с субъектом из ресурсной системы

Метод получения учетной записи по идентификатору

Заголовок раздела «Метод получения учетной записи по идентификатору»
GET API – Получение учетной записи по идентификатору
Метод доступен администратору, а также оператору для получения данных о его собственной учетной записи
Swagger: https://HOST/external-integration-service/ swagger/swagger-ui/index.html#/[v3] Контроллер%3A Учетные записи/findById_8
URL – security-service/api/v3/public/accounts /{id
Query
id (uuid)ID учетной записи
Request -
Response ResponseEntity -> CollectionResponse ->Ответ JSON в HTTP-body
id (UUID),ID учетной записи
login (string),Логин учетной записи
principalName (string),Отображаемое учетной записи
role (enum: ADMINISTRATOR, OPERATOR, UNKNOWN),Роль учетной записи
status (enum: ACTIVE, BLOCKED, UNKNOWN),Статус учетной записи
created (instant),Время создания (ISO 8601)
isLinked (boolean)Флаг: связь с субъектом из ресурсной системы

Метод получения учетной записи по отпечатку сертификата

Заголовок раздела «Метод получения учетной записи по отпечатку сертификата»
GET API – Получение учетной записи по отпечатку сертификата
Метод доступен администратору
Swagger: https://HOST/external-integration-service/ swagger/swagger-ui/index.html#/[v3] Контроллер%3A Учетные записи/getByFingerprint
URL – security-service/api/v3/public/accounts/fingerprint/{fingerprint
Query
fingerprint (string)Отпечаток сертификата
Request -
Response ResponseEntity -> CollectionResponse ->Ответ JSON в HTTP-body
id (UUID),ID учетной записи
login (string),Логин учетной записи
principalName (string),Отображаемое учетной записи
role (enum: ADMINISTRATOR, OPERATOR, UNKNOWN),Роль учетной записи
status (enum: ACTIVE, BLOCKED, UNKNOWN),Статус учетной записи
created (instant),Время создания (ISO 8601)
isLinked (boolean)Флаг: связь с субъектом из ресурсной системы

Метод получения учетной записи по идентификатору субъекта

Заголовок раздела «Метод получения учетной записи по идентификатору субъекта»
GET API – Получение учетной записи по идентификатору субъекта
Метод доступен администратору
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/[v3] Контроллер%3A Учетные записи/findBySubjectId
URL – security-service/api/v3/public/accounts/subject/{subjectId
Query
subjectId (string)Идентификатор субъекта
Request -
Response ResponseEntity -> CollectionResponse ->Ответ JSON в HTTP-body
id (UUID),ID учетной записи
login (string),Логин учетной записи
principalName (string),Отображаемое учетной записи
role (enum: ADMINISTRATOR, OPERATOR, UNKNOWN),Роль учетной записи
status (enum: ACTIVE, BLOCKED, UNKNOWN),Статус учетной записи
created (instant),Время создания (ISO 8601)
isLinked (boolean)Флаг: связь с субъектом из ресурсной системы

Методы работы с издателями

Заголовок раздела «Методы работы с издателями»

Метод поиска издателей

Заголовок раздела «Метод поиска издателей»
GET API – Поиск учетных записей
Метод доступен администратору
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/[v3] Контроллер%3A Издатели/findAll_8
URL – settings-service/api/v3/public/issuer
Query
authorityKeyIdentifier (string),Идентификатор ключа издателя
subjectKeyIdentifier (string),Идентификатор ключа сертификата ЦС
isActive (boolean),Флаг: активный ЦС
sortDirection (string) [опционально],Направления сортировки (ASC;DESC)
sortBy (string[])[опционально],Список полей, к которым применяется сортировка
pageOffset (integer) [опционально],Смещение от начала списка (пагинация)
pageLimit (integer) [опциональноОграничение на размер выборки (пагинация)
Request -
Response ResponseEntity -> CollectionResponse ->Ответ JSON в HTTP-body
id (UUID),ID издателя
caId (UUID),ID ЦС
validFrom (instant),Дата начала действия сертификата ЦС (ISO 8601)
validTo (instant),Дата окончания действия сертификата ЦС (ISO 8601)
name (string),Имя сертификата ЦС (на основе CN)
title (string),Отображаемое имя ЦС
subjectKeyIdentifier (string),Идентификатор ключа сертификата ЦС
authorityKeyIdentifier (string),Идентификатор ключа издателя сертификата ЦС
active (boolean)Флаг: активный ЦС

Методы работы с группами безопасности

Заголовок раздела «Методы работы с группами безопасности»

Метод поиска групп безопасности

Заголовок раздела «Метод поиска групп безопасности»
GET API – Поиск групп безопасности
Метод доступен администратору
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/[v3] Контроллер%3A группы безопасности/findAll_3
URL – subjects-service/api/v3/public/security-groups
Query
sortDirection (string) [опционально],Направления сортировки (ASC;DESC)
sortBy (string[])[опционально],Список полей, к которым применяется сортировка
pageOffset (integer) [опционально],Смещение от начала списка (пагинация)
pageLimit (integer) [опционально],Ограничение на размер выборки (пагинация)
id (UUID[])[опционально],ID группы безопасности
notId (UUID[])[опционально],Исключая ID группы безопасности
resourceId (UUID) [опционально],ID ресурсной системы
subjectId (uuid) [опционально],Идентификатор субъекта
search (string) [опционально],Фильтр: полнотекстовый поиск
isActive (boolean)Флаг: активная для назначения прав группа безопасности
Request -
Response ResponseEntity -> CollectionResponse ->Ответ JSON в HTTP-body
id (UUID),ID группы безопасности
commonName (string),Имя группы безопасности
distinguishedName (string),DN группы безопасности
resource:Ресурсная система
id (UUID),ID ресурсной системы
commonName (string),Имя ресурсной системы
distinguishedName (string),DN ресурсной системы
isActive (boolean),Флаг: активная для назначения прав группа безопасности
modify (instant),Дата и время обновления в ресурсной системе (ISO 8601)
updated (instant),Время обновления (ISO 8601)
created (instant)Время создания (ISO 8601)

Метод получения группы безопасности по идентификатору

Заголовок раздела «Метод получения группы безопасности по идентификатору»
GET API – Получение группы безопасности по идентификатору
Метод доступен администратору
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/[v3] Контроллер%3A группы безопасности/findById_3
URL – subjects-service/api/v3/public/security-groups/{id
Query
id (uuid) [опциональноID группы безопасности
Request -
ResponseОтвет JSON в HTTP-body
id (UUID),ID группы безопасности
commonName (string),Имя группы безопасности
distinguishedName (string),DN группы безопасности
resource:Ресурсная система
id (UUID),ID ресурсной системы
commonName (string),Имя ресурсной системы
distinguishedName (string),DN ресурсной системы
isActive (boolean),Флаг: активная для назначения прав группа безопасности
modify (instant),Дата и время обновления в ресурсной системе (ISO 8601)
updated (instant),Время обновления (ISO 8601)
created (instant)Время создания (ISO 8601)

Методы работы с центрами валидации

Заголовок раздела «Методы работы с центрами валидации»

Метод проверки доступности центра валидации

Заголовок раздела «Метод проверки доступности центра валидации»
PUT API – Метод проверки доступности центра валидации
Метод доступен только администратору
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/
URL – validation-authority-service/api/v3/public/validation-authorities/{id}/heartbeat
Query
id (uuid)ID центра валидации
Request -
Response -

Метод регистрации центра валидации

Заголовок раздела «Метод регистрации центра валидации»
POST API – Регистрация центра валидации
Метод доступен только администратору
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/
URL – validation-authority-service/api/v3/public/validation-authorities/{id
Query
id (uuid)ID центра валидации
Request
certificateAuthorityId (UUID),ID центра сертификации
instanceId (UUID),ID экземпляра центра валидации
hostname (string),Адрес хоста eCA-VA
httpsPort (int),HTTPS порт доступа к Центру валидации
httpPort (int),HTTP порт доступа к Центру валидации
crl:Информация о точке распространения CRL
distribution (string),URL распространения
publication (string),URL публикации
info (string)URL получения информации о точке
deltacrl:Информация о точке распространения Delta CRL
distribution (string),URL распространения
publication (string),URL публикации
info (string)URL получения информации о точке
aia:Информация о точке распространения AIA
distribution (string),URL распространения
publication (string),URL публикации
info (string)URL получения информации о точке
ResponseОтвет JSON в HTTP-body
id (uuid),ID центра валидации
certificateAuthorityId (UUID),ID центра сертификации
instanceId (UUID),ID экземпляра центра валидации
hostname (string),Адрес хоста eCA-VA
isLegacy (boolean),Флаг: ЦВ старой версии
lastUpdate (instant),Время последнего подключения (ISO 8601)
created (instant),Время создания (ISO 8601)
updated (instant),Время обновления (ISO 8601)

Метод удаления центра валидации

Заголовок раздела «Метод удаления центра валидации»
DELETE API – Удаление центра валидации
Метод доступен только администратору
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/
URL – validation-authority-service/api/v3/public/validation-authorities/{id
Query
id (uuid)ID центра валидации
Request -
Response -

Метод создания службы OCSP

Заголовок раздела «Метод создания службы OCSP»
POST API – Создание службы OCSP
Метод доступен только администратору
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/
Контроллер%3A%20Службы%20OCSP%20Центров%20валидации/createOcspByVaId
URL – validation-authority-service/api/v3/public/validation-authorities/{vaId}/ocsp-services
Query
id (uuid)ID центра валидации
Request
url (string),URL службы
info (string)URL получения информации о службе
ResponseОтвет JSON в HTTP-body
id (uuid),ID службы
caId (uuid),ID центра сертификации
vaId (uuid),ID центра валидации
url (string),URL службы
info (string),URL получения информации о службе
vaHost (string),Адрес хоста eCA-VA
priority(int),Приоритет службы
children {вложенные объекты с аналогичной структуройДочерние службы OCSP
created (instant),Время создания (ISO 8601)
updated (instant),Время обновления (ISO 8601)
active (boolean)Флаг: служба OCSP активна

Метод удаления службы OCSP

Заголовок раздела «Метод удаления службы OCSP»
DELETE API – Удаление службы OCSP
Метод доступен только администратору
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/
Контроллер%3A%20Службы%20OCSP%20Центров%20валидации/deleteOcspByVaId
URL – validation-authority-service/api/v3/public/validation-authorities/{vaId}/ocsp-services
Query
id (uuid)ID центра валидации
Request -
Response -

[7]. Отличных от JaCarta®. ↑

[8]. В случае использования множественных значений для фильтра “keyAlgorithm” в ответе метода будут содержаться шаблоны, в которых включен хотя бы один алгоритм из перечня, указанного в данном фильтре. ↑

[9]. Тип CERTIFICATE является общим для всех словарей типов сертификатов в программе. При использовании данного метода указание данного типа также доступно, однако сертификаты ЦС с данным типом отсутствуют, соответственно не будут найдены и возвращены в ответе. ↑

[10]. Шаблоны в eCA-CA 2.2 содержат поле “Центр сертификации” (поле “certificateAuthorityId” в API v3), определяющее ЦС, на котором должен быть издан сертификат. В случае, если для указанного в поле “templateId” шаблона задан ЦС, отличный от указанного в поле “caId”, ответ данного метода будет иметь код 500 и будет содержать сообщение об ошибке “Шаблон {идентификатор шаблона} не может быть использован для выпуска сертификата на центре сертификации {идентификатор центра сертификации из поля “caId”}”. При использовании шаблона, в котором в поле “Центр сертификации” указано значение “Любой”, выпуск сертификата будет происходить на ЦС, указанном в поле “caId”. ↑

[11]. Шаблоны в eCA-CA 2.2 содержат поле “Центр сертификации” (поле “certificateAuthorityId” в API v3), определяющее ЦС, на котором должен быть издан сертификат. В случае, если для указанного в поле “templateId” шаблона задан ЦС, отличный от указанного в поле “caId”, ответ данного метода будет иметь код 500 и будет содержать сообщение об ошибке “Шаблон {идентификатор шаблона} не может быть использован для выпуска сертификата на центре сертификации {идентификатор центра сертификации из поля “caId”}”. При использовании шаблона, в котором в поле “Центр сертификации” указано значение “Любой”, выпуск сертификата будет происходить на ЦС, указанном в поле “caId”. ↑

[12]. Шаблоны в eCA-CA 2.2 содержат поле “Центр сертификации” (поле “certificateAuthorityId” в API v3), определяющее ЦС, на котором должен быть издан сертификат. В случае, если для указанного в поле “templateId” шаблона задан ЦС, отличный от указанного в поле “caId”, ответ данного метода будет иметь код 500 и будет содержать сообщение об ошибке “Шаблон {идентификатор шаблона} не может быть использован для выпуска сертификата на центре сертификации {идентификатор центра сертификации из поля “caId”}”. При использовании шаблона, в котором в поле “Центр сертификации” указано значение “Любой”, выпуск сертификата будет происходить на ЦС, указанном в поле “caId”. ↑

[13]. В eCA-CA 2.4 реализована поддержка работы с ресурсной системой “ROSA Dynamic Directory”, однако в API v3 при получении точек подключения к данной РС ее тип в поле “domainType” указывается как “FREE_IPA”. Начиная с API v4 в поле “domainType” для точек подключения к ресурсной системе “ROSA Dynamic Directory” указывается значение “ROSA_DD”. ↑

[14]. В eCA-CA 2.4 реализована поддержка работы с ресурсной системой “ROSA Dynamic Directory”, однако в API v3 при получении точек подключения к данной РС ее тип в поле “domainType” указывается как “FREE_IPA”. Начиная с API v4 в поле “domainType” для точек подключения к ресурсной системе “ROSA Dynamic Directory” указывается значение “ROSA_DD”. ↑