10.1.2. REST API eCA-CA (версия 3)
Методы идентификации и аутентификации
Заголовок раздела «Методы идентификации и аутентификации»Метод идентификации и аутентификации по сертификату доступа
Заголовок раздела «Метод идентификации и аутентификации по сертификату доступа»| Параметр | Значение |
|---|---|
| Метод | POST API – Аутентификация с помощью сертификата |
| Описание | |
| URL | x509-provider-service/api/v3/public/auth/sign-in/x509 |
| Swagger | https://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv3%5D%20Контроллер%3A%20Авторизации/signInByX509 |
| Query | |
| Request | |
| Response | ResponseEntity -> { ItemResponse -> token (string), refresh (string) } |
Метод обновления маркера доступа
Заголовок раздела «Метод обновления маркера доступа»| Параметр | Значение |
|---|---|
| Метод | POST API – Обновление токена доступа |
| Описание | Метод доступен администратору и оператору |
| URL | security-service/api/v3/public/auth/refresh-token |
| Swagger | https://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv3%5D%20Контроллер%3A%20Авторизации/refreshToken |
| Query | |
| Request | |
| Response | ResponseEntity -> { ItemResponse -> token (string), refresh (string) } |
Метод обновления последней активности учётной записи
Заголовок раздела «Метод обновления последней активности учётной записи»| Параметр | Значение |
|---|---|
| Метод | PUT API – Обновление последней активности учетной записи по ее идентификатору |
| Описание | Метод доступен только администратору |
| URL | security-service/api/v3/public/accounts/{accountId}/activity |
| Swagger | https://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv3%5D%20Контроллер%3A%20Учетные%20записи/updateActivity |
| Query | { (id – обязательный параметр) id (UUID) } |
| Request | |
| Response |
Метод аутентификации по Kerberos-ticket
Заголовок раздела «Метод аутентификации по Kerberos-ticket»| Параметр | Значение |
|---|---|
| Метод | POST API – Аутентификация по Kerberos-ticket |
| Описание | |
| URL | security-service/api/v3/public/auth/sign-in/kerberos |
| Swagger | https://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv3%5D%20Контроллер%3A%20Авторизации/kerberosSigIn |
| Query | |
| Request | |
| Response | { token (string), refresh (string) } |
Метод аутентификации по логину и паролю
Заголовок раздела «Метод аутентификации по логину и паролю»| Параметр | Значение |
|---|---|
| Метод | POST API – Аутентификация по логину и паролю |
| Описание | |
| URL | security-service/api/v3/public/auth/sign-in/ldap |
| Swagger | https://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv3%5D%20Контроллер%3A%20Авторизации/ldapSignIn |
| Query | |
| Request | { username (string), password (string) } |
| Response | { token (string), refresh (string) } |
Методы работы с лицензией
Заголовок раздела «Методы работы с лицензией»Метод получения информации о возможности использования сторонних ключевых носителей в соответствии с параметрами лицензии
Заголовок раздела «Метод получения информации о возможности использования сторонних ключевых носителей в соответствии с параметрами лицензии»| Параметр | Значение |
|---|---|
| Метод | GET API – Метод получения информации о возможности использования сторонних ключевых носителей в соответствии с параметрами лицензии |
| Описание | Метод доступен только администратору. Если по текущей лицензии разрешено использование сторонних1 ключевых носителей, ответ метода будет иметь код 204. Если по текущей лицензии разрешено использование сторонних ключевых носителей, ответ метода будет иметь код 403 и сообщение «Использование сторонних токенов запрещено лицензией». |
| URL | license-service/api/v3/public/restrictions/third-party-tokens |
| Swagger | https://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv3%5D%20Контроллер%3A%20Лицензионные%20ограничения/checkThirdPartyTokens |
| Query | |
| Request | |
| Response |
Методы работы с субъектами
Заголовок раздела «Методы работы с субъектами»Метод поиска субъектов
Заголовок раздела «Метод поиска субъектов»| Параметр | Значение |
|---|---|
| Метод | GET API – Поиск субъектов |
| Описание | Метод доступен администратору и оператору. В ответе для оператора содержатся только те субъекты, на просмотр или управление которых ему предоставлены полномочия. В ответе данного метода в поле «subjectName» атрибуты «ROLE» (роль), «DATEOFBIRTH» (дата рождения) и «PLACEOFBIRTH» (место рождения) в случае их наличия у субъекта будут указаны как «UNKNOWN». Данные атрибуты поддерживаются в публичном API начиная с версии v4. |
| URL | subjects-service/api/v3/public/subjects |
| Swagger | https://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv3%5D%20Контроллер%3A%20субъекты/findAll_2 |
| Query | { search (string) [опционально], isBlocked (boolean) [опционально], isConnected (boolean) [опционально], id (UUID[])[опционально], notId (UUID[])[опционально], securityGroupId (UUID[])[опционально], resourceId (UUID[])[опционально], sortDirection (string) [опционально], sortBy (string[])[опционально], pageOffset (integer) [опционально], pageLimit (integer) [опционально] } |
| Request | |
| Response | ResponseEntity -> { CollectionResponse -> id (UUID), commonName (string) distinguishedName (string), resource: { id (uuid), commonName (string), distinguishedName (string) }, subjectName: { (enum: CN, UID, E, EMAILADDRESS, MAIL, SN, GIVENNAME, INITIALS, SURNAME, OU, O, L, ST, DC, C, UNSTRUCTUREDADDRESS, UNSTRUCTUREDNAME, POSTALCODE, BUSINESSCATEGORY, TELEPHONENUMBER, PSEUDONYM, POSTALADDRESS, STREET, NAME, T, DN, DESCRIPTION, INN, OGRN, OGRNIP, SNILS, INNLE, UNKNOWN): { values (string[]), editable (boolean), } }, subjectAltName: { (enum: RFC822NAME, DNS_NAME, IPADDRESS, DIRECTORY_NAME, UNIFORM_RESOURCE_ID, REGISTERED_ID, MS_UPN, MS_GUID, KRB5PRINCIPAL, PERMANENT_IDENTIFIER, XMPP_ADDR, SRV_NAME, SUBJECT_IDENTIFICATION_METHOD, UNKNOWN): { values (string[]), editable (boolean), } }, isConnected (boolean), isBlocked (boolean), certificatesCount (integer), modify (instant), updated (instant), created (instant), sid (string) } |
Метод получения субъекта по идентификатору
Заголовок раздела «Метод получения субъекта по идентификатору»| Параметр | Значение |
|---|---|
| Метод | GET API – Получение субъекта по идентификатору |
| Описание | Метод доступен администратору и оператору при наличии полномочий на просмотр или управление субъектом, идентификатор которого передается во входных параметрах. В ответе данного метода в поле «subjectName» атрибуты «ROLE» (роль), «DATEOFBIRTH» (дата рождения) и «PLACEOFBIRTH» (место рождения) в случае их наличия у субъекта будут указаны как «UNKNOWN». Данные атрибуты поддерживаются в публичном API начиная с версии v4. |
| URL | subjects-service/api/v3/public/subjects/{id} |
| Swagger | https://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv3%5D%20Контроллер%3A%20субъекты/findById_2 |
| Query | { id (UUID) } |
| Request | |
| Response | ResponseEntity -> { ItemResponse -> id (UUID), commonName (string) distinguishedName (string), resource: { id (uuid), commonName (string), distinguishedName (string) }, subjectName: { (enum: CN, UID, E, EMAILADDRESS, MAIL, SN, GIVENNAME, INITIALS, SURNAME, OU, O, L, ST, DC, C, UNSTRUCTUREDADDRESS, UNSTRUCTUREDNAME, POSTALCODE, BUSINESSCATEGORY, TELEPHONENUMBER, PSEUDONYM, POSTALADDRESS, STREET, NAME, T, DN, DESCRIPTION, INN, OGRN, OGRNIP, SNILS, INNLE, UNKNOWN): { values (string[]), editable (boolean), } }, subjectAltName: { (enum: RFC822NAME, DNS_NAME, IPADDRESS, DIRECTORY_NAME, UNIFORM_RESOURCE_ID, REGISTERED_ID, MS_UPN, MS_GUID, KRB5PRINCIPAL, PERMANENT_IDENTIFIER, XMPP_ADDR, SRV_NAME, SUBJECT_IDENTIFICATION_METHOD, UNKNOWN): { values (string[]), editable (boolean), } }, isConnected (boolean), isBlocked (boolean), certificatesCount (integer), modify (instant), updated (instant), created (instant), sid (string) } |
Метод создания и изменения субъекта
Заголовок раздела «Метод создания и изменения субъекта»| Параметр | Значение |
|---|---|
| Метод | PUT API – Создание и изменение субъекта |
| Описание | Метод доступен администратору и оператору при наличии полномочий на управление субъектами |
| URL | subjects-service/api/v3/public/subjects |
| Swagger | https://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv3%5D%20Контроллер%3A%20субъекты/update |
| Query | |
| Request | { id (UUID) [опционально], subjectName: { (enum: CN, UID, E, EMAILADDRESS, MAIL, SN, GIVENNAME, INITIALS, SURNAME, OU, O, L, ST, DC, C, UNSTRUCTUREDADDRESS, UNSTRUCTUREDNAME, POSTALCODE, BUSINESSCATEGORY, TELEPHONENUMBER, PSEUDONYM, POSTALADDRESS, STREET, NAME, T, DN, DESCRIPTION, INN, OGRN, OGRNIP, SNILS, INNLE, UNKNOWN): string[] } [опционально], subjectAltName: { (enum: RFC822NAME, DNS_NAME, IPADDRESS, DIRECTORY_NAME, UNIFORM_RESOURCE_ID, REGISTERED_ID, MS_UPN, MS_GUID, KRB5PRINCIPAL, PERMANENT_IDENTIFIER, XMPP_ADDR, SRV_NAME, SUBJECT_IDENTIFICATION_METHOD, UNKNOWN): string[] } [опционально] } |
| Response | ResponseEntity -> { ItemResponse -> id (UUID), commonName (string) distinguishedName (string), resource: { id (uuid), commonName (string), distinguishedName (string) }, subjectName: { (enum: CN, UID, E, EMAILADDRESS, MAIL, SN, GIVENNAME, INITIALS, SURNAME, OU, O, L, ST, DC, C, UNSTRUCTUREDADDRESS, UNSTRUCTUREDNAME, POSTALCODE, BUSINESSCATEGORY, TELEPHONENUMBER, PSEUDONYM, POSTALADDRESS, STREET, NAME, T, DN, DESCRIPTION, INN, OGRN, OGRNIP, SNILS, INNLE, UNKNOWN): { values (string[]), editable (boolean), } }, subjectAltName: { (enum: RFC822NAME, DNS_NAME, IPADDRESS, DIRECTORY_NAME, UNIFORM_RESOURCE_ID, REGISTERED_ID, MS_UPN, MS_GUID, KRB5PRINCIPAL, PERMANENT_IDENTIFIER, XMPP_ADDR, SRV_NAME, SUBJECT_IDENTIFICATION_METHOD, UNKNOWN): { values (string[]), editable (boolean), } }, isConnected (boolean), isBlocked (boolean), certificatesCount (integer), modify (instant), updated (instant), created (instant), sid (string) } |
Методы создания и изменения субъекта на основании запроса pkcs#10
Заголовок раздела «Методы создания и изменения субъекта на основании запроса pkcs#10»Метод создания и изменения субъекта на основании запроса pkcs#10 (формат запроса на сертификат из входных параметров – multipart/form-data)
Заголовок раздела «Метод создания и изменения субъекта на основании запроса pkcs#10 (формат запроса на сертификат из входных параметров – multipart/form-data)»| Параметр | Значение |
|---|---|
| Метод | PUT API – Создание и изменение субъекта на основании запроса pkcs#10 (multipart/form-data) |
| Описание | Метод доступен администратору и оператору при наличии полномочий на управление субъектами |
| URL | subjects-service/api/v3/public/subjects/pkcs10 |
| Swagger | https://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv3%5D%20Контроллер%3A%20субъекты/updateByPkcs10AsMultipartFile_1 |
| Query | |
| Request | { Id (UUID) [опционально], request (binary), 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 -> id (UUID), commonName (string) distinguishedName (string), resource: { id (uuid), commonName (string), distinguishedName (string) }, subjectName: { (enum: CN, UID, E, EMAILADDRESS, MAIL, SN, GIVENNAME, INITIALS, SURNAME, OU, O, L, ST, DC, C, UNSTRUCTUREDADDRESS, UNSTRUCTUREDNAME, POSTALCODE, BUSINESSCATEGORY, TELEPHONENUMBER, PSEUDONYM, POSTALADDRESS, STREET, NAME, T, DN, DESCRIPTION, INN, OGRN, OGRNIP, SNILS, INNLE, UNKNOWN): { values (string[]), editable (boolean), } }, subjectAltName: { (enum: RFC822NAME, DNS_NAME, IPADDRESS, DIRECTORY_NAME, UNIFORM_RESOURCE_ID, REGISTERED_ID, MS_UPN, MS_GUID, KRB5PRINCIPAL, PERMANENT_IDENTIFIER, XMPP_ADDR, SRV_NAME, SUBJECT_IDENTIFICATION_METHOD, UNKNOWN): { values (string[]), editable (boolean), } }, isConnected (boolean), isBlocked (boolean), certificatesCount (integer), modify (instant), updated (instant), created (instant), sid (string) } |
Метод создания и изменения субъекта на основании запроса pkcs#10 (формат запроса на сертификат из входных параметров – application/json)
Заголовок раздела «Метод создания и изменения субъекта на основании запроса pkcs#10 (формат запроса на сертификат из входных параметров – application/json)»| Параметр | Значение |
|---|---|
| Метод | PUT API – Создание и изменение субъекта на основании запроса pkcs#10 (application/json) |
| Описание | Метод доступен администратору и оператору при наличии полномочий на управление субъектами |
| URL | subjects-service/api/v3/public/subjects/pkcs10 |
| Swagger | https://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv3%5D%20Контроллер%3A%20субъекты/updateByPkcs10AsMultipartFile_1 |
| Query | |
| Request | { Id (UUID) [опционально], request: { contentType (string) [опционально], fileName (string) [опционально], data (string:binary) }, 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 -> id (UUID), commonName (string) distinguishedName (string), resource: { id (uuid), commonName (string), distinguishedName (string) }, subjectName: { (enum: CN, UID, E, EMAILADDRESS, MAIL, SN, GIVENNAME, INITIALS, SURNAME, OU, O, L, ST, DC, C, UNSTRUCTUREDADDRESS, UNSTRUCTUREDNAME, POSTALCODE, BUSINESSCATEGORY, TELEPHONENUMBER, PSEUDONYM, POSTALADDRESS, STREET, NAME, T, DN, DESCRIPTION, INN, OGRN, OGRNIP, SNILS, INNLE, UNKNOWN): { values (string[]), editable (boolean), } }, subjectAltName: { (enum: RFC822NAME, DNS_NAME, IPADDRESS, DIRECTORY_NAME, UNIFORM_RESOURCE_ID, REGISTERED_ID, MS_UPN, MS_GUID, KRB5PRINCIPAL, PERMANENT_IDENTIFIER, XMPP_ADDR, SRV_NAME, SUBJECT_IDENTIFICATION_METHOD, UNKNOWN): { values (string[]), editable (boolean), } }, isConnected (boolean), isBlocked (boolean), certificatesCount (integer), modify (instant), updated (instant), created (instant), sid (string) } |
Примечание: отличается от метода выше форматом передаваемого во входных параметрах запроса на сертификат. В данном методе на вход поступает содержимое файла запроса на сертификат в формате PEM (содержимое в Base64).
Метод удаления субъекта
Заголовок раздела «Метод удаления субъекта»| Параметр | Значение |
|---|---|
| Метод | DELETE API – Удаление субъекта |
| Описание | Метод доступен администратору и оператору при наличии полномочий на локальную РС |
| URL | subjects-service/api/v3/public/subjects/{id} |
| Swagger | https://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv3%5D%20Контроллер%3A%20субъекты/deleteById |
| Query | { (id – обязательный параметр) id (UUID) } |
| Request | |
| Response |
Метод поиска идентификаторов субъектов
Заголовок раздела «Метод поиска идентификаторов субъектов»| Параметр | Значение |
|---|---|
| Метод | GET API – Поиск ID субъектов |
| Описание | Метод доступен администратору и оператору |
| URL | subjects-service/api/v3/public/subjects/ids |
| Swagger | https://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv3%5D%20Контроллер%3A%20субъекты/findAllAsIds |
| Query | { search (string) [опционально], isBlocked (boolean) [опционально], isConnected (boolean) [опционально], id (UUID[])[опционально], notId (UUID[])[опционально], securityGroupId (UUID[])[опционально], resourceId (UUID[])[опционально], sortDirection (string) [опционально], sortBy (string[])[опционально], pageOffset (integer) [опционально], pageLimit (integer) [опционально] } |
| Request | |
| Response | ResponseEntity -> { CollectionResponse -> items (UUID) } |
Методы работы с шаблонами сертификатов
Заголовок раздела «Методы работы с шаблонами сертификатов»Сопоставление идентификаторов шаблонов
| Идентификатор 1.2.0 | Идентификатор 2.x |
|---|---|
| 100001 | 9129245a-eaad-4ebc-a2a4-8845ac0336fb |
| 100002 | af3b0355-1798-4c64-98f7-a9c70407db1c |
| 100003 | bf2dac0a-f05f-49dd-95b4-e50691489b6a |
| 100004 | aa03e458-50cd-46b8-82cd-d5612ed3b647 |
| 100005 | aac2e49b-9c8e-4869-80c1-eef526ba75ab |
| 100006 | 059a38f5-f345-4275-b79f-e7e6cc3cbb68 |
| 100007 | 08c66f99-218a-46ef-bdee-6a2b3b26a4f1 |
| 100008 | 0c234243-18cf-4c05-b699-537731b2436f |
| 100009 | 11ec34a4-d03e-4059-92f0-9c09b08bffea |
| 100010 | 18d9bd4e-6f15-423f-8137-ac8416ad6874 |
Сопоставление идентификаторов шаблонов
| Идентификатор 1.2.0 | Идентификатор 2.x |
|---|---|
| 100001 | 9129245a-eaad-4ebc-a2a4-8845ac0336fb |
| 100002 | af3b0355-1798-4c64-98f7-a9c70407db1c |
| 100003 | bf2dac0a-f05f-49dd-95b4-e50691489b6a |
| 100004 | aa03e458-50cd-46b8-82cd-d5612ed3b647 |
| 100005 | aac2e49b-9c8e-4869-80c1-eef526ba75ab |
| 100006 | 059a38f5-f345-4275-b79f-e7e6cc3cbb68 |
| 100007 | 08c66f99-218a-46ef-bdee-6a2b3b26a4f1 |
| 100008 | 0c234243-18cf-4c05-b699-537731b2436f |
| 100009 | 11ec34a4-d03e-4059-92f0-9c09b08bffea |
| 100010 | 18d9bd4e-6f15-423f-8137-ac8416ad6874 |
Метод поиска шаблонов
Заголовок раздела «Метод поиска шаблонов»| Параметр | Значение |
|---|---|
| Метод | GET API – Поиск шаблонов |
| Описание | Метод доступен администратору и оператору. В ответе для оператора содержатся только те шаблоны, на использование которых ему предоставлены полномочия |
| URL | templates-service/api/v3/public/templates |
| Swagger | https://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv3%5D%20Контроллер%3A%20шаблоны/findAll |
| Query | { types (enum[]: EMBEDDED, CLONED, IMPORTED, UNKNOWN) [опционально], certificateType (enum[]: CERTIFICATE, ROOT_CA, SUB_CA, UNKNOWN) [опционально], endEntityType (enum[]: USER, DEVICE, ROOT_CA, SUB_CA, UNKNOWN) [опционально], search (string) [опционально], removed (boolean) [опционально], id (UUID[])[опционально], notId (UUID[])[опционально], keyAlgorithm (enum[]:RSA, ECDSA, GOST_R_34_10_2012, UNKNOWN) [опционально], extendedKeyUsage (string[])[опционально], isCertificateAuthorityIdEmpty(boolean) [опционально], sortDirection (string) [опционально], sortBy (string[])[опционально], pageOffset (integer) [опционально], pageLimit (integer) [опционально] } |
| Request | |
| Response | ResponseEntity -> { CollectionResponse -> id (UUID), name (string), type (enum: EMBEDDED, CLONED, IMPORTED, UNKNOWN), certificateType (enum: CERTIFICATE, ROOT_CA, SUB_CA, UNKNOWN), certificateAuthorityId (UUID), endEntityType (enum: USER, DEVICE, ROOT_CA, SUB_CA, UNKNOWN), certificateCount (int64), removed (boolean), updated (instant), created (instant), appendSubjectSId (boolean) } |
Метод получения шаблона по идентификатору
Заголовок раздела «Метод получения шаблона по идентификатору»| Параметр | Значение |
|---|---|
| Метод | GET API – Получение шаблона по идентификатору |
| Описание | Метод доступен: администратору; оператору при наличии полномочий на использование шаблона, идентификатор которого передается во входных параметрах. В ответе данного метода в поле «subjectDN» компоненты «ROLE» (роль), «DATEOFBIRTH» (дата рождения) и «PLACEOFBIRTH» (место рождения) в случае их наличия в шаблоне будут указаны как «UNKNOWN». Данные компоненты поддерживаются в публичном API начиная с версии v4. |
| URL | templates-service/api/v3/public/templates/{id} |
| Swagger | https://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv3%5D%20Контроллер%3A%20шаблоны/findById |
| Query | { id (UUID) } |
| Request | |
| Response | ResponseEntity -> { ItemResponse -> id (UUID), name (string), type (enum: EMBEDDED, CLONED, IMPORTED, UNKNOWN), certificateType (enum: CERTIFICATE, ROOT_CA, SUB_CA, UNKNOWN), certificateAuthorityId (UUID), endEntityType (enum: USER, DEVICE, ROOT_CA, SUB_CA, UNKNOWN), removed (boolean), validity (int64), rsa: { use (boolean), minLength (int32), lengths (int32[]) }, ecdsa: { use (boolean), minLength (int32), lengths (int32[]) }, 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[]) }, policies: { critical (boolean), values (string[]) }, subjectDN: [{ index (int32), name (string), description (string), required (boolean), validation (boolean), modifiable (boolean), defaultValue (string), regex (string), alert (string), code (enum: CN, UID, E, EMAILADDRESS, MAIL, SN, GIVENNAME, INITIALS, SURNAME, OU, O, L, ST, DC, C, UNSTRUCTUREDADDRESS, UNSTRUCTUREDNAME, POSTALCODE, BUSINESSCATEGORY, TELEPHONENUMBER, PSEUDONYM, POSTALADDRESS, STREET, NAME, T, DN, DESCRIPTION, INN, OGRN, OGRNIP, SNILS, INNLE, UNKNOWN) }], subjectAltName: [{ index (int32), 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), oid (string) }], updated (instant), created (instant), appendSubjectSId (boolean), publication (boolean) } |
Методы работы с Центрами сертификации
Заголовок раздела «Методы работы с Центрами сертификации»Метод получения активного Центра сертификации
Заголовок раздела «Метод получения активного Центра сертификации»| Параметр | Значение |
|---|---|
| Метод | GET API – Получение активного ЦС |
| Описание | Метод доступен администратору и оператору. Если активным является центр сертификации, у которого криптопровайдером алгоритма ГОСТ Р 34.10-2012 является Aladdin JCP, в ответе метода данный криптопровайдер будет указан как «UNKNOWN». В ответе данного метода в полях «subjectDN» и «issuerDN» компоненты «ROLE» (роль), «DATEOFBIRTH» (дата рождения) и «PLACEOFBIRTH» (место рождения) в случае их наличия в SDN запрашиваемого ЦС или издателя сертификата данного ЦС будут указаны как «UNKNOWN». Данные компоненты поддерживаются в публичном API начиная с версии v4. |
| URL | certificate-authority-service/api/v3/public/certificate-authorities/active |
| Swagger | https://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv3%5D%20Контроллер%3A%20Центры%20сертификации/active |
| Query | |
| Request | |
| Response | ResponseEntity -> { ItemResponse -> id (UUID), isActive (boolean), active (boolean), isManagement (boolean), management (boolean), certificate: { id (UUID), issuerId (UUID), issuerFingerprint (string), serialnumber (string), fingerprint (string), issuerDN: { (enum: CN, UID, E, EMAILADDRESS, MAIL, SN, GIVENNAME, INITIALS, SURNAME, OU, O, L, ST, DC, C, UNSTRUCTUREDADDRESS, UNSTRUCTUREDNAME, POSTALCODE, BUSINESSCATEGORY, TELEPHONENUMBER, PSEUDONYM, POSTALADDRESS, STREET, NAME, T, DN, DESCRIPTION, INN, OGRN, OGRNIP, SNILS, INNLE, UNKNOWN): string[] }, subjectDN: { (enum: CN, UID, E, EMAILADDRESS, MAIL, SN, GIVENNAME, INITIALS, SURNAME, OU, O, L, ST, DC, C, UNSTRUCTUREDADDRESS, UNSTRUCTUREDNAME, POSTALCODE, BUSINESSCATEGORY, TELEPHONENUMBER, PSEUDONYM, POSTALADDRESS, STREET, NAME, T, DN, DESCRIPTION, INN, OGRN, OGRNIP, SNILS, INNLE, UNKNOWN): string[] }, 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[] }, name (string), templateId (UUID), templateName (string), validFrom (instant), validTo (instant), status (enum: ACTIVE, HOLD, REVOKE, REQUEST, UNKNOWN), isValid (boolean), isExpired (boolean), actions: { p12 (boolean), csr (boolean), 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), created (instant) }, chain: { id (UUID), name (string), subjectDN: { (enum: CN, UID, E, EMAILADDRESS, MAIL, SN, GIVENNAME, INITIALS, SURNAME, OU, O, L, ST, DC, C, UNSTRUCTUREDADDRESS, UNSTRUCTUREDNAME, POSTALCODE, BUSINESSCATEGORY, TELEPHONENUMBER, PSEUDONYM, POSTALADDRESS, STREET, NAME, T, DN, DESCRIPTION, INN, OGRN, OGRNIP, SNILS, INNLE, UNKNOWN): string[] }, issuer: {…} }, certificateCount (int64), title (string), cryptographyProviders: { (enum: RSA, ECDSA, GOST_R_34_10_2012, UNKNOWN): { cryptographyProvider (enum: DEFAULT, CRYPTO_PRO, UNKNOWN), isAvailable (boolean), } }, primaryCryptographyProvider: { cryptographyProvider (enum: DEFAULT, CRYPTO_PRO, UNKNOWN), isAvailable (boolean), }, isAvailable (boolean), updated (instant), created (instant) } |
Метод получения Центра сертификации по идентификатору
Заголовок раздела «Метод получения Центра сертификации по идентификатору»| Параметр | Значение |
|---|---|
| Метод | GET API – Получение ЦС по идентификатору |
| Описание | Метод доступен администратору. Если с помощью данного метода будет запрошен центр сертификации, у которого криптопровайдером алгоритма ГОСТ Р 34.10-2012 является Aladdin JCP, в ответе метода данный криптопровайдер будет указан как «UNKNOWN». В ответе данного метода в полях «subjectDN» и «issuerDN» компоненты «ROLE» (роль), «DATEOFBIRTH» (дата рождения) и «PLACEOFBIRTH» (место рождения) в случае их наличия в SDN запрашиваемого ЦС или издателя сертификата данного ЦС будут указаны как «UNKNOWN». Данные компоненты поддерживаются в публичном API начиная с версии v4. |
| URL | certificate-authority-service/api/v3/public/certificate-authorities/{id} |
| Swagger | https://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv3%5D%20Контроллер%3A%20Центры%20сертификации/findById_14 |
| Query | { id (UUID) } |
| Request | |
| Response | ResponseEntity -> { ItemResponse -> id (UUID), isActive (boolean), active (boolean), isManagement (boolean), management (boolean), certificate: { id (UUID), issuerId (UUID), issuerFingerprint (string), serialnumber (string), fingerprint (string), issuerDN: { (enum: CN, UID, E, EMAILADDRESS, MAIL, SN, GIVENNAME, INITIALS, SURNAME, OU, O, L, ST, DC, C, UNSTRUCTUREDADDRESS, UNSTRUCTUREDNAME, POSTALCODE, BUSINESSCATEGORY, TELEPHONENUMBER, PSEUDONYM, POSTALADDRESS, STREET, NAME, T, DN, DESCRIPTION, INN, OGRN, OGRNIP, SNILS, INNLE, UNKNOWN): string[] }, subjectDN: { (enum: CN, UID, E, EMAILADDRESS, MAIL, SN, GIVENNAME, INITIALS, SURNAME, OU, O, L, ST, DC, C, UNSTRUCTUREDADDRESS, UNSTRUCTUREDNAME, POSTALCODE, BUSINESSCATEGORY, TELEPHONENUMBER, PSEUDONYM, POSTALADDRESS, STREET, NAME, T, DN, DESCRIPTION, INN, OGRN, OGRNIP, SNILS, INNLE, UNKNOWN): string[] }, 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[] }, name (string), templateId (UUID), templateName (string), validFrom (instant), validTo (instant), status (enum: ACTIVE, HOLD, REVOKE, REQUEST, UNKNOWN), isValid (boolean), isExpired (boolean), actions: { p12 (boolean), csr (boolean), 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), created (instant) }, chain: { id (UUID), name (string), subjectDN: { (enum: CN, UID, E, EMAILADDRESS, MAIL, SN, GIVENNAME, INITIALS, SURNAME, OU, O, L, ST, DC, C, UNSTRUCTUREDADDRESS, UNSTRUCTUREDNAME, POSTALCODE, BUSINESSCATEGORY, TELEPHONENUMBER, PSEUDONYM, POSTALADDRESS, STREET, NAME, T, DN, DESCRIPTION, INN, OGRN, OGRNIP, SNILS, INNLE, UNKNOWN): string[] }, issuer: {…} }, certificateCount (int64), title (string), cryptographyProviders: { (enum: RSA, ECDSA, GOST_R_34_10_2012, UNKNOWN): { cryptographyProvider (enum: DEFAULT, CRYPTO_PRO, UNKNOWN), isAvailable (boolean), } }, primaryCryptographyProvider: { cryptographyProvider (enum: DEFAULT, CRYPTO_PRO, UNKNOWN), isAvailable (boolean), }, isAvailable (boolean), updated (instant), created (instant) } |
Метод получения Центров сертификации
Заголовок раздела «Метод получения Центров сертификации»| Параметр | Значение |
|---|---|
| Метод | GET API – Получение ЦС |
| Описание | Метод доступен администратору Для центров сертификации, у которых криптопровайдером алгоритма ГОСТ Р 34.10-2012 является Aladdin JCP, в ответе метода данный криптопровайдер будет указан как «UNKNOWN». В ответе данного метода в полях «subjectDN» и «issuerDN» компоненты «ROLE» (роль), «DATEOFBIRTH» (дата рождения) и «PLACEOFBIRTH» (место рождения) в случае их наличия в SDN запрашиваемого ЦС или издателя сертификата данного ЦС будут указаны как «UNKNOWN». Данные компоненты поддерживаются в публичном API начиная с версии v4. |
| URL | certificate-authority-service/api/v3/public/certificate-authorities |
| Swagger | https://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv3%5D%20Контроллер%3A%20Центры%20сертификации/findAll_15 |
| Query | { status (enum[]:ACTIVE, HOLD, REVOKE, REQUEST, UNKNOWN) [опционально], type (enum[]: CERTIFICATE, ROOT_CA, SUB_CA, UNKNOWN) [опционально], search (string) [опционально], isManagement (boolean) [опционально], isActive (boolean) [опционально], isValid (boolean) [опционально], isExpired (boolean) [опционально], Id (UUID[])[опционально], notIds (UUID[])[опционально], sortDirection (string) [опционально], endEntityType (enum[]: ROOT_CA, SUB_CA, USER, DEVICE, UNKNOWN) [опционально], sortBy (string[])[опционально], pageOffset (integer) [опционально], pageLimit (integer) [опционально] } |
| Request | |
| Response | ResponseEntity -> { CollectionResponse -> id (UUID), isActive (boolean), active (boolean), isManagement (boolean), management (boolean), certificate: { id (UUID), issuerId (UUID), issuerFingerprint (string), serialnumber (string), fingerprint (string), issuerDN: { (enum: CN, UID, E, EMAILADDRESS, MAIL, SN, GIVENNAME, INITIALS, SURNAME, OU, O, L, ST, DC, C, UNSTRUCTUREDADDRESS, UNSTRUCTUREDNAME, POSTALCODE, BUSINESSCATEGORY, TELEPHONENUMBER, PSEUDONYM, POSTALADDRESS, STREET, NAME, T, DN, DESCRIPTION, INN, OGRN, OGRNIP, SNILS, INNLE, UNKNOWN): string[] }, subjectDN: { (enum: CN, UID, E, EMAILADDRESS, MAIL, SN, GIVENNAME, INITIALS, SURNAME, OU, O, L, ST, DC, C, UNSTRUCTUREDADDRESS, UNSTRUCTUREDNAME, POSTALCODE, BUSINESSCATEGORY, TELEPHONENUMBER, PSEUDONYM, POSTALADDRESS, STREET, NAME, T, DN, DESCRIPTION, INN, OGRN, OGRNIP, SNILS, INNLE, UNKNOWN): string[] }, 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[] }, name (string), templateId (UUID), templateName (string), validFrom (instant), validTo (instant), status (enum: ACTIVE, HOLD, REVOKE, REQUEST, UNKNOWN), isValid (boolean), isExpired (boolean), actions: { p12 (boolean), csr (boolean), 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), created (instant) }, chain: { id (UUID), name (string), subjectDN: { (enum: CN, UID, E, EMAILADDRESS, MAIL, SN, GIVENNAME, INITIALS, SURNAME, OU, O, L, ST, DC, C, UNSTRUCTUREDADDRESS, UNSTRUCTUREDNAME, POSTALCODE, BUSINESSCATEGORY, TELEPHONENUMBER, PSEUDONYM, POSTALADDRESS, STREET, NAME, T, DN, DESCRIPTION, INN, OGRN, OGRNIP, SNILS, INNLE, UNKNOWN): string[] }, issuer: {…} }, certificateCount (int64), title (string), cryptographyProviders: { (enum: RSA, ECDSA, GOST_R_34_10_2012, UNKNOWN): { cryptographyProvider (enum: DEFAULT, CRYPTO_PRO, UNKNOWN), isAvailable (boolean), } }, primaryCryptographyProvider: { cryptographyProvider (enum: DEFAULT, CRYPTO_PRO, UNKNOWN), isAvailable (boolean), }, isAvailable (boolean), updated (instant), created (instant) } |
Методы работы с сертификатами
Заголовок раздела «Методы работы с сертификатами»Метод выпуска сертификата в контейнере pkcs#12
Заголовок раздела «Метод выпуска сертификата в контейнере pkcs#12»| Параметр | Значение |
|---|---|
| Метод | POST API – Выпуск сертификата в контейнере pkcs#12 |
| Описание | Метод доступен: администратору; оператору при наличии полномочий на управление сертификатами субъектов и использование шаблона, идентификаторы которых передаются во входных параметрах. Использование данного метода оператором для создания сертификатов для учетных записей запрещено. В используемом шаблоне должна быть включена опция «Выпуск сертификатов с закрытым ключом (PKCS#12)», иначе метод вернет сообщение об ошибке с кодом 400 и текстом «Выпуск сертификатов с закрытым ключом (PKCS#12) недоступен по данному шаблону». Указываемый во входных параметрах пароль от контейнера должен соответствовать требованиям регулярного выражения по шаблону, иначе метод вернет сообщение об ошибке с кодом 400 и текстом «Пароль не соответствует регулярному выражению, указанному в шаблоне». |
| URL | certificate-authority-service/api/v3/public/certificates/enroll/{caId} |
| Swagger | https://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv3%5D%20Контроллер%3A%20сертификаты/enrollByCaId |
| Query | { caId (UUID), subjectId (UUID) [обязателен, если не указан userId], userId (UUID) [обязателен, если не указан subjectId] } |
| 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, 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[] }, keyBits (integer), keyAlgorithm (enum: RSA, ECDSA, GOST_R_34_10_2012, UNKNOWN), password (string) } |
| Response | ResponseEntity -> { ItemResponse -> id (UUID), downloadActions: { p12 (boolean), csr (boolean), pem (boolean) }, fingerprint (string), serialNumber (string), templateId (UUID), templateName (string), name (string), issuerDN: { (enum: CN, UID, E, EMAILADDRESS, MAIL, SN, GIVENNAME, INITIALS, SURNAME, OU, O, L, ST, DC, C, UNSTRUCTUREDADDRESS, UNSTRUCTUREDNAME, POSTALCODE, BUSINESSCATEGORY, TELEPHONENUMBER, PSEUDONYM, POSTALADDRESS, STREET, NAME, T, DN, DESCRIPTION, INN, OGRN, OGRNIP, SNILS, INNLE, UNKNOWN): string[] }, subjectDN: { (enum: CN, UID, E, EMAILADDRESS, MAIL, SN, GIVENNAME, INITIALS, SURNAME, OU, O, L, ST, DC, C, UNSTRUCTUREDADDRESS, UNSTRUCTUREDNAME, POSTALCODE, BUSINESSCATEGORY, TELEPHONENUMBER, PSEUDONYM, POSTALADDRESS, STREET, NAME, T, DN, DESCRIPTION, INN, OGRN, OGRNIP, SNILS, INNLE, UNKNOWN): string[] }, 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[] }, validFrom (instant), validTo (instant) } |
Методы выпуска сертификата по запросу pkcs#10
Заголовок раздела «Методы выпуска сертификата по запросу pkcs#10»Выпуск сертификата по запросу pkcs#10 (формат запроса на сертификат из входных параметров – multipart/form-data)
Заголовок раздела «Выпуск сертификата по запросу pkcs#10 (формат запроса на сертификат из входных параметров – multipart/form-data)»| Параметр | Значение |
|---|---|
| Метод | POST API – Выпуск сертификата по запросу pkcs#10 (multipart/form-data) |
| Описание | Метод доступен: администратору; оператору при наличии полномочий на управление сертификатами субъектов и использование шаблона, идентификаторы которых передаются во входных параметрах. Использование данного метода оператором для создания сертификатов для учетных записей запрещено. |
| URL | certificate-authority-service/api/v3/public/certificates/enroll/{caId}/pkcs10 |
| Swagger | https://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv3%5D%20Контроллер%3A%20сертификаты/enrollRequestByCaId_1 |
| Query | { caId (UUID), subjectId (UUID) [обязателен, если не указан userId], userId (UUID) [обязателен, если не указан subjectId] } |
| Request | { templateId (UUID), request (binary), subjectName: { (enum: CN, UID, E, EMAILADDRESS, MAIL, SN, GIVENNAME, INITIALS, SURNAME, OU, O, L, ST, DC, C, UNSTRUCTUREDADDRESS, UNSTRUCTUREDNAME, POSTALCODE, BUSINESSCATEGORY, TELEPHONENUMBER, PSEUDONYM, POSTALADDRESS, STREET, NAME, T, DN, DESCRIPTION, INN, OGRN, OGRNIP, SNILS, INNLE, UNKNOWN): string[] },[опционально] subjectAltName: { (enum: RFC822NAME, DNS_NAME, IPADDRESS, DIRECTORY_NAME, UNIFORM_RESOURCE_ID, REGISTERED_ID, MS_UPN, MS_GUID, KRB5PRINCIPAL, PERMANENT_IDENTIFIER, XMPP_ADDR, SRV_NAME, SUBJECT_IDENTIFICATION_METHOD, UNKNOWN): string[] } [опционально] } |
| Response | ResponseEntity -> { ItemResponse -> id (UUID), downloadActions: { p12 (boolean), csr (boolean), pem (boolean) }, fingerprint (string), serialNumber (string), templateId (UUID), templateName (string), name (string), issuerDN: { (enum: CN, UID, E, EMAILADDRESS, MAIL, SN, GIVENNAME, INITIALS, SURNAME, OU, O, L, ST, DC, C, UNSTRUCTUREDADDRESS, UNSTRUCTUREDNAME, POSTALCODE, BUSINESSCATEGORY, TELEPHONENUMBER, PSEUDONYM, POSTALADDRESS, STREET, NAME, T, DN, DESCRIPTION, INN, OGRN, OGRNIP, SNILS, INNLE, UNKNOWN): string[] }, subjectDN: { (enum: CN, UID, E, EMAILADDRESS, MAIL, SN, GIVENNAME, INITIALS, SURNAME, OU, O, L, ST, DC, C, UNSTRUCTUREDADDRESS, UNSTRUCTUREDNAME, POSTALCODE, BUSINESSCATEGORY, TELEPHONENUMBER, PSEUDONYM, POSTALADDRESS, STREET, NAME, T, DN, DESCRIPTION, INN, OGRN, OGRNIP, SNILS, INNLE, UNKNOWN): string[] }, 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[] }, validFrom (instant), validTo (instant) } |
Выпуск сертификата по запросу pkcs#10 (формат запроса на сертификат из входных параметров – application/json)
Заголовок раздела «Выпуск сертификата по запросу pkcs#10 (формат запроса на сертификат из входных параметров – application/json)»| Параметр | Значение |
|---|---|
| Метод | POST API – Выпуск сертификата по запросу pkcs#10 (application/json) |
| Описание | Метод доступен: администратору; оператору при наличии полномочий на управление сертификатами субъектов и использование шаблона, идентификаторы которых передаются во входных параметрах. Использование данного метода оператором для создания сертификатов для учетных записей запрещено. |
| URL | certificate-authority-service/api/v3/public/certificates/enroll/{caId}/pkcs10 |
| Swagger | https://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv3%5D%20Контроллер%3A%20сертификаты/enrollRequestByCaId_1 |
| Query | { caId (UUID), subjectId (UUID) [обязателен, если не указан userId], userId (UUID) [обязателен, если не указан subjectId] } |
| Request | { templateId (UUID), request: { contentType(string) [опционально], fileName (string) [опционально], data (string:binary) }, subjectName: { (enum: CN, UID, E, EMAILADDRESS, MAIL, SN, GIVENNAME, INITIALS, SURNAME, OU, O, L, ST, DC, C, UNSTRUCTUREDADDRESS, UNSTRUCTUREDNAME, POSTALCODE, BUSINESSCATEGORY, TELEPHONENUMBER, PSEUDONYM, POSTALADDRESS, STREET, NAME, T, DN, DESCRIPTION, INN, OGRN, OGRNIP, SNILS, INNLE, UNKNOWN): string[] },[опционально] subjectAltName: { (enum: RFC822NAME, DNS_NAME, IPADDRESS, DIRECTORY_NAME, UNIFORM_RESOURCE_ID, REGISTERED_ID, MS_UPN, MS_GUID, KRB5PRINCIPAL, PERMANENT_IDENTIFIER, XMPP_ADDR, SRV_NAME, SUBJECT_IDENTIFICATION_METHOD, UNKNOWN): string[] } [опционально] } |
| Response | ResponseEntity -> { ItemResponse -> id (UUID), downloadActions: { p12 (boolean), csr (boolean), pem (boolean) }, fingerprint (string), serialNumber (string), templateId (UUID), templateName (string), name (string), issuerDN: { (enum: CN, UID, E, EMAILADDRESS, MAIL, SN, GIVENNAME, INITIALS, SURNAME, OU, O, L, ST, DC, C, UNSTRUCTUREDADDRESS, UNSTRUCTUREDNAME, POSTALCODE, BUSINESSCATEGORY, TELEPHONENUMBER, PSEUDONYM, POSTALADDRESS, STREET, NAME, T, DN, DESCRIPTION, INN, OGRN, OGRNIP, SNILS, INNLE, UNKNOWN): string[] }, subjectDN: { (enum: CN, UID, E, EMAILADDRESS, MAIL, SN, GIVENNAME, INITIALS, SURNAME, OU, O, L, ST, DC, C, UNSTRUCTUREDADDRESS, UNSTRUCTUREDNAME, POSTALCODE, BUSINESSCATEGORY, TELEPHONENUMBER, PSEUDONYM, POSTALADDRESS, STREET, NAME, T, DN, DESCRIPTION, INN, OGRN, OGRNIP, SNILS, INNLE, UNKNOWN): string[] }, 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[] }, validFrom (instant), validTo (instant) } |
Примечание: отличается от метода выше форматом передаваемого во входных параметрах запроса на сертификат. В данном методе на вход поступает содержимое файла запроса на сертификат в формате PEM (содержимое в Base64).
Методы перевыпуска сертификата по запросу pkcs#10
Заголовок раздела «Методы перевыпуска сертификата по запросу pkcs#10»Перевыпуск сертификата по запросу pkcs#10 (формат запроса на сертификат из входных параметров – multipart/form-data)
Заголовок раздела «Перевыпуск сертификата по запросу pkcs#10 (формат запроса на сертификат из входных параметров – multipart/form-data)»| Параметр | Значение |
|---|---|
| Метод | POST API – Перевыпуск сертификата по запросу pkcs#10 (multipart/form-data) |
| Описание | Метод доступен: администратору; оператору при наличии полномочий на управление сертификатами субъектов и использование шаблона, идентификаторы которых передаются во входных параметрах. Использование данного метода оператором для создания сертификатов для учетных записей запрещено. Метод позволяет перевыпустить сертификат по запросу, по которому ранее уже был выпущен сертификат. При использовании метода проверяется наличие в базе данных программы выпущенного сертификата, имеющего «Subject Key Identifier» аналогичный указанному в запросе на сертификат из входных параметров. Если такой сертификат не будет найден, данный метод осуществит выпуск нового сертификата по запросу аналогично методу выпуска сертификата по запросу (см. раздел 5.2). Если сертификат с аналогичным указанному в запросе на сертификат «Subject Key Identifier» будет найден, программа: 1) проверит статус найденного сертификата. Если срок действия данного сертификата истек, запрос пользователя будет отклонен. 2) проверит соответствие значений в полях SDN и SAN, указанных в запросе (или во входных параметрах метода), значениям в полях SDN и SAN в найденном сертификате. При соответствии значений будет осуществлен выпуск сертификата по запросу на сертификат из входных параметров метода, иначе запрос пользователя будет отклонен. |
| URL | certificate-authority-service/api/v3/public/certificates/renewal/{caId}/pkcs10 |
| Swagger | https://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv3%5D%20Контроллер%3A%20сертификаты/renewalRequestByCaId_1 |
| Query | { caId (UUID), subjectId (UUID) [обязателен, если не указан userId], userId (UUID) [обязателен, если не указан subjectId] } |
| Request | { templateId (UUID), request (binary), subjectName: { (enum: CN, UID, E, EMAILADDRESS, MAIL, SN, GIVENNAME, INITIALS, SURNAME, OU, O, L, ST, DC, C, UNSTRUCTUREDADDRESS, UNSTRUCTUREDNAME, POSTALCODE, BUSINESSCATEGORY, TELEPHONENUMBER, PSEUDONYM, POSTALADDRESS, STREET, NAME, T, DN, DESCRIPTION, INN, OGRN, OGRNIP, SNILS, INNLE, UNKNOWN): string[] },[опционально] subjectAltName: { (enum: RFC822NAME, DNS_NAME, IPADDRESS, DIRECTORY_NAME, UNIFORM_RESOURCE_ID, REGISTERED_ID, MS_UPN, MS_GUID, KRB5PRINCIPAL, PERMANENT_IDENTIFIER, XMPP_ADDR, SRV_NAME, SUBJECT_IDENTIFICATION_METHOD, UNKNOWN): string[] } [опционально] } |
| Response | ResponseEntity -> { ItemResponse -> id (UUID), downloadActions: { p12 (boolean), csr (boolean), pem (boolean) }, fingerprint (string), serialNumber (string), templateId (UUID), templateName (string), name (string), issuerDN: { (enum: CN, UID, E, EMAILADDRESS, MAIL, SN, GIVENNAME, INITIALS, SURNAME, OU, O, L, ST, DC, C, UNSTRUCTUREDADDRESS, UNSTRUCTUREDNAME, POSTALCODE, BUSINESSCATEGORY, TELEPHONENUMBER, PSEUDONYM, POSTALADDRESS, STREET, NAME, T, DN, DESCRIPTION, INN, OGRN, OGRNIP, SNILS, INNLE, UNKNOWN): string[] }, subjectDN: { (enum: CN, UID, E, EMAILADDRESS, MAIL, SN, GIVENNAME, INITIALS, SURNAME, OU, O, L, ST, DC, C, UNSTRUCTUREDADDRESS, UNSTRUCTUREDNAME, POSTALCODE, BUSINESSCATEGORY, TELEPHONENUMBER, PSEUDONYM, POSTALADDRESS, STREET, NAME, T, DN, DESCRIPTION, INN, OGRN, OGRNIP, SNILS, INNLE, UNKNOWN): string[] }, 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[] }, validFrom (instant), validTo (instant) } |
Перевыпуск сертификата по запросу pkcs#10 (формат запроса на сертификат из входных параметров – application/json)
Заголовок раздела «Перевыпуск сертификата по запросу pkcs#10 (формат запроса на сертификат из входных параметров – application/json)»| Параметр | Значение |
|---|---|
| Метод | POST API – Перевыпуск сертификата по запросу pkcs#10 (application/json) |
| Описание | Метод доступен: администратору; оператору при наличии полномочий на управление сертификатами субъектов и использование шаблона, идентификаторы которых передаются во входных параметрах. Использование данного метода оператором для создания сертификатов для учетных записей запрещено. Метод позволяет перевыпустить сертификат по запросу, по которому ранее уже был выпущен сертификат. При использовании метода проверяется наличие в базе данных программы выпущенного сертификата, имеющего «Subject Key Identifier» аналогичный указанному в запросе на сертификат из входных параметров. Если такой сертификат не будет найден, данный метод осуществит выпуск нового сертификата по запросу аналогично методу выпуска сертификата по запросу. Если сертификат с аналогичным указанному в запросе на сертификат «Subject Key Identifier» будет найден, программа: 1) проверит статус найденного сертификата. Если срок действия данного сертификата истек, запрос пользователя будет отклонен. 2) проверит соответствие значений в полях SDN и SAN, указанных в запросе (или во входных параметрах метода), значениям в полях SDN и SAN в найденном сертификате. При соответствии значений будет осуществлен выпуск сертификата по запросу на сертификат из входных параметров метода, иначе запрос пользователя будет отклонен. |
| URL | certificate-authority-service/api/v3/public/certificates/renewal/{caId}/pkcs10 |
| Swagger | https://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv3%5D%20Контроллер%3A%20сертификаты/renewalRequestByCaId_1 |
| Query | { caId (UUID), subjectId (UUID) [обязателен, если не указан userId], userId (UUID) [обязателен, если не указан subjectId] } |
| Request | { templateId (UUID), request: { contentType(string) [опционально], fileName (string) [опционально], data (string:binary) }, subjectName: { (enum: CN, UID, E, EMAILADDRESS, MAIL, SN, GIVENNAME, INITIALS, SURNAME, OU, O, L, ST, DC, C, UNSTRUCTUREDADDRESS, UNSTRUCTUREDNAME, POSTALCODE, BUSINESSCATEGORY, TELEPHONENUMBER, PSEUDONYM, POSTALADDRESS, STREET, NAME, T, DN, DESCRIPTION, INN, OGRN, OGRNIP, SNILS, INNLE, UNKNOWN): string[] },[опционально] subjectAltName: { (enum: RFC822NAME, DNS_NAME, IPADDRESS, DIRECTORY_NAME, UNIFORM_RESOURCE_ID, REGISTERED_ID, MS_UPN, MS_GUID, KRB5PRINCIPAL, PERMANENT_IDENTIFIER, XMPP_ADDR, SRV_NAME, SUBJECT_IDENTIFICATION_METHOD, UNKNOWN): string[] } [опционально] } |
| Response | ResponseEntity -> { ItemResponse -> id (UUID), downloadActions: { p12 (boolean), csr (boolean), pem (boolean) }, fingerprint (string), serialNumber (string), templateId (UUID), templateName (string), name (string), issuerDN: { (enum: CN, UID, E, EMAILADDRESS, MAIL, SN, GIVENNAME, INITIALS, SURNAME, OU, O, L, ST, DC, C, UNSTRUCTUREDADDRESS, UNSTRUCTUREDNAME, POSTALCODE, BUSINESSCATEGORY, TELEPHONENUMBER, PSEUDONYM, POSTALADDRESS, STREET, NAME, T, DN, DESCRIPTION, INN, OGRN, OGRNIP, SNILS, INNLE, UNKNOWN): string[] }, subjectDN: { (enum: CN, UID, E, EMAILADDRESS, MAIL, SN, GIVENNAME, INITIALS, SURNAME, OU, O, L, ST, DC, C, UNSTRUCTUREDADDRESS, UNSTRUCTUREDNAME, POSTALCODE, BUSINESSCATEGORY, TELEPHONENUMBER, PSEUDONYM, POSTALADDRESS, STREET, NAME, T, DN, DESCRIPTION, INN, OGRN, OGRNIP, SNILS, INNLE, UNKNOWN): string[] }, 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[] }, validFrom (instant), validTo (instant) } |
Примечание: отличается от метода выше форматом передаваемого во входных параметрах запроса на сертификат. В данном методе на вход поступает содержимое файла запроса на сертификат в формате PEM (содержимое в Base64).
Методы валидации запроса pkcs#10
Заголовок раздела «Методы валидации запроса pkcs#10»Метод валидации запроса pkcs#10 (формат запроса на сертификат из входных параметров – multipart/form-data)
Заголовок раздела «Метод валидации запроса pkcs#10 (формат запроса на сертификат из входных параметров – multipart/form-data)»| Параметр | Значение |
|---|---|
| Метод | POST API – Валидация запроса pkcs#10 (multipart/form-data) |
| Описание | Метод доступен: администратору; оператору при наличии полномочий на управление сертификатами субъектов и использование шаблона, идентификаторы которых передаются во входных параметрах. Использование данного метода оператором для валидации запросов на сертификат для учетных записей запрещено. |
| URL | certificate-authority-service/api/v3/public/certificates/validate/{caId}/pkcs10 |
| Swagger | https://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv3%5D%20Контроллер%3A%20сертификаты/validate_1 |
| Query | { caId (UUID) subjectId (UUID) [обязателен, если не указан accountId], accountId (UUID) [обязателен, если не указан subjectId] } |
| Request | { templateId (UUID), request (binary), subjectName: { (enum: CN, UID, E, EMAILADDRESS, MAIL, SN, GIVENNAME, INITIALS, SURNAME, OU, O, L, ST, DC, C, UNSTRUCTUREDADDRESS, UNSTRUCTUREDNAME, POSTALCODE, BUSINESSCATEGORY, TELEPHONENUMBER, PSEUDONYM, POSTALADDRESS, STREET, NAME, T, DN, DESCRIPTION, INN, OGRN, OGRNIP, SNILS, INNLE, UNKNOWN): string[] },[опционально] subjectAltName: { (enum: RFC822NAME, DNS_NAME, IPADDRESS, DIRECTORY_NAME, UNIFORM_RESOURCE_ID, REGISTERED_ID, MS_UPN, MS_GUID, KRB5PRINCIPAL, PERMANENT_IDENTIFIER, XMPP_ADDR, SRV_NAME, SUBJECT_IDENTIFICATION_METHOD, UNKNOWN): string[] } [опционально] } |
| Response | ResponseEntity -> { ItemResponse -> name (string), templateId (UUID), templateName (string), subjectId (UUID) valid (boolean), subjectNames: [{ fieldName (enum: CN, UID, E, EMAILADDRESS, MAIL, SN, GIVENNAME, INITIALS, SURNAME, OU, O, L, ST, DC, C, UNSTRUCTUREDADDRESS, UNSTRUCTUREDNAME, POSTALCODE, BUSINESSCATEGORY, TELEPHONENUMBER, PSEUDONYM, POSTALADDRESS, STREET, NAME, T, DN, DESCRIPTION, INN, OGRN, OGRNIP, SNILS, INNLE, UNKNOWN), fieldValue (string), required (boolean), additional (boolean), valid (boolean), message (string) }], subjectAltNames: [{ fieldName (enum: RFC822NAME, DNS_NAME, IPADDRESS, DIRECTORY_NAME, UNIFORM_RESOURCE_ID, REGISTERED_ID, MS_UPN, MS_GUID, KRB5PRINCIPAL, PERMANENT_IDENTIFIER, XMPP_ADDR, SRV_NAME, SUBJECT_IDENTIFICATION_METHOD, UNKNOWN), fieldValue (string), required (boolean), additional (boolean), valid (boolean), message (string) }] } |
Метод валидации запроса pkcs#10 (формат запроса на сертификат из входных параметров – application/json)
Заголовок раздела «Метод валидации запроса pkcs#10 (формат запроса на сертификат из входных параметров – application/json)»| Параметр | Значение |
|---|---|
| Метод | POST API – Валидация запроса pkcs#10 (application/json) |
| Описание | Метод доступен: администратору; оператору при наличии полномочий на управление сертификатами субъектов и использование шаблона, идентификаторы которых передаются во входных параметрах. Использование данного метода оператором для валидации запросов на сертификат для учетных записей запрещено. |
| URL | certificate-authority-service/api/v3/public/certificates/validate/{caId}/pkcs10 |
| Swagger | https://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv3%5D%20Контроллер%3A%20сертификаты/validate_1 |
| Query | { caId (UUID) subjectId (UUID) [обязателен, если не указан accountId], accountId (UUID) [обязателен, если не указан subjectId] } |
| Request | { templateId (UUID), request: { contentType (string), fileName (string), data (string:binary) }, subjectName: { (enum: CN, UID, E, EMAILADDRESS, MAIL, SN, GIVENNAME, INITIALS, SURNAME, OU, O, L, ST, DC, C, UNSTRUCTUREDADDRESS, UNSTRUCTUREDNAME, POSTALCODE, BUSINESSCATEGORY, TELEPHONENUMBER, PSEUDONYM, POSTALADDRESS, STREET, NAME, T, DN, DESCRIPTION, INN, OGRN, OGRNIP, SNILS, INNLE, UNKNOWN): string[] },[опционально] subjectAltName: { (enum: RFC822NAME, DNS_NAME, IPADDRESS, DIRECTORY_NAME, UNIFORM_RESOURCE_ID, REGISTERED_ID, MS_UPN, MS_GUID, KRB5PRINCIPAL, PERMANENT_IDENTIFIER, XMPP_ADDR, SRV_NAME, SUBJECT_IDENTIFICATION_METHOD, UNKNOWN): string[] } [опционально] } |
| Response | ResponseEntity -> { ItemResponse -> name (string), templateId (UUID), templateName (string), subjectId (UUID) valid (boolean), subjectNames: [{ fieldName (enum: CN, UID, E, EMAILADDRESS, MAIL, SN, GIVENNAME, INITIALS, SURNAME, OU, O, L, ST, DC, C, UNSTRUCTUREDADDRESS, UNSTRUCTUREDNAME, POSTALCODE, BUSINESSCATEGORY, TELEPHONENUMBER, PSEUDONYM, POSTALADDRESS, STREET, NAME, T, DN, DESCRIPTION, INN, OGRN, OGRNIP, SNILS, INNLE, UNKNOWN), fieldValue (string), required (boolean), additional (boolean), valid (boolean), message (string) }], subjectAltNames: [{ fieldName (enum: RFC822NAME, DNS_NAME, IPADDRESS, DIRECTORY_NAME, UNIFORM_RESOURCE_ID, REGISTERED_ID, MS_UPN, MS_GUID, KRB5PRINCIPAL, PERMANENT_IDENTIFIER, XMPP_ADDR, SRV_NAME, SUBJECT_IDENTIFICATION_METHOD, UNKNOWN), fieldValue (string), required (boolean), additional (boolean), valid (boolean), message (string) }] } |
Примечание: отличается от метода выше форматом передаваемого во входных параметрах запроса на сертификат. В данном методе на вход поступает содержимое файла запроса на сертификат в формате PEM (содержимое в Base64).
Метод поиска сертификатов
Заголовок раздела «Метод поиска сертификатов»| Параметр | Значение |
|---|---|
| Метод | GET API – Поиск сертификатов |
| Описание | Метод доступен администратору и оператору. В ответе для оператора содержатся только сертификаты субъектов, к которым ему предоставлен доступ. В ответе данного метода в полях «subjectDN» и «issuerDN» компоненты «ROLE» (роль), «DATEOFBIRTH» (дата рождения) и «PLACEOFBIRTH» (место рождения) в случае их наличия в сертификате будут указаны как «UNKNOWN». Данные компоненты поддерживаются в публичном API начиная с версии v4. |
| URL | certificate-authority-service/api/v3/public/certificates |
| Swagger | https://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv3%5D%20Контроллер%3A%20сертификаты/findAll_14 |
| Query | { search (string) [опционально], issuerId (UUID) [опционально], templateId (UUID) [опционально], 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) [опционально], hasCA (boolean) [опционально], isManagementCA (boolean) [опционально], isValid (boolean) [опционально], isExpired (boolean) [опционально], validFromFrom (instant) [опционально], validFromTo (instant) [опционально], validToFrom (instant) [опционально], validToTo (instant) [опционально], updatedFrom (instant) [опционально], updatedTo (instant) [опционально], subjectId (UUID[])[опционально], userId (UUID[])[опционально], serialnumber (string[])[опционально], fingerprint (string[])[опционально], subjectKeyIdentifier (string[])[опционально], notId (UUID[])[опционально], endEntityType(string[])(enum[]:ROOT_CA, SUB_CA, USER, DEVICE, UNKNOWN) [опционально], sortDirection (string) [опционально], sortBy (string[])[опционально], pageOffset (integer) [опционально], pageLimit (integer) [опционально] } |
| Request | |
| Response | ResponseEntity -> { CollectionResponse -> id (UUID), issuerId (UUID), issuerFingerprint (string), serialnumber (string), fingerprint (string), issuerDN: { (enum: CN, UID, E, EMAILADDRESS, MAIL, SN, GIVENNAME, INITIALS, SURNAME, OU, O, L, ST, DC, C, UNSTRUCTUREDADDRESS, UNSTRUCTUREDNAME, POSTALCODE, BUSINESSCATEGORY, TELEPHONENUMBER, PSEUDONYM, POSTALADDRESS, STREET, NAME, T, DN, DESCRIPTION, INN, OGRN, OGRNIP, SNILS, INNLE, UNKNOWN): string[] }, subjectDN: { (enum: CN, UID, E, EMAILADDRESS, MAIL, SN, GIVENNAME, INITIALS, SURNAME, OU, O, L, ST, DC, C, UNSTRUCTUREDADDRESS, UNSTRUCTUREDNAME, POSTALCODE, BUSINESSCATEGORY, TELEPHONENUMBER, PSEUDONYM, POSTALADDRESS, STREET, NAME, T, DN, DESCRIPTION, INN, OGRN, OGRNIP, SNILS, INNLE, UNKNOWN): string[] }, 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[] }, name (string), templateId (UUID), templateName (string), validFrom (instant), validTo (instant), status (enum: ACTIVE, HOLD, REVOKE, REQUEST, UNKNOWN), isValid (boolean), isExpired (boolean), actions: { p12(boolean), csr(boolean), 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), created (instant) } |
Метод получения сертификата по идентификатору
Заголовок раздела «Метод получения сертификата по идентификатору»| Параметр | Значение |
|---|---|
| Метод | GET API – Получение сертификата по идентификатору |
| Описание | Метод доступен администратору и оператору при наличии полномочий на управление сертификатом, идентификатор которого передается во входных параметрах. В ответе данного метода в полях «subjectDN» и «issuerDN» компоненты «ROLE» (роль), «DATEOFBIRTH» (дата рождения) и «PLACEOFBIRTH» (место рождения) в случае их наличия в сертификате будут указаны как «UNKNOWN». Данные компоненты поддерживаются в публичном API начиная с версии v4. |
| URL | certificate-authority-service/api/v3/public/certificates/{id} |
| Swagger | https://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv3%5D%20Контроллер%3A%20сертификаты/findById_13 |
| Query | { id (UUID) } |
| Request | |
| Response | ResponseEntity -> { CollectionResponse -> id (UUID), chain: { id (UUID), name (string), subjectDN: { (enum: CN, UID, E, EMAILADDRESS, MAIL, SN, GIVENNAME, INITIALS, SURNAME, OU, O, L, ST, DC, C, UNSTRUCTUREDADDRESS, UNSTRUCTUREDNAME, POSTALCODE, BUSINESSCATEGORY, TELEPHONENUMBER, PSEUDONYM, POSTALADDRESS, STREET, NAME, T, DN, DESCRIPTION, INN, OGRN, OGRNIP, SNILS, INNLE, UNKNOWN): string[] }, issuer: {…} }, serialnumber (string), fingerprint (string), name (string), issuerId (UUID), issuerDN: { (enum: CN, UID, E, EMAILADDRESS, MAIL, SN, GIVENNAME, INITIALS, SURNAME, OU, O, L, ST, DC, C, UNSTRUCTUREDADDRESS, UNSTRUCTUREDNAME, POSTALCODE, BUSINESSCATEGORY, TELEPHONENUMBER, PSEUDONYM, POSTALADDRESS, STREET, NAME, T, DN, DESCRIPTION, INN, OGRN, OGRNIP, SNILS, INNLE, UNKNOWN): string[] }, subjectDN: { (enum: CN, UID, E, EMAILADDRESS, MAIL, SN, GIVENNAME, INITIALS, SURNAME, OU, O, L, ST, DC, C, UNSTRUCTUREDADDRESS, UNSTRUCTUREDNAME, POSTALCODE, BUSINESSCATEGORY, TELEPHONENUMBER, PSEUDONYM, POSTALADDRESS, STREET, NAME, T, DN, DESCRIPTION, INN, OGRN, OGRNIP, SNILS, INNLE, UNKNOWN): string[] }, 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[] }, 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), validTo (instant), status (enum: ACTIVE, HOLD, REVOKE, REQUEST, UNKNOWN), isValid (boolean), isExpired (boolean), actions: { p12 (boolean), csr (boolean), pem (boolean) }, publicKey (string), certificateType (string), 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), description (string), updated (instant), created (instant), default (boolean) }], ca (boolean), revocation: { date (instant), number (int4), value (string) }, aiaUrls (string[]), ocspUrls (string[]), crlUrls (string[]), deltaCrlUrls (string[]), userId (uuid), subjectId (uuid), created (instant) updated (instant), } |
Метод получения сертификата по серийному номеру
Заголовок раздела «Метод получения сертификата по серийному номеру»| Параметр | Значение |
|---|---|
| Метод | GET API – Получение сертификата по его серийному номеру |
| Описание | Метод доступен администратору и оператору при наличии полномочий на управление сертификатом, серийный номер которого передается во входных параметрах. В ответе данного метода в полях «subjectDN» и «issuerDN» компоненты «ROLE» (роль), «DATEOFBIRTH» (дата рождения) и «PLACEOFBIRTH» (место рождения) в случае их наличия в сертификате будут указаны как «UNKNOWN». Данные компоненты поддерживаются в публичном API начиная с версии v4. |
| URL | certificate-authority-service/api/v3/public/certificates/serialNumber/{serialnumber} |
| Swagger | https://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv3%5D%20Контроллер%3A%20сертификаты/getBySerialNumber |
| Query | { serialnumber (string) } |
| Request | |
| Response | ResponseEntity -> { CollectionResponse -> id (UUID), chain: { id (UUID), name (string), subjectDN: { (enum: CN, UID, E, EMAILADDRESS, MAIL, SN, GIVENNAME, INITIALS, SURNAME, OU, O, L, ST, DC, C, UNSTRUCTUREDADDRESS, UNSTRUCTUREDNAME, POSTALCODE, BUSINESSCATEGORY, TELEPHONENUMBER, PSEUDONYM, POSTALADDRESS, STREET, NAME, T, DN, DESCRIPTION, INN, OGRN, OGRNIP, SNILS, INNLE, UNKNOWN): string[] }, issuer: {…} }, serialnumber (string), fingerprint (string), name (string), issuerId (UUID), issuerDN: { (enum: CN, UID, E, EMAILADDRESS, MAIL, SN, GIVENNAME, INITIALS, SURNAME, OU, O, L, ST, DC, C, UNSTRUCTUREDADDRESS, UNSTRUCTUREDNAME, POSTALCODE, BUSINESSCATEGORY, TELEPHONENUMBER, PSEUDONYM, POSTALADDRESS, STREET, NAME, T, DN, DESCRIPTION, INN, OGRN, OGRNIP, SNILS, INNLE, UNKNOWN): string[] }, subjectDN: { (enum: CN, UID, E, EMAILADDRESS, MAIL, SN, GIVENNAME, INITIALS, SURNAME, OU, O, L, ST, DC, C, UNSTRUCTUREDADDRESS, UNSTRUCTUREDNAME, POSTALCODE, BUSINESSCATEGORY, TELEPHONENUMBER, PSEUDONYM, POSTALADDRESS, STREET, NAME, T, DN, DESCRIPTION, INN, OGRN, OGRNIP, SNILS, INNLE, UNKNOWN): string[] }, 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[] }, 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), validTo (instant), status (enum: ACTIVE, HOLD, REVOKE, REQUEST, UNKNOWN), isValid (boolean), isExpired (boolean), actions: { p12 (boolean), csr (boolean), pem (boolean) }, publicKey (string), certificateType (string), 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), description, (string) updated (instant), created (instant), default (boolean) }], ca (boolean), revocation: { date (instant), number (int4), value (string) }, aiaUrls (string[]), ocspUrls (string[]), crlUrls (string[]), deltaCrlUrls (string[]), userId (uuid), subjectId (uuid), created (instant) updated (instant), } |
Метод получения сертификата по его отпечатку
Заголовок раздела «Метод получения сертификата по его отпечатку»| Параметр | Значение |
|---|---|
| Метод | GET API – Получение сертификата по его отпечатку |
| Описание | Метод доступен администратору и оператору при наличии полномочий на управление сертификатом, отпечаток которого передается во входных параметрах. В ответе данного метода в полях «subjectDN» и «issuerDN» компоненты «ROLE» (роль), «DATEOFBIRTH» (дата рождения) и «PLACEOFBIRTH» (место рождения) в случае их наличия в сертификате будут указаны как «UNKNOWN». Данные компоненты поддерживаются в публичном API начиная с версии v4. |
| URL | certificate-authority-service/api/v3/public/certificates/fingerprint/{fingerprint} |
| Swagger | https://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv3%5D%20Контроллер%3A%20сертификаты/getByFingerprint_1 |
| Query | { fingerprint (String) } |
| Request | |
| Response | ResponseEntity -> { CollectionResponse -> id (UUID), chain: { id (UUID), name (string), subjectDN: { (enum: CN, UID, E, EMAILADDRESS, MAIL, SN, GIVENNAME, INITIALS, SURNAME, OU, O, L, ST, DC, C, UNSTRUCTUREDADDRESS, UNSTRUCTUREDNAME, POSTALCODE, BUSINESSCATEGORY, TELEPHONENUMBER, PSEUDONYM, POSTALADDRESS, STREET, NAME, T, DN, DESCRIPTION, INN, OGRN, OGRNIP, SNILS, INNLE, UNKNOWN): string[] }, issuer: {…} }, serialnumber (string), fingerprint (string), name (string), issuerId (UUID), issuerDN: { (enum: CN, UID, E, EMAILADDRESS, MAIL, SN, GIVENNAME, INITIALS, SURNAME, OU, O, L, ST, DC, C, UNSTRUCTUREDADDRESS, UNSTRUCTUREDNAME, POSTALCODE, BUSINESSCATEGORY, TELEPHONENUMBER, PSEUDONYM, POSTALADDRESS, STREET, NAME, T, DN, DESCRIPTION, INN, OGRN, OGRNIP, SNILS, INNLE, UNKNOWN): string[] }, subjectDN: { (enum: CN, UID, E, EMAILADDRESS, MAIL, SN, GIVENNAME, INITIALS, SURNAME, OU, O, L, ST, DC, C, UNSTRUCTUREDADDRESS, UNSTRUCTUREDNAME, POSTALCODE, BUSINESSCATEGORY, TELEPHONENUMBER, PSEUDONYM, POSTALADDRESS, STREET, NAME, T, DN, DESCRIPTION, INN, OGRN, OGRNIP, SNILS, INNLE, UNKNOWN): string[] }, 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[] }, 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), validTo (instant), status (enum: ACTIVE, HOLD, REVOKE, REQUEST, UNKNOWN), isValid (boolean), isExpired (boolean), actions: { p12 (boolean), csr (boolean), pem (boolean) }, publicKey (string), certificateType (string), 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), description, (string) updated (instant), created (instant), default (boolean) }], ca (boolean), revocation: { date (instant), number (int4), value (string) }, aiaUrls (string[]), ocspUrls (string[]), crlUrls (string[]), deltaCrlUrls (string[]), userId (uuid), subjectId (uuid), created (instant) updated (instant), } |
Метод отзыва (приостановки) сертификата по идентификатору
Заголовок раздела «Метод отзыва (приостановки) сертификата по идентификатору»| Параметр | Значение |
|---|---|
| Метод | PUT API – Отзыв (приостановка) сертификата по идентификатору |
| Описание | Метод доступен администратору и оператору при наличии полномочий на управление сертификатом, идентификатор которого передается во входных параметрах |
| URL | certificate-authority-service/api/v3/public/certificates/{id}/revoke |
| Swagger | https://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv3%5D%20Контроллер%3A%20сертификаты/revokeById |
| Query | { id (UUID) } |
| Request | { reason (enum: UNSPECIFIED, KEY_COMPROMISE, CA_COMPROMISE, AFFILIATION_CHANGED, SUPERSEDED, CESSATION_OF_OPERATION, CERTIFICATE_HOLD, REMOVE_FROM_CRL, PRIVILEGE_WITHDRAWN, AA_COMPROMISE, UNKNOWN) } |
| Response | - При указании значения «CERTIFICATE_HOLD» в параметре reason сертификат будет приостановлен, а не отозван. |
Метод активации сертификата по идентификатору
Заголовок раздела «Метод активации сертификата по идентификатору»| Параметр | Значение |
|---|---|
| Метод | PUT API – Активация сертификата по идентификатору |
| Описание | Метод доступен администратору и оператору при наличии полномочий на управление сертификатом, идентификатор которого передается во входных параметрах |
| URL | certificate-authority-service/api/v3/public/certificates/{id}/reactivate |
| Swagger | https://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv3%5D%20Контроллер%3A%20сертификаты/reactivateById |
| Query | { id (UUID) } |
| Request | |
| Response |
Метод публикации сертификата в РС по идентификатору
Заголовок раздела «Метод публикации сертификата в РС по идентификатору»| Параметр | Значение |
|---|---|
| Метод | PUT API – Активация сертификата по идентификатору |
| Описание | Метод доступен администратору и оператору при наличии полномочий на управление сертификатом, идентификатор которого передается во входных параметрах |
| URL | certificate-authority-service/api/v3/public/certificates/{id}/reactivate |
| Swagger | https://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv3%5D%20Контроллер%3A%20сертификаты/reactivateById |
| Query | { id (UUID) } |
| Request | |
| Response |
Метод расшифровки контейнера сертификата
Заголовок раздела «Метод расшифровки контейнера сертификата»| Параметр | Значение |
|---|---|
| Метод | POST API – Расшифровка контейнера сертификата |
| Описание | Метод доступен администратору. В ответе данного метода в полях «subjectDN» и «issuerDN» компоненты «ROLE» (роль), «DATEOFBIRTH» (дата рождения) и «PLACEOFBIRTH» (место рождения) в случае их наличия в каком-либо сертификате из состава контейнера будут указаны как «UNKNOWN». Данные компоненты поддерживаются в публичном API начиная с версии v4. |
| URL | certificate-authority-service/api/v3/public/parse/pkcs12 |
| Swagger | https://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv3%5D%20Контроллер%3A%20контейнеры%20сертификатов/parse |
| Query | |
| Request | { container: { contentType (string) [опционально], fileName (string) [опционально], data (string:binary) }, password(string), templateId (UUID) } |
| Response | { serialnumber (string), fingerprint (string), name (string), issuerDN: { (enum: CN, UID, E, EMAILADDRESS, MAIL, SN, GIVENNAME, INITIALS, SURNAME, OU, O, L, ST, DC, C, UNSTRUCTUREDADDRESS, UNSTRUCTUREDNAME, POSTALCODE, BUSINESSCATEGORY, TELEPHONENUMBER, PSEUDONYM, POSTALADDRESS, STREET, NAME, T, DN, DESCRIPTION, INN, OGRN, OGRNIP, SNILS, INNLE, UNKNOWN): string[] }, subjectDN: { (enum: CN, UID, E, EMAILADDRESS, MAIL, SN, GIVENNAME, INITIALS, SURNAME, OU, O, L, ST, DC, C, UNSTRUCTUREDADDRESS, UNSTRUCTUREDNAME, POSTALCODE, BUSINESSCATEGORY, TELEPHONENUMBER, PSEUDONYM, POSTALADDRESS, STREET, NAME, T, DN, DESCRIPTION, INN, OGRN, OGRNIP, SNILS, INNLE, UNKNOWN): string[] }, 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[] }, validFrom (instant), validTo (instant), privateKey: { contentType (string), fileName (string), data (string:binary) }, certificate: { contentType (string), fileName (string), data (string:binary) }, 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), description (string), updated (instant), created (instant), default (boolean) }], ca (boolean) } |
Метод расшифровки сертификата
Заголовок раздела «Метод расшифровки сертификата»| Параметр | Значение |
|---|---|
| Метод | POST API – Расшифровка сертификата |
| Описание | Метод доступен администратору. В ответе данного метода в полях «subjectDN» и «issuerDN» компоненты «ROLE» (роль), «DATEOFBIRTH» (дата рождения) и «PLACEOFBIRTH» (место рождения) в случае их наличия в сертификате будут указаны как «UNKNOWN». Данные компоненты поддерживаются в публичном API начиная с версии v4. |
| URL | certificate-authority-service/api/v3/public/parse/pem |
| Swagger | https://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv3%5D%20Контроллер%3A%20контейнеры%20сертификатов/parse_2 |
| Query | |
| Request | { request: { contentType (string) [опционально], fileName (string) [опционально], data (string:binary) } } |
| Response | { id (UUID), chain: { id (UUID), name (string), subjectDN: { (enum: CN, UID, E, EMAILADDRESS, MAIL, SN, GIVENNAME, INITIALS, SURNAME, OU, O, L, ST, DC, C, UNSTRUCTUREDADDRESS, UNSTRUCTUREDNAME, POSTALCODE, BUSINESSCATEGORY, TELEPHONENUMBER, PSEUDONYM, POSTALADDRESS, STREET, NAME, T, DN, DESCRIPTION, INN, OGRN, OGRNIP, SNILS, INNLE, UNKNOWN): string[] }, issuer: {…} }, serialnumber (string), fingerprint (string), name (string), issuerId (UUID), issuerDN: { (enum: CN, UID, E, EMAILADDRESS, MAIL, SN, GIVENNAME, INITIALS, SURNAME, OU, O, L, ST, DC, C, UNSTRUCTUREDADDRESS, UNSTRUCTUREDNAME, POSTALCODE, BUSINESSCATEGORY, TELEPHONENUMBER, PSEUDONYM, POSTALADDRESS, STREET, NAME, T, DN, DESCRIPTION, INN, OGRN, OGRNIP, SNILS, INNLE, UNKNOWN): string[] }, subjectDN: { (enum: CN, UID, E, EMAILADDRESS, MAIL, SN, GIVENNAME, INITIALS, SURNAME, OU, O, L, ST, DC, C, UNSTRUCTUREDADDRESS, UNSTRUCTUREDNAME, POSTALCODE, BUSINESSCATEGORY, TELEPHONENUMBER, PSEUDONYM, POSTALADDRESS, STREET, NAME, T, DN, DESCRIPTION, INN, OGRN, OGRNIP, SNILS, INNLE, UNKNOWN): string[] }, 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[] }, 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), validTo (instant), status (enum: ACTIVE, HOLD, REVOKE, REQUEST, UNKNOWN), isValid (boolean), isExpired (boolean), actions: { p12 (boolean), csr (boolean), pem (boolean) }, publicKey (string), certificateType (string), 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), description (string), updated (instant), created (instant), default (boolean) }], ca (boolean), revocation: { date (instant), number (int4), value (string) }, aiaUrls (string[]), ocspUrls (string[]), crlUrls (string[]), deltaCrlUrls (string[]), userId (uuid), subjectId (uuid), created (instant) updated (instant), } |
Метод расшифровки запроса на сертификат
Заголовок раздела «Метод расшифровки запроса на сертификат»| Параметр | Значение |
|---|---|
| Метод | POST API – Расшифровка запроса на сертификат |
| Описание | Метод доступен администратору. В ответе данного метода в поле «subjectDN» компоненты «ROLE» (роль), «DATEOFBIRTH» (дата рождения) и «PLACEOFBIRTH» (место рождения) в случае их наличия в запросе будут указаны как «UNKNOWN». Данные компоненты поддерживаются в публичном API начиная с версии v4. |
| URL | certificate-authority-service/api/v3/public/parse/pkcs10 |
| Swagger | https://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv3%5D%20Контроллер%3A%20контейнеры%20сертификатов/parse_1 |
| Query | |
| Request | { request: { contentType (string) [опционально], fileName (string) [опционально], data (string:binary) } subjectName: { (enum: CN, UID, E, EMAILADDRESS, MAIL, SN, GIVENNAME, INITIALS, SURNAME, OU, O, L, ST, DC, C, UNSTRUCTUREDADDRESS, UNSTRUCTUREDNAME, POSTALCODE, BUSINESSCATEGORY, TELEPHONENUMBER, PSEUDONYM, POSTALADDRESS, STREET, NAME, T, DN, DESCRIPTION, INN, OGRN, OGRNIP, SNILS, INNLE, UNKNOWN): string[] },[опционально] subjectAltName: { (enum: RFC822NAME, DNS_NAME, IPADDRESS, DIRECTORY_NAME, UNIFORM_RESOURCE_ID, REGISTERED_ID, MS_UPN, MS_GUID, KRB5PRINCIPAL, PERMANENT_IDENTIFIER, XMPP_ADDR, SRV_NAME, SUBJECT_IDENTIFICATION_METHOD, UNKNOWN): string[] } [опционально] } |
| Response | { name (string), subjectDN: { (enum: CN, UID, E, EMAILADDRESS, MAIL, SN, GIVENNAME, INITIALS, SURNAME, OU, O, L, ST, DC, C, UNSTRUCTUREDADDRESS, UNSTRUCTUREDNAME, POSTALCODE, BUSINESSCATEGORY, TELEPHONENUMBER, PSEUDONYM, POSTALADDRESS, STREET, NAME, T, DN, DESCRIPTION, INN, OGRN, OGRNIP, SNILS, INNLE, UNKNOWN): string[] }, 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[] }, keyAlgorithm (enum: RSA, ECDSA, GOST_R_34_10_2012, UNKNOWN), keyBits (int32), subjectKeyIdentifier (string) } |
Методы экспорта файлов
Заголовок раздела «Методы экспорта файлов»Метод получения сертификата по идентификатору сертификата
Заголовок раздела «Метод получения сертификата по идентификатору сертификата»| Параметр | Значение |
|---|---|
| Метод | GET API – Получение сертификата по идентификатору сертификата |
| Описание | Метод доступен администратору и оператору при наличии полномочий на управление сертификатом, идентификатор которого передается во входных параметрах |
| URL | export-service/api/v3/public/export/certificates/{certificateId}/certificate |
| Swagger | https://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv3%5D%20Контроллер%20экспорта/findCertificateById |
| Query | { certificateId (UUID) } |
| Request | |
| Response | ResponseEntity->byte[] |
Метод получения запроса на сертификат по идентификатору сертификата
Заголовок раздела «Метод получения запроса на сертификат по идентификатору сертификата»| Параметр | Значение |
|---|---|
| Метод | GET API – Получение запроса на сертификат по идентификатору сертификата |
| Описание | Метод доступен администратору и оператору при наличии полномочий на управление сертификатом, идентификатор которого передается во входных параметрах |
| URL | export-service/api/v3/public/export/certificates/{certificateId}/pkcs10 |
| Swagger | https://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv3%5D%20Контроллер%20экспорта/findRequestById |
| Query | { certificateId (UUID) } |
| Request | |
| Response | ResponseEntity->byte[] |
Метод получения цепочки сертификата по идентификатору сертификата
Заголовок раздела «Метод получения цепочки сертификата по идентификатору сертификата»| Параметр | Значение |
|---|---|
| Метод | GET API – Получение цепочки сертификатов по идентификатору сертификата |
| Описание | Метод доступен администратору и оператору при наличии полномочий на управление сертификатом, идентификатор которого передается во входных параметрах |
| URL | export-service/api/v3/public/export/certificates/{certificateId}/chain |
| Swagger | https://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv3%5D%20Контроллер%20экспорта/findChainById |
| Query | { certificateId (UUID) } |
| Request | |
| Response | ResponseEntity->byte[] |
Метод получения контейнера PKCS#12 по идентификатору сертификата
Заголовок раздела «Метод получения контейнера PKCS#12 по идентификатору сертификата»| Параметр | Значение |
|---|---|
| Метод | GET API – Получение контейнера pkcs12 по идентификатору сертификата |
| Описание | Метод доступен администратору и оператору при наличии полномочий на управление сертификатом, идентификатор которого передается во входных параметрах |
| URL | export-service/api/v3/public/export/certificates/{certificateId}/pkcs12 |
| Swagger | https://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv3%5D%20Контроллер%20экспорта/findP12ById |
| Query | { certificateId (UUID) } |
| Request | |
| Response | ResponseEntity->byte[] |
Метод получения сертификата Центра сертификации по идентификатору
Заголовок раздела «Метод получения сертификата Центра сертификации по идентификатору»| Параметр | Значение |
|---|---|
| Метод | GET API – Получение сертификата по идентификатору Центра сертификации |
| Описание | Метод доступен администратору |
| URL | export-service/api/v3/public/export/certificate-authorities/{caId}/certificate |
| Swagger | https://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv3%5D%20Контроллер%20экспорта/findCertificateByCaId |
| Query | { caId (UUID) } |
| Request | |
| Response | ResponseEntity->byte[] |
Метод получения цепочки сертификатов Центра сертификации по идентификатору
Заголовок раздела «Метод получения цепочки сертификатов Центра сертификации по идентификатору»| Параметр | Значение |
|---|---|
| Метод | GET API – Получение цепочки сертификатов по идентификатору Центра сертификации |
| Описание | Метод доступен администратору |
| URL | export-service/api/v3/public/export/certificate-authorities/{caId}/chain |
| Swagger | https://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv3%5D%20Контроллер%20экспорта/findChainByCaId |
| Query | { caId (UUID) } |
| Request | |
| Response | ResponseEntity->byte[] |
Метод получения CRL по идентификатору Центра сертификации
Заголовок раздела «Метод получения CRL по идентификатору Центра сертификации»| Параметр | Значение |
|---|---|
| Метод | GET API – Получение CRL по идентификатору Центра сертификации |
| Описание | Метод доступен администратору и оператору |
| URL | export-service/api/v3/public/export/certificate-authorities/{caId}/crl |
| Swagger | https://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv3%5D%20Контроллер%20экспорта/findCrlByCaId |
| Query | |
| Request | |
| Response | ResponseEntity->byte[] |
Метод получения DeltaCRL по идентификатору Центра сертификации
Заголовок раздела «Метод получения DeltaCRL по идентификатору Центра сертификации»| Параметр | Значение |
|---|---|
| Метод | GET API – Получение DeltaCRL по идентификатору Центра сертификации |
| Описание | Метод доступен администратору и оператору |
| URL | export-service/api/v3/public/export/certificate-authorities/{caId}/delta-crl |
| Swagger | https://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv3%5D%20Контроллер%20экспорта/findDeltaCrlByCaId |
| Query | { caId (UUID) } |
| Request | |
| Response | ResponseEntity->byte[] |
Методы работы с точками распространения
Заголовок раздела «Методы работы с точками распространения»Метод генерации и публикации CRL по идентификатору Центра сертификации
Заголовок раздела «Метод генерации и публикации CRL по идентификатору Центра сертификации»| Параметр | Значение |
|---|---|
| Метод | POST API – Генерация и публикация CRL по идентификатору Центра сертификации |
| Описание | Метод доступен администратору |
| URL | publisher-service/api/v3/public/certificate-authorities/{caId}/crl-configuration/generate |
| Swagger | https://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv3%5D%20Контроллер%3A%20Конфигурации%20CRL%20для%20ЦС/generate |
| Query | { id (UUID) } |
| Request | |
| Response |
Метод генерации и публикации CRL по идентификатору Центра сертификации (устаревший)
Заголовок раздела «Метод генерации и публикации CRL по идентификатору Центра сертификации (устаревший)»| Параметр | Значение |
|---|---|
| Метод | POST API – Генерация и публикация CRL по идентификатору Центра сертификации |
| Описание | Данный метод является устаревшим и будет исключен из публичного API в последующих версиях. Метод доступен администратору |
| URL | publisher-service/api/v3/ui/certificate-authorities/{caId}/crl-configuration/generate |
| Swagger | https://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv3%5D%20Контроллер%3A%20Конфигурации%20CRL%20для%20ЦС/generateDeprecated |
| Query | { id (UUID) } |
| Request | |
| Response |
Методы работы с точками подключения и ресурсными системами
Заголовок раздела «Методы работы с точками подключения и ресурсными системами»Метод поиска зарегистрированных ресурсных систем
Заголовок раздела «Метод поиска зарегистрированных ресурсных систем»| Параметр | Значение |
|---|---|
| Метод | GET API – Поиск ресурсных систем |
| Описание | Метод доступен администратору и оператору. В ответе для оператора содержатся только те ресурсные системы, к субъектам которых ему предоставлен доступ. |
| URL | subjects-service/api/v3/public/resources |
| Swagger | https://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv3%5D%20Контроллер%3A%20ресурсные%20системы/findAll_4 |
| Query | { id (uuid) [опционально], securityGroupId (uuid) [опционально], subjectId (uuid) [опционально], search (string) [опционально], isConnected(boolean) [опционально], isDefault (boolean) [опционально], status (string) [опционально], inQueue (boolean) [опционально], lastSynchronizationSuccessDate (instant) [опционально] } |
| Request | |
| Response | ResponseEntity -> { CollectionResponse -> id (UUID), commonName (string), distinguishedName (string), subjectsCount (int64), isConnected (boolean), isDefault (boolean), updated (instant), created (instant), status (string), inQueue (boolean), lastSynchronizationSuccessDate (instant) } |
Метод получения ресурсной системы по идентификатору
Заголовок раздела «Метод получения ресурсной системы по идентификатору»| Параметр | Значение |
|---|---|
| Метод | GET API – Получение ресурсной системы по идентификатору |
| Описание | Метод доступен администратору и оператору при наличии доступа к субъектам РС, идентификатор которой передается во входных параметрах |
| URL | subjects-service/api/v3/public/resources/{id} |
| Swagger | https://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv3%5D%20Контроллер%3A%20ресурсные%20системы/findById_4 |
| Query | { id (uuid) [опционально] } |
| Request | |
| Response | ResponseEntity -> { CollectionResponse -> id (UUID), commonName (string), distinguishedName (string), subjectsCount (int64), isConnected (boolean), isDefault (boolean), updated (instant), created (instant), status (string), inQueue (boolean), lastSynchronizationSuccessDate (instant) } |
Метод полной синхронизации ресурсной системы
Заголовок раздела «Метод полной синхронизации ресурсной системы»| Параметр | Значение |
|---|---|
| Метод | PUT API – Полная синхронизация РС |
| Описание | Метод доступен администратору и оператору при наличии полномочий на субъектов данной РС |
| URL | ldap-service/api/v3/public/resources/{resourceId}/synchronize |
| Swagger | https://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv3%5D%20Контроллер%3A%20ресурсные%20системы/synchronize |
| Query | { resourceId (UUID) } |
| Request | |
| Response |
Метод поиска идентификаторов ресурсных систем
Заголовок раздела «Метод поиска идентификаторов ресурсных систем»| Параметр | Значение |
|---|---|
| Метод | GET API – Поиск ID ресурсных систем |
| Описание | Метод доступен администратору и оператору |
| URL | subjects-service/api/v3/public/subjects/dict/resources |
| Swagger | https://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv3%5D%20Контроллер%3A%20словарь%20субъектов/findResources |
| Query | { id (string[])[опционально], notId (string[])[опционально], resourceId (string[])[опционально], securityGroupId (string[])[опционально], search (string), isConnected(boolean), isBlocked(boolean) } |
| Request | |
| Response | ResponseEntity -> { CollectionResponse -> id (UUID), value (string) } |
Метод поиска точек подключения к ресурсной системе
Заголовок раздела «Метод поиска точек подключения к ресурсной системе»| Параметр | Значение |
|---|---|
| Метод | GET API – Поиск точек подключения к РС |
| Описание | Метод доступен администратору и оператору |
| URL | ldap-service/api/v3/public/connection-points |
| Swagger | https://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv3%5D%20Контроллер%3A%20Точки%20подключения%20ресурсных%20систем/findAll_12 |
| Query | { id (uuid) [опционально], resourceId (uuid) [опционально], search (string), sortDirection (string) [опционально], sortBy (string[])[опционально], pageOffset (integer) [опционально], pageLimit (integer) [опционально], inQueue (boolean) [опционально] } |
| Request | |
| Response | ResponseEntity -> { CollectionResponse -> id (UUID), title (string), domainType(enum: SAMBA_DC, MS_AD, RED_ADM, FREE_IPA, ALD_PRO, ALT_DOMAIN, UNKNOWN), connectionAddress (string), useTls (boolean), baseDn(string), username (string), status (string) resourceId (UUID), updated (instant), created (instant), inQueue (boolean) } |
Метод получения точки подключения по идентификатору
Заголовок раздела «Метод получения точки подключения по идентификатору»| Параметр | Значение |
|---|---|
| Метод | GET API – Получение точки подключения по идентификатору |
| Описание | Метод доступен администратору и оператору |
| URL | ldap-service/api/v3/public/connection-points/{id} |
| Swagger | https://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv3%5D%20Контроллер%3A%20Точки%20подключения%20ресурсных%20систем/findById_11 |
| Query | { id (uuid) } |
| Request | |
| Response | ResponseEntity -> { CollectionResponse -> id (UUID), title (string), domainType(enum: SAMBA_DC, MS_AD, RED_ADM, FREE_IPA, ALD_PRO, ALT_DOMAIN, UNKNOWN), connectionAddress (string), useTls (boolean), baseDn(string), username (string), status (string) resourceId (UUID), updated (instant), created (instant), inQueue (boolean) } |
Метод частичной синхронизации точки подключения
Заголовок раздела «Метод частичной синхронизации точки подключения»| Параметр | Значение |
|---|---|
| Метод | PUT API – Частичная синхронизация точки подключения |
| Описание | Метод доступен администратору и оператору при наличии полномочий. У оператора имеется возможность выполнять синхронизацию с теми внешними ресурсными системами, к субъектам которых у него есть доступ |
| URL | ldap-service/api/v3/public/connection-points/{pointId}/synchronize |
| Swagger | https://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv3%5D%20Контроллер%3A%20Точки%20подключения%20ресурсных%20систем/synchronize_1 |
| Query | { pointId (UUID) } |
| Request | |
| Response |
Методы получения информации о сервисах
Заголовок раздела «Методы получения информации о сервисах»Методы получения информации о сервисе безопасности (security-service)
Заголовок раздела «Методы получения информации о сервисе безопасности (security-service)»Метод получения эндпоинтов для запроса информации о сервисе безопасности (security-service)
Заголовок раздела «Метод получения эндпоинтов для запроса информации о сервисе безопасности (security-service)»| Параметр | Значение |
|---|---|
| Метод | GET – Получение списка доступных эндпоинтов для запроса информации о сервисе безопасности |
| Описание | Доступность метода для неаутентифицированного пользователя зависит от значения параметра «actuator_authenticate» конфигурационного файла: если параметр имеет значение «true», доступ к методу будет разрешен только аутентифицированным пользователям; если параметр имеет значение «false» (по умолчанию), доступ к методу будет разрешен без аутентификации. |
| URL | security-service/actuator |
| Swagger | |
| Query | |
| Request | |
| Response | { “_links”: { “self”: { “href”: “https://HOST/security-service/actuator”, “templated”: false }, “health”: { “href”: “https://HOST/security-service/actuator/health”, “templated”: false }, “health-path”: { “href”: “https://HOST/security-service/actuator/health/{*path}”, “templated”: true }, “info”: { “href”: “https://HOST/security-service/actuator/info”, “templated”: false }, “prometheus”: { “href”: “https://HOST/security-service/actuator/prometheus”, “templated”: false } } } |
Метод получения информации о состоянии сервиса безопасности (security-service)
Заголовок раздела «Метод получения информации о состоянии сервиса безопасности (security-service)»| Параметр | Значение |
|---|---|
| Метод | GET – Получение информации о состоянии сервиса безопасности |
| Описание | Доступность метода для неаутентифицированного пользователя зависит от значения параметра «actuator_authenticate» конфигурационного файла: если параметр имеет значение «true», доступ к методу будет разрешен только аутентифицированным пользователям; если параметр имеет значение «false» (по умолчанию), доступ к методу будет разрешен без аутентификации. |
| URL | security-service/actuator/health |
| Swagger | |
| Query | |
| Request | |
| Response | { “status”: “<UP | DOWN | OUT_OF_SERVICE | UNKNOWN>” } |
Метод получения информации о сервисе безопасности (security-service)
Заголовок раздела «Метод получения информации о сервисе безопасности (security-service)»| Параметр | Значение |
|---|---|
| Метод | GET – Получение информации о сервисе безопасности |
| Описание | Доступность метода для неаутентифицированного пользователя зависит от значения параметра «actuator_authenticate» конфигурационного файла: если параметр имеет значение «true», доступ к методу будет разрешен только аутентифицированным пользователям; если параметр имеет значение «false» (по умолчанию), доступ к методу будет разрешен без аутентификации. |
| URL | security-service/actuator/info |
| Swagger | |
| Query | |
| Request | |
| Response | { “application”: { “name”: “<название сервиса>”, “version”: “<версия сервиса>” } } |
Метод получения Prometheus-метрик сервиса безопасности (security-service)
Заголовок раздела «Метод получения Prometheus-метрик сервиса безопасности (security-service)»| Параметр | Значение |
|---|---|
| Метод | GET – Получение Prometheus-метрик сервиса безопасности |
| Описание | Доступность метода для неаутентифицированного пользователя зависит от значения параметра «actuator_authenticate» конфигурационного файла: если параметр имеет значение «true», доступ к методу будет разрешен только аутентифицированным пользователям; если параметр имеет значение «false» (по умолчанию), доступ к методу будет разрешен без аутентификации. |
| URL | security-service/actuator/prometheus |
| Swagger | |
| Query | |
| Request | |
| Response | Метод возвращает метрики сервиса в формате Prometheus (text/plain) |
Методы получения информации о сервисе лицензий (license-service)
Заголовок раздела «Методы получения информации о сервисе лицензий (license-service)»Метод получения эндпоинтов для запроса информации о сервисе лицензий (license-service)
Заголовок раздела «Метод получения эндпоинтов для запроса информации о сервисе лицензий (license-service)»| Параметр | Значение |
|---|---|
| Метод | GET – Получение списка доступных эндпоинтов для запроса информации о сервисе лицензий |
| Описание | Доступность метода для неаутентифицированного пользователя зависит от значения параметра «actuator_authenticate» конфигурационного файла: если параметр имеет значение «true», доступ к методу будет разрешен только аутентифицированным пользователям; если параметр имеет значение «false» (по умолчанию), доступ к методу будет разрешен без аутентификации. |
| URL | license-service/actuator |
| Swagger | |
| Query | |
| Request | |
| Response | { “_links”: { “self”: { “href”: “https://HOST/license-service/actuator”, “templated”: false }, “health”: { “href”: “https://HOST/license-service/actuator/health”, “templated”: false }, “health-path”: { “href”: “https://HOST/license-service/actuator/health/{*path}”, “templated”: true }, “info”: { “href”: “https://HOST/license-service/actuator/info”, “templated”: false }, “prometheus”: { “href”: “https://HOST/license-service/actuator/prometheus”, “templated”: false } } } |
Метод получения информации о состоянии сервиса лицензий (license-service)
Заголовок раздела «Метод получения информации о состоянии сервиса лицензий (license-service)»| Параметр | Значение |
|---|---|
| Метод | GET – Получение информации о состоянии сервиса лицензий |
| Описание | Доступность метода для неаутентифицированного пользователя зависит от значения параметра «actuator_authenticate» конфигурационного файла: если параметр имеет значение «true», доступ к методу будет разрешен только аутентифицированным пользователям; если параметр имеет значение «false» (по умолчанию), доступ к методу будет разрешен без аутентификации. |
| URL | license-service/actuator/health |
| Swagger | |
| Query | |
| Request | |
| Response | { “status”: “<UP | DOWN | OUT_OF_SERVICE | UNKNOWN>” } |
Метод получения информации о сервисе лицензий (license-service)
Заголовок раздела «Метод получения информации о сервисе лицензий (license-service)»| Параметр | Значение |
|---|---|
| Метод | GET – Получение информации о сервисе лицензий |
| Описание | Доступность метода для неаутентифицированного пользователя зависит от значения параметра «actuator_authenticate» конфигурационного файла: если параметр имеет значение «true», доступ к методу будет разрешен только аутентифицированным пользователям; если параметр имеет значение «false» (по умолчанию), доступ к методу будет разрешен без аутентификации. |
| URL | license-service/actuator/info |
| Swagger | |
| Query | |
| Request | |
| Response | { “application”: { “name”: “<название сервиса>”, “version”: “<версия сервиса>” } } |
Метод получения Prometheus-метрик сервиса лицензий (license-service)
Заголовок раздела «Метод получения Prometheus-метрик сервиса лицензий (license-service)»| Параметр | Значение |
|---|---|
| Метод | GET – Получение Prometheus-метрик сервиса лицензий |
| Описание | Доступность метода для неаутентифицированного пользователя зависит от значения параметра «actuator_authenticate» конфигурационного файла: если параметр имеет значение «true», доступ к методу будет разрешен только аутентифицированным пользователям; если параметр имеет значение «false» (по умолчанию), доступ к методу будет разрешен без аутентификации. |
| URL | license-service/actuator/prometheus |
| Swagger | |
| Query | |
| Request | |
| Response | Метод возвращает метрики сервиса в формате Prometheus (text/plain) |
Методы получения информации о сервисе журнала событий (logs-service)
Заголовок раздела «Методы получения информации о сервисе журнала событий (logs-service)»Метод получения эндпоинтов для запроса информации о сервисе журнала событий (logs-service)
Заголовок раздела «Метод получения эндпоинтов для запроса информации о сервисе журнала событий (logs-service)»| Параметр | Значение |
|---|---|
| Метод | GET – Получение списка доступных эндпоинтов для запроса информации о сервисе журнала событий |
| Описание | Доступность метода для неаутентифицированного пользователя зависит от значения параметра «actuator_authenticate» конфигурационного файла: если параметр имеет значение «true», доступ к методу будет разрешен только аутентифицированным пользователям; если параметр имеет значение «false» (по умолчанию), доступ к методу будет разрешен без аутентификации. |
| URL | logs-service/actuator |
| Swagger | |
| Query | |
| Request | |
| Response | { “_links”: { “self”: { “href”: “https://HOST/logs-service/actuator”, “templated”: false }, “health”: { “href”: “https://HOST/logs-service/actuator/health”, “templated”: false }, “health-path”: { “href”: “https://HOST/logs-service/actuator/health/{*path}”, “templated”: true }, “info”: { “href”: “https://HOST/logs-service/actuator/info”, “templated”: false }, “prometheus”: { “href”: “https://HOST/logs-service/actuator/prometheus”, “templated”: false } } } |
Метод получения информации о состоянии сервиса журнала событий (logs-service)
Заголовок раздела «Метод получения информации о состоянии сервиса журнала событий (logs-service)»| Параметр | Значение |
|---|---|
| Метод | GET – Получение информации о состоянии сервиса журнала событий |
| Описание | Доступность метода для неаутентифицированного пользователя зависит от значения параметра «actuator_authenticate» конфигурационного файла: если параметр имеет значение «true», доступ к методу будет разрешен только аутентифицированным пользователям; если параметр имеет значение «false» (по умолчанию), доступ к методу будет разрешен без аутентификации. |
| URL | logs-service/actuator/health |
| Swagger | |
| Query | |
| Request | |
| Response | { “status”: “<UP | DOWN | OUT_OF_SERVICE | UNKNOWN>” } |
Метод получения информации о сервисе журнала событий (logs-service)
Заголовок раздела «Метод получения информации о сервисе журнала событий (logs-service)»| Параметр | Значение |
|---|---|
| Метод | GET – Получение информации о сервисе журнала событий |
| Описание | Доступность метода для неаутентифицированного пользователя зависит от значения параметра «actuator_authenticate» конфигурационного файла: если параметр имеет значение «true», доступ к методу будет разрешен только аутентифицированным пользователям; если параметр имеет значение «false» (по умолчанию), доступ к методу будет разрешен без аутентификации. |
| URL | logs-service/actuator/info |
| Swagger | |
| Query | |
| Request | |
| Response | { “application”: { “name”: “<название сервиса>”, “version”: “<версия сервиса>” } } |
Метод получения Prometheus-метрик сервиса журнала событий (logs-service)
Заголовок раздела «Метод получения Prometheus-метрик сервиса журнала событий (logs-service)»| Параметр | Значение |
|---|---|
| Метод | GET – Получение Prometheus-метрик сервиса журнала событий |
| Описание | Доступность метода для неаутентифицированного пользователя зависит от значения параметра «actuator_authenticate» конфигурационного файла: если параметр имеет значение «true», доступ к методу будет разрешен только аутентифицированным пользователям; если параметр имеет значение «false» (по умолчанию), доступ к методу будет разрешен без аутентификации. |
| URL | logs-service/actuator/prometheus |
| Swagger | |
| Query | |
| Request | |
| Response | Метод возвращает метрики сервиса в формате Prometheus (text/plain) |
Методы получения информации о сервисе сертификатов (certificate-authority-service)
Заголовок раздела «Методы получения информации о сервисе сертификатов (certificate-authority-service)»Метод получения эндпоинтов для запроса информации о сервисе сертификатов (certificate-authority-service)
Заголовок раздела «Метод получения эндпоинтов для запроса информации о сервисе сертификатов (certificate-authority-service)»| Параметр | Значение |
|---|---|
| Метод | GET – Получение списка доступных эндпоинтов для запроса информации о сервисе сертификатов |
| Описание | Доступность метода для неаутентифицированного пользователя зависит от значения параметра «actuator_authenticate» конфигурационного файла: если параметр имеет значение «true», доступ к методу будет разрешен только аутентифицированным пользователям; если параметр имеет значение «false» (по умолчанию), доступ к методу будет разрешен без аутентификации. |
| URL | certificate-authority-service/actuator |
| Swagger | |
| Query | |
| Request | |
| Response | { “_links”: { “self”: { “href”: “https://HOST/certificate-authority-service/actuator”, “templated”: false }, “health”: { “href”: “https://HOST/certificate-authority-service/actuator/health”, “templated”: false }, “health-path”: { “href”: “https://HOST/certificate-authority-service/actuator/health/{*path}”, “templated”: true }, “info”: { “href”: “https://HOST/certificate-authority-service/actuator/info”, “templated”: false }, “prometheus”: { “href”: “https://HOST/certificate-authority-service/actuator/prometheus”, “templated”: false } } } |
Метод получения информации о состоянии сервиса сертификатов (certificate-authority-service)
Заголовок раздела «Метод получения информации о состоянии сервиса сертификатов (certificate-authority-service)»| Параметр | Значение |
|---|---|
| Метод | GET – Получение информации о состоянии сервиса сертификатов |
| Описание | Доступность метода для неаутентифицированного пользователя зависит от значения параметра «actuator_authenticate» конфигурационного файла: если параметр имеет значение «true», доступ к методу будет разрешен только аутентифицированным пользователям; если параметр имеет значение «false» (по умолчанию), доступ к методу будет разрешен без аутентификации. |
| URL | certificate-authority-service/actuator/health |
| Swagger | |
| Query | |
| Request | |
| Response | { “status”: “<UP | DOWN | OUT_OF_SERVICE | UNKNOWN>” } |
Метод получения информации о сервисе сертификатов (certificate-authority-service)
Заголовок раздела «Метод получения информации о сервисе сертификатов (certificate-authority-service)»| Параметр | Значение |
|---|---|
| Метод | GET – Получение информации о сервисе сертификатов |
| Описание | Доступность метода для неаутентифицированного пользователя зависит от значения параметра «actuator_authenticate» конфигурационного файла: если параметр имеет значение «true», доступ к методу будет разрешен только аутентифицированным пользователям; если параметр имеет значение «false» (по умолчанию), доступ к методу будет разрешен без аутентификации. |
| URL | certificate-authority-service/actuator/info |
| Swagger | |
| Query | |
| Request | |
| Response | { “application”: { “name”: “<название сервиса>”, “version”: “<версия сервиса>” } } |
Метод получения Prometheus-метрик сервиса сертификатов (certificate-authority-service)
Заголовок раздела «Метод получения Prometheus-метрик сервиса сертификатов (certificate-authority-service)»| Параметр | Значение |
|---|---|
| Метод | GET – Получение Prometheus-метрик сервиса сертификатов |
| Описание | Доступность метода для неаутентифицированного пользователя зависит от значения параметра «actuator_authenticate» конфигурационного файла: если параметр имеет значение «true», доступ к методу будет разрешен только аутентифицированным пользователям; если параметр имеет значение «false» (по умолчанию), доступ к методу будет разрешен без аутентификации. |
| URL | certificate-authority-service/actuator/prometheus |
| Swagger | |
| Query | |
| Request | |
| Response | Метод возвращает метрики сервиса в формате Prometheus (text/plain) |
Методы получения информации о сервисе настроек (settings-service)
Заголовок раздела «Методы получения информации о сервисе настроек (settings-service)»Метод получения эндпоинтов для запроса информации о сервисе настроек (settings-service)
Заголовок раздела «Метод получения эндпоинтов для запроса информации о сервисе настроек (settings-service)»| Параметр | Значение |
|---|---|
| Метод | GET – Получение списка доступных эндпоинтов для запроса информации о сервисе настроек |
| Описание | Доступность метода для неаутентифицированного пользователя зависит от значения параметра «actuator_authenticate» конфигурационного файла: если параметр имеет значение «true», доступ к методу будет разрешен только аутентифицированным пользователям; если параметр имеет значение «false» (по умолчанию), доступ к методу будет разрешен без аутентификации. |
| URL | settings-service/actuator |
| Swagger | |
| Query | |
| Request | |
| Response | { “_links”: { “self”: { “href”: “https://HOST/settings-service/actuator”, “templated”: false }, “health”: { “href”: “https://HOST/settings-service/actuator/health”, “templated”: false }, “health-path”: { “href”: “https://HOST/settings-service/actuator/health/{*path}”, “templated”: true }, “info”: { “href”: “https://HOST/settings-service/actuator/info”, “templated”: false }, “prometheus”: { “href”: “https://HOST/settings-service/actuator/prometheus”, “templated”: false } } } |
Метод получения информации о состоянии сервиса настроек (settings-service)
Заголовок раздела «Метод получения информации о состоянии сервиса настроек (settings-service)»| Параметр | Значение |
|---|---|
| Метод | GET – Получение информации о состоянии сервиса настроек |
| Описание | Доступность метода для неаутентифицированного пользователя зависит от значения параметра «actuator_authenticate» конфигурационного файла: если параметр имеет значение «true», доступ к методу будет разрешен только аутентифицированным пользователям; если параметр имеет значение «false» (по умолчанию), доступ к методу будет разрешен без аутентификации. |
| URL | settings-service/actuator/health |
| Swagger | |
| Query | |
| Request | |
| Response | { “status”: “<UP | DOWN | OUT_OF_SERVICE | UNKNOWN>” } |
Метод получения информации о сервисе настроек (settings-service)
Заголовок раздела «Метод получения информации о сервисе настроек (settings-service)»| Параметр | Значение |
|---|---|
| Метод | GET – Получение информации о сервисе настроек |
| Описание | Доступность метода для неаутентифицированного пользователя зависит от значения параметра «actuator_authenticate» конфигурационного файла: если параметр имеет значение «true», доступ к методу будет разрешен только аутентифицированным пользователям; если параметр имеет значение «false» (по умолчанию), доступ к методу будет разрешен без аутентификации. |
| URL | settings-service/actuator/info |
| Swagger | |
| Query | |
| Request | |
| Response | { “application”: { “name”: “<название сервиса>”, “version”: “<версия сервиса>” } } |
Метод получения Prometheus-метрик сервиса настроек (settings-service)
Заголовок раздела «Метод получения Prometheus-метрик сервиса настроек (settings-service)»| Параметр | Значение |
|---|---|
| Метод | GET – Получение Prometheus-метрик сервиса настроек |
| Описание | Доступность метода для неаутентифицированного пользователя зависит от значения параметра «actuator_authenticate» конфигурационного файла: если параметр имеет значение «true», доступ к методу будет разрешен только аутентифицированным пользователям; если параметр имеет значение «false» (по умолчанию), доступ к методу будет разрешен без аутентификации. |
| URL | settings-service/actuator/prometheus |
| Swagger | |
| Query | |
| Request | |
| Response | Метод возвращает метрики сервиса в формате Prometheus (text/plain) |
Методы получения информации о сервисе хранения данных (storage-service)
Заголовок раздела «Методы получения информации о сервисе хранения данных (storage-service)»Метод получения эндпоинтов для запроса информации о сервисе хранения данных (storage-service)
Заголовок раздела «Метод получения эндпоинтов для запроса информации о сервисе хранения данных (storage-service)»| Параметр | Значение |
|---|---|
| Метод | GET – Получение списка доступных эндпоинтов для запроса информации о сервисе хранения данных |
| Описание | Доступность метода для неаутентифицированного пользователя зависит от значения параметра «actuator_authenticate» конфигурационного файла: если параметр имеет значение «true», доступ к методу будет разрешен только аутентифицированным пользователям; если параметр имеет значение «false» (по умолчанию), доступ к методу будет разрешен без аутентификации. |
| URL | storage-service/actuator |
| Swagger | |
| Query | |
| Request | |
| Response | { “_links”: { “self”: { “href”: “https://HOST/storage-service/actuator”, “templated”: false }, “health”: { “href”: “https://HOST/storage-service/actuator/health”, “templated”: false }, “health-path”: { “href”: “https://HOST/storage-service/actuator/health/{*path}”, “templated”: true }, “info”: { “href”: “https://HOST/storage-service/actuator/info”, “templated”: false }, “prometheus”: { “href”: “https://HOST/storage-service/actuator/prometheus”, “templated”: false } } } |
Метод получения информации о состоянии сервиса хранения данных (storage-service)
Заголовок раздела «Метод получения информации о состоянии сервиса хранения данных (storage-service)»| Параметр | Значение |
|---|---|
| Метод | GET – Получение информации о состоянии сервиса хранения данных |
| Описание | Доступность метода для неаутентифицированного пользователя зависит от значения параметра «actuator_authenticate» конфигурационного файла: если параметр имеет значение «true», доступ к методу будет разрешен только аутентифицированным пользователям; если параметр имеет значение «false» (по умолчанию), доступ к методу будет разрешен без аутентификации. |
| URL | storage-service/actuator/health |
| Swagger | |
| Query | |
| Request | |
| Response | { “status”: “<UP | DOWN | OUT_OF_SERVICE | UNKNOWN>” } |
Метод получения информации о сервисе хранения данных (storage-service)
Заголовок раздела «Метод получения информации о сервисе хранения данных (storage-service)»| Параметр | Значение |
|---|---|
| Метод | GET – Получение информации о сервисе хранения данных |
| Описание | Доступность метода для неаутентифицированного пользователя зависит от значения параметра «actuator_authenticate» конфигурационного файла: если параметр имеет значение «true», доступ к методу будет разрешен только аутентифицированным пользователям; если параметр имеет значение «false» (по умолчанию), доступ к методу будет разрешен без аутентификации. |
| URL | storage-service/actuator/info |
| Swagger | |
| Query | |
| Request | |
| Response | { “application”: { “name”: “<название сервиса>”, “version”: “<версия сервиса>” } } |
Метод получения Prometheus-метрик сервиса хранения данных (storage-service)
Заголовок раздела «Метод получения Prometheus-метрик сервиса хранения данных (storage-service)»| Параметр | Значение |
|---|---|
| Метод | GET – Получение Prometheus-метрик сервиса хранения данных |
| Описание | Доступность метода для неаутентифицированного пользователя зависит от значения параметра «actuator_authenticate» конфигурационного файла: если параметр имеет значение «true», доступ к методу будет разрешен только аутентифицированным пользователям; если параметр имеет значение «false» (по умолчанию), доступ к методу будет разрешен без аутентификации. |
| URL | storage-service/actuator/prometheus |
| Swagger | |
| Query | |
| Request | |
| Response | Метод возвращает метрики сервиса в формате Prometheus (text/plain) |
Методы получения информации о сервисе оповещения пользователей (event-delivery-service)
Заголовок раздела «Методы получения информации о сервисе оповещения пользователей (event-delivery-service)»Метод получения эндпоинтов для запроса информации о сервисе оповещения пользователей (event-delivery-service)
Заголовок раздела «Метод получения эндпоинтов для запроса информации о сервисе оповещения пользователей (event-delivery-service)»| Параметр | Значение |
|---|---|
| Метод | GET – Получение списка доступных эндпоинтов для запроса информации о сервисе оповещения пользователей |
| Описание | Доступность метода для неаутентифицированного пользователя зависит от значения параметра «actuator_authenticate» конфигурационного файла: если параметр имеет значение «true», доступ к методу будет разрешен только аутентифицированным пользователям; если параметр имеет значение «false» (по умолчанию), доступ к методу будет разрешен без аутентификации. |
| URL | event-delivery-service/actuator |
| Swagger | |
| Query | |
| Request | |
| Response | { “_links”: { “self”: { “href”: “https://HOST/event-delivery-service/actuator”, “templated”: false }, “health”: { “href”: “https://HOST/event-delivery-service/actuator/health”, “templated”: false }, “health-path”: { “href”: “https://HOST/event-delivery-service/actuator/health/{*path}”, “templated”: true }, “info”: { “href”: “https://HOST/event-delivery-service/actuator/info”, “templated”: false }, “prometheus”: { “href”: “https://HOST/event-delivery-service/actuator/prometheus”, “templated”: false } } } |
Метод получения информации о состоянии сервиса оповещения пользователей (event-delivery-service)
Заголовок раздела «Метод получения информации о состоянии сервиса оповещения пользователей (event-delivery-service)»| Параметр | Значение |
|---|---|
| Метод | GET – Получение информации о состоянии сервиса оповещения пользователей |
| Описание | Доступность метода для неаутентифицированного пользователя зависит от значения параметра «actuator_authenticate» конфигурационного файла: если параметр имеет значение «true», доступ к методу будет разрешен только аутентифицированным пользователям; если параметр имеет значение «false» (по умолчанию), доступ к методу будет разрешен без аутентификации. |
| URL | event-delivery-service/actuator/health |
| Swagger | |
| Query | |
| Request | |
| Response | { “status”: “<UP | DOWN | OUT_OF_SERVICE | UNKNOWN>” } |
Метод получения информации о сервисе оповещения пользователей (event-delivery-service)
Заголовок раздела «Метод получения информации о сервисе оповещения пользователей (event-delivery-service)»| Параметр | Значение |
|---|---|
| Метод | GET – Получение информации о сервисе оповещения пользователей |
| Описание | Доступность метода для неаутентифицированного пользователя зависит от значения параметра «actuator_authenticate» конфигурационного файла: если параметр имеет значение «true», доступ к методу будет разрешен только аутентифицированным пользователям; если параметр имеет значение «false» (по умолчанию), доступ к методу будет разрешен без аутентификации. |
| URL | event-delivery-service/actuator/info |
| Swagger | |
| Query | |
| Request | |
| Response | { “application”: { “name”: “<название сервиса>”, “version”: “<версия сервиса>” } } |
Метод получения Prometheus-метрик сервиса оповещения пользователей (event-delivery-service)
Заголовок раздела «Метод получения Prometheus-метрик сервиса оповещения пользователей (event-delivery-service)»| Параметр | Значение |
|---|---|
| Метод | GET – Получение Prometheus-метрик сервиса оповещения пользователей |
| Описание | Доступность метода для неаутентифицированного пользователя зависит от значения параметра «actuator_authenticate» конфигурационного файла: если параметр имеет значение «true», доступ к методу будет разрешен только аутентифицированным пользователям; если параметр имеет значение «false» (по умолчанию), доступ к методу будет разрешен без аутентификации. |
| URL | event-delivery-service/actuator/prometheus |
| Swagger | |
| Query | |
| Request | |
| Response | Метод возвращает метрики сервиса в формате Prometheus (text/plain) |
Методы получения информации о сервисе внешних интеграций (external-integration-service)
Заголовок раздела «Методы получения информации о сервисе внешних интеграций (external-integration-service)»Метод получения эндпоинтов для запроса информации о сервисе внешних интеграций (external-integration-service)
Заголовок раздела «Метод получения эндпоинтов для запроса информации о сервисе внешних интеграций (external-integration-service)»| Параметр | Значение |
|---|---|
| Метод | GET – Получение списка доступных эндпоинтов для запроса информации о сервисе внешних интеграций |
| Описание | Доступность метода для неаутентифицированного пользователя зависит от значения параметра «actuator_authenticate» конфигурационного файла: если параметр имеет значение «true», доступ к методу будет разрешен только аутентифицированным пользователям; если параметр имеет значение «false» (по умолчанию), доступ к методу будет разрешен без аутентификации. |
| URL | external-integration-service/actuator |
| Swagger | |
| Query | |
| Request | |
| Response | { “_links”: { “self”: { “href”: “https://HOST/external-integration-service/actuator”, “templated”: false }, “health”: { “href”: “https://HOST/external-integration-service/actuator/health”, “templated”: false }, “health-path”: { “href”: “https://HOST/external-integration-service/actuator/health/{*path}”, “templated”: true }, “info”: { “href”: “https://HOST/external-integration-service/actuator/info”, “templated”: false }, “prometheus”: { “href”: “https://HOST/external-integration-service/actuator/prometheus”, “templated”: false } } } |
Метод получения информации о состоянии сервиса внешних интеграций (external-integration-service)
Заголовок раздела «Метод получения информации о состоянии сервиса внешних интеграций (external-integration-service)»| Параметр | Значение |
|---|---|
| Метод | GET – Получение информации о состоянии сервиса внешних интеграций |
| Описание | Доступность метода для неаутентифицированного пользователя зависит от значения параметра «actuator_authenticate» конфигурационного файла: если параметр имеет значение «true», доступ к методу будет разрешен только аутентифицированным пользователям; если параметр имеет значение «false» (по умолчанию), доступ к методу будет разрешен без аутентификации. |
| URL | external-integration-service/actuator/health |
| Swagger | |
| Query | |
| Request | |
| Response | { “status”: “<UP | DOWN | OUT_OF_SERVICE | UNKNOWN>” } |
Метод получения информации о сервисе внешних интеграций (external-integration-service)
Заголовок раздела «Метод получения информации о сервисе внешних интеграций (external-integration-service)»| Параметр | Значение |
|---|---|
| Метод | GET – Получение информации о сервисе внешних интеграций |
| Описание | Доступность метода для неаутентифицированного пользователя зависит от значения параметра «actuator_authenticate» конфигурационного файла: если параметр имеет значение «true», доступ к методу будет разрешен только аутентифицированным пользователям; если параметр имеет значение «false» (по умолчанию), доступ к методу будет разрешен без аутентификации. |
| URL | external-integration-service/actuator/info |
| Swagger | |
| Query | |
| Request | |
| Response | { “application”: { “name”: “<название сервиса>”, “version”: “<версия сервиса>” } } |
Метод получения Prometheus-метрик сервиса внешних интеграций (external-integration-service)
Заголовок раздела «Метод получения Prometheus-метрик сервиса внешних интеграций (external-integration-service)»| Параметр | Значение |
|---|---|
| Метод | GET – Получение Prometheus-метрик сервиса внешних интеграций |
| Описание | Доступность метода для неаутентифицированного пользователя зависит от значения параметра «actuator_authenticate» конфигурационного файла: если параметр имеет значение «true», доступ к методу будет разрешен только аутентифицированным пользователям; если параметр имеет значение «false» (по умолчанию), доступ к методу будет разрешен без аутентификации. |
| URL | external-integration-service/actuator/prometheus |
| Swagger | |
| Query | |
| Request | |
| Response | Метод возвращает метрики сервиса в формате Prometheus (text/plain) |
Методы работы с Syslog-серверами
Заголовок раздела «Методы работы с Syslog-серверами»Метод поиска Syslog-серверов
Заголовок раздела «Метод поиска Syslog-серверов»| Параметр | Значение |
|---|---|
| Метод | GET API – Поиск Syslog-серверов |
| Описание | Метод доступен только администратору |
| URL | logs-service/api/v3/public/syslog |
| Swagger | https://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv3%5D%20Контроллер%3A%20Syslog%20сервера/findAll_10 |
| Query | |
| Request | |
| Response | ResponseEntity -> { CollectionResponse -> id (UUID), host (string), port (int32), protocol (enum: UDP, TCP, UNKNOWN), active (boolean) } |
Метод получения Syslog-сервера по идентификатору
Заголовок раздела «Метод получения Syslog-сервера по идентификатору»| Параметр | Значение |
|---|---|
| Метод | GET API – Получение Syslog-сервера по идентификатору |
| Описание | Метод доступен только администратору |
| URL | logs-service/api/v3/public/syslog/{id} |
| Swagger | https://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv3%5D%20Контроллер%3A%20Syslog%20сервера/findById_9 |
| Query | { id (uuid) } |
| Request | |
| Response | { id (UUID), host (string), port (int32), protocol (enum: UDP, TCP, UNKNOWN), active (boolean) } |
Метод создания Syslog-сервера
Заголовок раздела «Метод создания Syslog-сервера»| Параметр | Значение |
|---|---|
| Метод | POST API – Создание Syslog-сервера |
| Описание | Метод доступен только администратору |
| URL | logs-service/api/v3/public/syslog |
| Swagger | https://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv3%5D%20Контроллер%3A%20Syslog%20сервера/create |
| Query | |
| Request | { host (string), port (int32), protocol (enum: UDP, TCP, UNKNOWN) } |
| Response | { id (UUID), host (string), port (int32), protocol (enum: UDP, TCP, UNKNOWN), active (boolean) } |
Метод обновления Syslog-сервера
Заголовок раздела «Метод обновления Syslog-сервера»| Параметр | Значение |
|---|---|
| Метод | PUT API – Обновление Syslog-сервера |
| Описание | Метод доступен только администратору |
| URL | logs-service/api/v3/public/syslog/{id} |
| Swagger | https://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv3%5D%20Контроллер%3A%20Syslog%20сервера/updateById |
| Query | { id (uuid) } |
| Request | { host (string), port (int32), protocol (enum: UDP, TCP, UNKNOWN) } |
| Response | { id (UUID), host (string), port (int32), protocol (enum: UDP, TCP, UNKNOWN), active (boolean) } |
Метод деактивации Syslog-сервера
Заголовок раздела «Метод деактивации Syslog-сервера»| Параметр | Значение |
|---|---|
| Метод | PATCH API – Деактивация Syslog-сервера |
| Описание | Метод доступен только администратору |
| URL | logs-service/api/v3/public/syslog/{id}/deactivate |
| Swagger | https://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv3%5D%20Контроллер%3A%20Syslog%20сервера/deactivate |
| Query | { id (uuid) } |
| Request | |
| Response |
Метод активации Syslog-сервера
Заголовок раздела «Метод активации Syslog-сервера»| Параметр | Значение |
|---|---|
| Метод | PATCH API – Активация Syslog-сервера |
| Описание | Метод доступен только администратору |
| URL | logs-service/api/v3/public/syslog/{id}/activate |
| Swagger | https://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv3%5D%20Контроллер%3A%20Syslog%20сервера/activate |
| Query | { id (uuid) } |
| Request | |
| Response |
Метод удаления Syslog-сервера
Заголовок раздела «Метод удаления Syslog-сервера»| Параметр | Значение |
|---|---|
| Метод | DELETE API – Удаление Syslog-сервера |
| Описание | Метод доступен только администратору |
| URL | logs-service/api/v3/public/syslog/{id} |
| Swagger | https://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv3%5D%20Контроллер%3A%20Syslog%20сервера/deleteById_2 |
| Query | { id (uuid) } |
| Request | |
| Response |
Методы работы с учетными записями
Заголовок раздела «Методы работы с учетными записями»Метод поиска учетных записей
Заголовок раздела «Метод поиска учетных записей»| Параметр | Значение |
|---|---|
| Метод | GET API – Поиск учетных записей |
| Описание | Метод доступен администратору |
| URL | security-service/api/v3/public/accounts |
| Swagger | https://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv3%5D%20Контроллер%3A%20Учетные%20записи/findAll_9 |
| Query | { id (uuid[]) [опционально], notId (uuid[]) [опционально], logins (uuid[]) [опционально], search (string) [опционально] } |
| Request | |
| Response | ResponseEntity -> { CollectionResponse -> id (UUID), login (string), principalName (string), role (enum: ADMINISTRATOR, OPERATOR, UNKNOWN), status (enum: ACTIVE, BLOCKED, UNKNOWN), created (instant), isLinked (boolean) } |
Метод получения учетной записи по идентификатору
Заголовок раздела «Метод получения учетной записи по идентификатору»| Параметр | Значение |
|---|---|
| Метод | GET API – Получение учетной записи по идентификатору |
| Описание | Метод доступен администратору, а также оператору для получения данных о его собственной учетной записи |
| URL | security-service/api/v3/public/accounts/{id} |
| Swagger | https://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv3%5D%20Контроллер%3A%20Учетные%20записи/findById_8 |
| Query | { id (uuid) } |
| Request | |
| Response | ResponseEntity -> { CollectionResponse -> id (UUID), login (string), principalName (string), role (enum: ADMINISTRATOR, OPERATOR, UNKNOWN), status (enum: ACTIVE, BLOCKED, UNKNOWN), created (instant), isLinked (boolean) } |
Метод получения учетной записи по отпечатку сертификата
Заголовок раздела «Метод получения учетной записи по отпечатку сертификата»| Параметр | Значение |
|---|---|
| Метод | GET API – Получение учетной записи по отпечатку сертификата |
| Описание | Метод доступен администратору |
| URL | security-service/api/v3/public/accounts/fingerprint/{fingerprint} |
| Swagger | https://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv3%5D%20Контроллер%3A%20Учетные%20записи/getByFingerprint |
| Query | { fingerprint (string) } |
| Request | |
| Response | ResponseEntity -> { CollectionResponse -> id (UUID), login (string), principalName (string), role (enum: ADMINISTRATOR, OPERATOR, UNKNOWN), status (enum: ACTIVE, BLOCKED, UNKNOWN), created (instant), isLinked (boolean) } |
Метод получения учетной записи по идентификатору субъекта
Заголовок раздела «Метод получения учетной записи по идентификатору субъекта»| Параметр | Значение |
|---|---|
| Метод | GET API – Получение учетной записи по идентификатору субъекта |
| Описание | Метод доступен администратору |
| URL | security-service/api/v3/public/accounts/subject/{subjectId} |
| Swagger | https://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv3%5D%20Контроллер%3A%20Учетные%20записи/findBySubjectId |
| Query | { subjectId (string) } |
| Request | |
| Response | ResponseEntity -> { CollectionResponse -> id (UUID), login (string), principalName (string), role (enum: ADMINISTRATOR, OPERATOR, UNKNOWN), status (enum: ACTIVE, BLOCKED, UNKNOWN), created (instant), isLinked (boolean) } |
Методы работы с издателями
Заголовок раздела «Методы работы с издателями»Метод поиска издателей
Заголовок раздела «Метод поиска издателей»| Параметр | Значение |
|---|---|
| Метод | GET API – Поиск учетных записей |
| Описание | Метод доступен администратору |
| URL | settings-service/api/v3/public/issuer |
| Swagger | https://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv3%5D%20Контроллер%3A%20Издатели/findAll_8 |
| Query | { authorityKeyIdentifier (string), subjectKeyIdentifier (string), isActive (boolean), sortDirection (string) [опционально], sortBy (string[])[опционально], pageOffset (integer) [опционально], pageLimit (integer) [опционально] } |
| Request | |
| Response | ResponseEntity -> { CollectionResponse -> id (UUID), caId (UUID), validFrom (instant), validTo (instant), name (string), title (string), subjectKeyIdentifier (string), authorityKeyIdentifier (string), active (boolean) } |
Методы работы с группами безопасности
Заголовок раздела «Методы работы с группами безопасности»Метод поиска групп безопасности
Заголовок раздела «Метод поиска групп безопасности»| Параметр | Значение |
|---|---|
| Метод | GET API – Поиск групп безопасности |
| Описание | Метод доступен администратору |
| URL | subjects-service/api/v3/public/security-groups |
| Swagger | https://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv3%5D%20Контроллер%3A%20группы%20безопасности/findAll_3 |
| Query | { sortDirection (string) [опционально], sortBy (string[])[опционально], pageOffset (integer) [опционально], pageLimit (integer) [опционально], id (UUID[])[опционально], notId (UUID[])[опционально], resourceId (UUID) [опционально], subjectId (uuid) [опционально], search (string) [опционально], isActive (boolean) } |
| Request | |
| Response | ResponseEntity -> { CollectionResponse -> id (UUID), commonName (string), distinguishedName (string), resource: { id (UUID), commonName (string), distinguishedName (string), }, isActive (boolean), modify (instant), updated (instant), created (instant) } |
Метод получения группы безопасности по идентификатору
Заголовок раздела «Метод получения группы безопасности по идентификатору»| Параметр | Значение |
|---|---|
| Метод | GET API – Получение группы безопасности по идентификатору |
| Описание | Метод доступен администратору |
| URL | subjects-service/api/v3/public/security-groups/{id} |
| Swagger | https://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv3%5D%20Контроллер%3A%20группы%20безопасности/findById_3 |
| Query | { id (uuid) [опционально] } |
| Request | |
| Response | { id (UUID), commonName (string), distinguishedName (string), resource: { id (UUID), commonName (string), distinguishedName (string), }, isActive (boolean), modify (instant), updated (instant), created (instant) } |
Методы работы с центрами валидации
Заголовок раздела «Методы работы с центрами валидации»Метод проверки доступности центра валидации
Заголовок раздела «Метод проверки доступности центра валидации»| Параметр | Значение |
|---|---|
| Метод | PUT API – Метод проверки доступности центра валидации |
| Описание | Метод доступен только администратору |
| URL | validation-authority-service/api/v3/public/validation-authorities/{id}/heartbeat |
| Swagger | https://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv3%5D%20Контроллер%3A%20центры%20валидации/heartbeat |
| Query | { id (uuid) } |
| Request | |
| Response |
Метод регистрации центра валидации
Заголовок раздела «Метод регистрации центра валидации»| Параметр | Значение |
|---|---|
| Метод | POST API – Регистрация центра валидации |
| Описание | Метод доступен только администратору |
| URL | validation-authority-service/api/v3/public/validation-authorities/{id} |
| Swagger | https://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv3%5D%20Контроллер%3A%20центры%20валидации/create |
| Query | { id (uuid) } |
| Request | { certificateAuthorityId (UUID), instanceId (UUID), hostname (string), httpsPort (int), httpPort (int), crl: { distribution (string), publication (string), info (string) }, deltacrl: { distribution (string), publication (string), info (string) }, aia: { distribution (string), publication (string), info (string) } |
| Response | { id (uuid), certificateAuthorityId (UUID), instanceId (UUID), hostname (string), isLegacy (boolean), lastUpdate (instant), created (instant), updated (instant), } |
Метод удаления центра валидации
Заголовок раздела «Метод удаления центра валидации»| Параметр | Значение |
|---|---|
| Метод | DELETE API – Удаление центра валидации |
| Описание | Метод доступен только администратору |
| URL | validation-authority-service/api/v3/public/validation-authorities/{id} |
| Swagger | https://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv3%5D%20Контроллер%3A%20центры%20валидации/delete |
| Query | { id (uuid) } |
| Request | |
| Response |
Метод создания службы OCSP
Заголовок раздела «Метод создания службы OCSP»| Параметр | Значение |
|---|---|
| Метод | POST API – Создание службы OCSP |
| Описание | Метод доступен только администратору |
| URL | validation-authority-service/api/v3/public/validation-authorities/{vaId}/ocsp-services |
| Swagger | https://HOST/external-integration-service/swagger/swagger-ui/index.html#/Контроллер%3A%20Службы%20OCSP%20Центров%20валидации/createOcspByVaId |
| Query | { id (uuid) } |
| Request | { url (string), info (string) } |
| Response | { id (uuid), caId (uuid), vaId (uuid), url (string), info (string), vaHost (string), priority(int), children {вложенные объекты с аналогичной структурой} created (instant), updated (instant), active (boolean) } |
Метод удаления службы OCSP
Заголовок раздела «Метод удаления службы OCSP»| Параметр | Значение |
|---|---|
| Метод | DELETE API – Удаление службы OCSP |
| Описание | Метод доступен только администратору |
| URL | validation-authority-service/api/v3/public/validation-authorities/{vaId}/ocsp-services |
| Swagger | https://HOST/external-integration-service/swagger/swagger-ui/index.html#/Контроллер%3A%20Службы%20OCSP%20Центров%20валидации/deleteOcspByVaId |
| Query | { id (uuid) } |
| Request | |
| Response |
Примечания
Заголовок раздела «Примечания»-
Отличных от JaCarta®. ↩
