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

7.1.2. REST API eCA-CA (версия 4)

Aladdin Enterprise CAAPI и SDKAladdin Enterprise CA

Раздел: REST API eCA-CA.

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

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

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

Заголовок раздела «Метод поиска субъектов»
GET API – Поиск субъектов
Метод доступен администратору и оператору
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/
URL – subjects-service/api/v4/public/subjects
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,
DATEOFBIRTH,
PLACEOFBIRTH,
ROLE,
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 – Получение субъекта по идентификатору
Метод доступен администратору и оператору при наличии полномочий на управление субъектом, идентификатор которого передается во входных параметрах
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/
URL – subjects-service/api/v4/public/subjects/{id
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,
DATEOFBIRTH,
PLACEOFBIRTH,
ROLE,
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 – Создание и изменение субъекта
Метод доступен администратору и оператору при наличии полномочий
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/
URL – subjects-service/api/v4/public/subjects
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, DATEOFBIRTH, PLACEOFBIRTH, ROLE, 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,
DATEOFBIRTH,
PLACEOFBIRTH,
ROLE,
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)
Метод доступен администратору и оператору при наличии полномочий
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/
URL – subjects-service/api/v4/public/subjects/pkcs10
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,
DATEOFBIRTH,
PLACEOFBIRTH,
ROLE,
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)
Метод доступен администратору и оператору при наличии полномочий
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/
URL – subjects-service/api/v4/public/subjects/pkcs10
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,
DATEOFBIRTH,
PLACEOFBIRTH,
ROLE,
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 – Поиск шаблонов
Метод доступен администратору и оператору.
В ответе для оператора содержатся только те шаблоны, на использование которых ему предоставлены полномочия.
URL – templates-service/api/v4/public/templates
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/
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) [опционально],Фильтр: алгоритм ключа включен в шаблоне[15]
extendedKeyUsage (string[])[опционально],Фильтр: расширенное использование ключа
isCertificateAuthorityIdEmpty(boolean) [опционально],Фильтр: ID издающего ЦС не задан
issuePkcs12Allow (boolean) [опционально],Фильтр: Шаблон позволяет выпуск PKCS#12
deprecated (boolean) [опционально],Фильтр: Устаревший шаблон
keyUsage (enum[]:DIGITAL_SIGNATURE, NON_REPUDIATION, KEY_ENCIPHERMENT, DATA_ENCIPHERMENT, KEY_AGREEMENT, KEY_CERT_SIGN, CRL_SIGN, ENCIPHER_ONLY, DECIPHER_ONLY, UNKNOWN) [опционально],Фильтр: использование ключа
keyUsageMatchAll (boolean) [опционально],Фильтр: шаблон должен содержать все указанные значения использования ключа
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 субъекта в сертификат
pkcs12Policies:Политики выпуска PKCS#12
passwordRegex (string),Регулярное выражение для пароля PKCS#12
issueAllow(boolean)Флаг возможности выпуска PKCS#12
subjectValidationEnabled(boolean),Флаг: контролировать соответствие полей в сертификате атрибутам субъекта
deprecated (boolean)Флаг: Устаревший шаблон

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

Заголовок раздела «Метод получения шаблона по идентификатору»
GET API – Получение шаблона по идентификатору
Метод доступен:администратору;, оператору при наличии полномочий на использование шаблона, идентификатор которого передается во входных параметрах.
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/
URL – templates-service/api/v4/public/templates/{id
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,
DATEOFBIRTH,
PLACEOFBIRTH,
ROLE,
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),Флаг: публиковать сертификат в РС
pkcs12Policies:Политики выпуска PKCS#12
passwordRegex (string),Регулярное значение для валидации пароля PKCS#12
issueAllow (boolean)Флаг: Шаблон позволяет выпуск PKCS#12
allowThrowaway (boolean),Флаг: Шаблон позволяет throwaway-сертификата
appendIssuerSignTool(boolean),Флаг: Включать сведения о средствах ЭП и УЦ издателя
issuerSignTool:
signTool(string),Средство электронной подписи
caTool(string),Средство УЦ
signToolCert(string),Заключение на средство ЭП
caToolCert(string)Заключение на средство УЦ
appendSubjectSignTool (boolean),Флаг: Включать сведения о средстве ЭП владельца
subjectSignTool:Средство электронной подписи владельца
signTool (string)Средство электронной подписи владельца
subjectValidationEnabled(boolean),Флаг: контролировать соответствие полей в сертификате атрибутам субъекта
deprecated (boolean),Флаг: Устаревший шаблон
version (int64)Версия шаблона

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

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

Метод получения активного ЦС

Заголовок раздела «Метод получения активного ЦС»
GET API – Получение активного ЦС
Метод доступен администратору и оператору.
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/
URL – certificate-authority-service/api/v4/public/certificate-authorities/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,
DATEOFBIRTH,
PLACEOFBIRTH,
ROLE,
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,
DATEOFBIRTH,
PLACEOFBIRTH,
ROLE,
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,
DATEOFBIRTH,
PLACEOFBIRTH,
ROLE,
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, ALADDIN_JCP, UNKNOWN),Название криптопровайдера
isAvailable (boolean),Флаг: Доступность криптопровайдера
primaryCryptographyProvider:Криптопровайдер закрытого ключа
cryptographyProvider (enum: DEFAULT, CRYPTO_PRO, ALADDIN_JCP, UNKNOWN),Название криптопровайдера
isAvailable (boolean),Флаг: Доступность криптопровайдера
isAvailable (boolean),Флаг: Доступность ЦС
updated (instant),Время обновления (ISO 8601)
created (instant)Время создания (ISO 8601)

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

Заголовок раздела «Метод получения ЦС по идентификатору»
GET API – Получение ЦС по идентификатору
Метод доступен администратору.
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/
URL – certificate-authority-service/api/v4/public/certificate-authorities/{id
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,
DATEOFBIRTH,
PLACEOFBIRTH,
ROLE,
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,
DATEOFBIRTH,
PLACEOFBIRTH,
ROLE,
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,
DATEOFBIRTH,
PLACEOFBIRTH,
ROLE,
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, ALADDIN_JCP, UNKNOWN),Название криптопровайдера
isAvailable (boolean),Флаг: Доступность криптопровайдера
primaryCryptographyProvider:Криптопровайдер закрытого ключа
cryptographyProvider (enum: DEFAULT, CRYPTO_PRO, ALADDIN_JCP, UNKNOWN),Название криптопровайдера
isAvailable (boolean),Флаг: Доступность криптопровайдера
isAvailable (boolean),Флаг: Доступность ЦС
updated (instant),Время обновления (ISO 8601)
created (instant)Время создания (ISO 8601)

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

Заголовок раздела «Метод получения Центров сертификации»
GET API – Получение ЦС
Метод доступен администратору.
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/
URL – certificate-authority-service/api/v4/public/certificate-authorities
Query
status (enum[]:ACTIVE, HOLD, REVOKE, REQUEST, UNKNOWN) [опционально],Статус сертификата ЦС
type (enum[]: CERTIFICATE[16], 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,
DATEOFBIRTH,
PLACEOFBIRTH,
ROLE,
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,
DATEOFBIRTH,
PLACEOFBIRTH,
ROLE,
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,
DATEOFBIRTH,
PLACEOFBIRTH,
ROLE,
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, ALADDIN_JCP, UNKNOWN),Название криптопровайдера
isAvailable (boolean),Флаг: Доступность криптопровайдера
primaryCryptographyProvider:Криптопровайдер закрытого ключа
cryptographyProvider (enum: DEFAULT, CRYPTO_PRO, ALADDIN_JCP, UNKNOWN),Название криптопровайдера
isAvailable (boolean),Флаг: Доступность криптопровайдера
isAvailable (boolean),Флаг: Доступность ЦС
updated (instant),Время обновления (ISO 8601)
created (instant)Время создания (ISO 8601)

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

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

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

Заголовок раздела «Метод выпуска сертификата в контейнере pkcs#12»
POST API – Выпуск сертификата в контейнере pkcs#12
Метод доступен:администратору;, оператору при наличии полномочий на управление субъектами и использование шаблона, идентификаторы которых передаются во входных параметрах.Использование данного метода оператором для создания сертификатов для учетных записей запрещено.
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/
URL – certificate-authority-service/api/v4/public/certificates/enroll/{caId
Query
caId (UUID),ID ЦС
subjectId (UUID) [обязателен, если не указан userId],ID субъекта
userId (UUID) [обязателен, если не указан subjectIdID учетной записи
Request
templateId (UUID),Идентификатор шаблона
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, DATEOFBIRTH, PLACEOFBIRTH, ROLE, 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, DATEOFBIRTH, PLACEOFBIRTH, ROLE, 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, DATEOFBIRTH, PLACEOFBIRTH, ROLE, 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)
Метод доступен:администратору;, оператору при наличии полномочий на управление субъектами и использование шаблона, идентификаторы которых передаются во входных параметрах.Использование данного метода оператором для создания сертификатов для учетных записей запрещено.
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/
URL – certificate-authority-service/api/v4/public/certificates/enroll/{caId}/pkcs10
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, DATEOFBIRTH, PLACEOFBIRTH, ROLE, 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, DATEOFBIRTH, PLACEOFBIRTH, ROLE, 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, DATEOFBIRTH, PLACEOFBIRTH, ROLE, 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)
Метод доступен:администратору;, оператору при наличии полномочий на управление субъектами и использование шаблона, идентификаторы которых передаются во входных параметрах.Использование данного метода оператором для создания сертификатов для учетных записей запрещено.
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/
URL – certificate-authority-service/api/v4/public/certificates/enroll/{caId}/pkcs10
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, DATEOFBIRTH, PLACEOFBIRTH, ROLE, 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, DATEOFBIRTH, PLACEOFBIRTH, ROLE, 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, DATEOFBIRTH, PLACEOFBIRTH, ROLE, 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” аналогичный указанному в запросе на сертификат из входных параметров.
Если такой сертификат не будет найден, данный метод осуществит выпуск нового сертификата по запросу аналогично методу выпуска сертификата по запросу.
Если сертификат с аналогичным указанному в запросе на сертификат “Subject Key Identifier” будет найден, программа: 1) проверит статус найденного сертификата.
Если срок действия данного сертификата истек, запрос пользователя будет отклонен. 2) проверит соответствие значений в полях SDN и SAN, указанных в запросе (или во входных параметрах метода), значениям в полях SDN и SAN в найденном сертификате.
При соответствии значений будет осуществлен выпуск сертификата по запросу на сертификат из входных параметров метода, иначе запрос пользователя будет отклонен.
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/
URL – certificate-authority-service/api/v4/public/certificates/renewal/{caId}/pkcs10
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, DATEOFBIRTH, PLACEOFBIRTH, ROLE, 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, DATEOFBIRTH, PLACEOFBIRTH, ROLE, 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, DATEOFBIRTH, PLACEOFBIRTH, ROLE, 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 в найденном сертификате.
При соответствии значений будет осуществлен выпуск сертификата по запросу на сертификат из входных параметров метода, иначе запрос пользователя будет отклонен.
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/
URL – certificate-authority-service/api/v4/public/certificates/renewal/{caId}/pkcs10
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, DATEOFBIRTH, PLACEOFBIRTH, ROLE, 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, DATEOFBIRTH, PLACEOFBIRTH, ROLE, 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, DATEOFBIRTH, PLACEOFBIRTH, ROLE, 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)
Метод доступен:администратору;, оператору при наличии полномочий на управление субъектами и использование шаблона, идентификаторы которых передаются во входных параметрах.Использование данного метода оператором для валидации запросов на сертификат для учетных записей должно быть запрещено.
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/
URL – certificate-authority-service/api/v4/public/certificates/validate/{caId}/pkcs10
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, DATEOFBIRTH, PLACEOFBIRTH, ROLE, 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, DATEOFBIRTH, PLACEOFBIRTH, ROLE, 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)
Метод доступен:администратору;, оператору при наличии полномочий на управление субъектами и использование шаблона, идентификаторы которых передаются во входных параметрах.Использование данного метода оператором для валидации запросов на сертификат для учетных записей запрещено.
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/
URL – certificate-authority-service/api/v4/public/certificates/validate/{caId}/pkcs10
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, DATEOFBIRTH, PLACEOFBIRTH, ROLE, 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, DATEOFBIRTH, PLACEOFBIRTH, ROLE, 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 – Поиск сертификатов
Метод доступен администратору и оператору
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/
URL – certificate-authority-service/api/v4/public/certificates
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,
DATEOFBIRTH,
PLACEOFBIRTH,
ROLE,
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,
DATEOFBIRTH,
PLACEOFBIRTH,
ROLE,
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 – Получение сертификата по идентификатору
Метод доступен администратору и оператору при наличии полномочий
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/
URL – certificate-authority-service/api/v4/public/certificates/{id
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,
DATEOFBIRTH,
PLACEOFBIRTH,
ROLE,
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,
DATEOFBIRTH,
PLACEOFBIRTH,
ROLE,
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,
DATEOFBIRTH,
PLACEOFBIRTH,
ROLE,
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 – Получение сертификата по его серийному номеру
Метод доступен администратору и оператору при наличии полномочий
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/
URL – certificate-authority-service/api/v4/public/certificates/serialNumber/{serialnumber
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,
DATEOFBIRTH,
PLACEOFBIRTH,
ROLE,
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,
DATEOFBIRTH,
PLACEOFBIRTH,
ROLE,
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,
DATEOFBIRTH,
PLACEOFBIRTH,
ROLE,
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 – Получение сертификата по его отпечатку
Метод доступен администратору и оператору при наличии полномочий
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/
URL – certificate-authority-service/api/v4/public/certificates/fingerprint/{fingerprint
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,
DATEOFBIRTH,
PLACEOFBIRTH,
ROLE,
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,
DATEOFBIRTH,
PLACEOFBIRTH,
ROLE,
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,
DATEOFBIRTH,
PLACEOFBIRTH,
ROLE,
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 – Расшифровка контейнера сертификата
Метод доступен администратору
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/
URL – certificate-authority-service/api/v4/public/parse/pkcs12
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,
DATEOFBIRTH,
PLACEOFBIRTH,
ROLE,
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,
DATEOFBIRTH,
PLACEOFBIRTH,
ROLE,
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 – Расшифровка сертификата
Метод доступен администратору
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/
URL – certificate-authority-service/api/v4/public/parse/pem
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,
DATEOFBIRTH,
PLACEOFBIRTH,
ROLE,
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,
DATEOFBIRTH,
PLACEOFBIRTH,
ROLE,
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,
DATEOFBIRTH,
PLACEOFBIRTH,
ROLE,
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 – Расшифровка запроса на сертификат
Метод доступен администратору
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/
URL – certificate-authority-service/api/v4/public/parse/pkcs10
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, DATEOFBIRTH, PLACEOFBIRTH, ROLE, 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,
DATEOFBIRTH,
PLACEOFBIRTH,
ROLE,
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)Идентификатор ключа сертификата

Метод выпуска короткоживущего (short-lived, throwaway) сертификата в контейнере PKCS#12

Заголовок раздела «Метод выпуска короткоживущего (short-lived, throwaway) сертификата в контейнере PKCS#12»
POST API – Выпуск короткоживущего (short-lived, throwaway) сертификата в контейнере PKCS#12
Метод доступен:администратору;, оператору при наличии полномочий на использование шаблона, идентификатор которого передается во входных параметрах.Выпуск короткоживущего (short-lived, throwaway) сертификата с помощью данного метода будет выполняться успешно только при соблюдении следующих условий:выпуск данного вида сертификатов разрешен в соответствии с параметрами лицензии, примененной в ПО eCA-CA.
В противном случае будет возвращено сообщение об ошибке с кодом 403 и текстом “Выпуск короткоживущих (short-lived, throwaway) сертификатов недоступен в соответствии с параметрами лицензии”;, для выпуска используется шаблон с включенной опцией “Короткоживущий (short-lived, throwaway) сертификат”.
В противном случае будет возвращено сообщение об ошибке с кодом 400 и текстом “Выпуск короткоживущих (short-lived, throwaway) сертификатов недоступен по данному шаблону”;, для выпуска используется шаблон с включенной опцией “Выпуск сертификатов с закрытым ключом (PKCS#12)”, иначе метод вернет сообщение об ошибке с кодом 400 и текстом “Выпуск сертификатов с закрытым ключом (PKCS#12) недоступен по данному шаблону”., указываемый во входных параметрах пароль от контейнера соответствует требованиям регулярного выражения по шаблону, иначе метод вернет сообщение об ошибке с кодом 400 и текстом “Пароль не соответствует регулярному выражению, указанному в шаблоне”.Успешно выпущенный с использованием данного метода сертификат:не будет сохранен в базе данных ПО eCA-CA;, не будет содержать записей о точках распространения CRL, Delta CRL и службах OCSP, однако может содержать записи о точках AIA;, не будет иметь владельца-субъекта, и, как следствие, не повлияет на лицензируемое количество субъектов с действующими сертификатами.
URL – certificate-authority-service/api/v4/public/certificates/enroll/{caId}/throwaway
Query
caId (UUID)ID ЦС
Request
templateId (UUID),Идентификатор шаблона
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, DATEOFBIRTH, PLACEOFBIRTH, ROLE, 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 Файл контейнера PKCS#12 (byte)

Методы выпуска короткоживущего (short-lived, throwaway) сертификата на основании запроса PKCS#10

Заголовок раздела «Методы выпуска короткоживущего (short-lived, throwaway) сертификата на основании запроса PKCS#10»

Выпуск короткоживущего (short-lived, throwaway) сертификата на основании запроса PKCS#10 (формат запроса на сертификат из входных параметров – multipart/form-data)

Заголовок раздела «Выпуск короткоживущего (short-lived, throwaway) сертификата на основании запроса PKCS#10 (формат запроса на сертификат из входных параметров – multipart/form-data)»
POST API – Выпуск короткоживущего (short-lived, throwaway) сертификата на основании запроса PKCS#10
Метод доступен:администратору;, оператору при наличии полномочий на использование шаблона, идентификатор которого передается во входных параметрах.Выпуск короткоживущего (short-lived, throwaway) сертификата с помощью данного метода будет выполняться успешно только при соблюдении следующих условий:выпуск данного вида сертификатов разрешен в соответствии с параметрами лицензии, примененной в ПО eCA-CA.
В противном случае будет возвращено сообщение об ошибке с кодом 403 и текстом “Выпуск короткоживущих (short-lived, throwaway) сертификатов недоступен в соответствии с параметрами лицензии”;, для выпуска используется шаблон с включенной опцией “Короткоживущий (short-lived, throwaway) сертификат”.
В противном случае будет возвращено сообщение об ошибке с кодом 400 и текстом “Выпуск короткоживущих (short-lived, throwaway) сертификатов недоступен по данному шаблону”.Успешно выпущенный с использованием данного метода сертификат:не будет сохранен в базе данных ПО eCA-CA;, не будет содержать записей о точках распространения CRL, Delta CRL и службах OCSP, однако может содержать записи о точках AIA;, не будет иметь владельца-субъекта, и, как следствие, не повлияет на лицензируемое количество субъектов с действующими сертификатами.
URL – certificate-authority-service/api/v4/public/certificates/enroll/{caId}/pkcs10/throwaway
Query
caId (UUID)ID ЦС
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, DATEOFBIRTH, PLACEOFBIRTH, ROLE, 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 Файл цепочки сертификатов выпущенного сертификата (byte)

Выпуск короткоживущего (short-lived, throwaway) сертификата на основании запроса PKCS#10 (формат запроса на сертификат из входных параметров – application/json)

Заголовок раздела «Выпуск короткоживущего (short-lived, throwaway) сертификата на основании запроса PKCS#10 (формат запроса на сертификат из входных параметров – application/json)»

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

POST API – Выпуск короткоживущего (short-lived, throwaway) сертификата на основании запроса PKCS#10
Метод доступен:администратору;, оператору при наличии полномочий на использование шаблона, идентификатор которого передается во входных параметрах.Выпуск короткоживущего (short-lived, throwaway) сертификата с помощью данного метода будет выполняться успешно только при соблюдении следующих условий:выпуск данного вида сертификатов разрешен в соответствии с параметрами лицензии, примененной в ПО eCA-CA.
В противном случае будет возвращено сообщение об ошибке с кодом 403 и текстом “Выпуск короткоживущих (short-lived, throwaway) сертификатов недоступен в соответствии с параметрами лицензии”;, для выпуска используется шаблон с включенной опцией “Короткоживущий (short-lived, throwaway) сертификат”.
В противном случае будет возвращено сообщение об ошибке с кодом 400 и текстом “Выпуск короткоживущих (short-lived, throwaway) сертификатов недоступен по данному шаблону”.Успешно выпущенный с использованием данного метода сертификат:не будет сохранен в базе данных ПО eCA-CA;, не будет содержать записей о точках распространения CRL, Delta CRL и службах OCSP, однако может содержать записи о точках AIA;, не будет иметь владельца-субъекта, и, как следствие, не повлияет на лицензируемое количество субъектов с действующими сертификатами.
URL – certificate-authority-service/api/v4/public/certificates/enroll/{caId}/pkcs10/throwaway
Query
caId (UUID)ID ЦС
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, DATEOFBIRTH, PLACEOFBIRTH, ROLE, 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 Файл цепочки сертификатов выпущенного сертификата (byte)

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

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

Метод поиска точек подключения

Заголовок раздела «Метод поиска точек подключения»
GET API – Поиск точек подключения к РС
Метод доступен администратору и оператору
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/[v4] Контроллер%3A Точки подключения ресурсных систем/findAll_12
URL – ldap-service/api/v4/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, ROSA_DD, UNKNOWN),Тип точки подключения
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#/[v4] Контроллер%3A Точки подключения ресурсных систем/findById_11
URL – ldap-service/api/v4/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, ROSA_DD, UNKNOWN),Тип точки подключения
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#/
URL – ldap-service/api/v4/public/connection-points/{pointId}/synchronize
Query
pointId (UUID)ID точки подключения
Request -
Response -

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

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

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

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

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

Заголовок раздела «Метод получения Syslog-сервера по идентификатору»
GET API – Получение Syslog-сервера по идентификатору
Метод доступен только администратору
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/
URL – logs-service/api/v4/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, TCP_TLS, UNKNOWN),Протокол Syslog-сервера
active (boolean)Флаг: состояние настройки публикации событий

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

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

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

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

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

Заголовок раздела «Метод деактивации Syslog-сервера»
PATCH API – Деактивация Syslog-сервера
Метод доступен только администратору
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/
URL – logs-service/api/v4/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#/
URL – logs-service/api/v4/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#/
URL – logs-service/api/v4/public/syslog/{id
Query
id (uuid)ID Syslog-сервера
Request -
Response -

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

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