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

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

Aladdin Enterprise CAAPI и SDKAladdin Enterprise CA

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

Заголовок раздела «Метод идентификации и аутентификации по сертификату доступа»
ПараметрЗначение
МетодPOST API – Аутентификация с помощью сертификата
Описание
URLx509-provider-service/api/v3/public/auth/sign-in/x509
Swaggerhttps://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv3%5D%20Контроллер%3A%20Авторизации/signInByX509
Query
Request
ResponseResponseEntity -> { ItemResponse -> token (string), refresh (string) }
ПараметрЗначение
МетодPOST API – Обновление токена доступа
ОписаниеМетод доступен администратору и оператору
URLsecurity-service/api/v3/public/auth/refresh-token
Swaggerhttps://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv3%5D%20Контроллер%3A%20Авторизации/refreshToken
Query
Request
ResponseResponseEntity -> { ItemResponse -> token (string), refresh (string) }

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

Заголовок раздела «Метод обновления последней активности учётной записи»
ПараметрЗначение
МетодPUT API – Обновление последней активности учетной записи по ее идентификатору
ОписаниеМетод доступен только администратору
URLsecurity-service/api/v3/public/accounts/{accountId}/activity
Swaggerhttps://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv3%5D%20Контроллер%3A%20Учетные%20записи/updateActivity
Query{ (id – обязательный параметр) id (UUID) }
Request
Response
ПараметрЗначение
МетодPOST API – Аутентификация по Kerberos-ticket
Описание
URLsecurity-service/api/v3/public/auth/sign-in/kerberos
Swaggerhttps://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv3%5D%20Контроллер%3A%20Авторизации/kerberosSigIn
Query
Request
Response{ token (string), refresh (string) }
ПараметрЗначение
МетодPOST API – Аутентификация по логину и паролю
Описание
URLsecurity-service/api/v3/public/auth/sign-in/ldap
Swaggerhttps://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 и сообщение «Использование сторонних токенов запрещено лицензией».
URLlicense-service/api/v3/public/restrictions/third-party-tokens
Swaggerhttps://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.
URLsubjects-service/api/v3/public/subjects
Swaggerhttps://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
ResponseResponseEntity -> { 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.
URLsubjects-service/api/v3/public/subjects/{id}
Swaggerhttps://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv3%5D%20Контроллер%3A%20субъекты/findById_2
Query{ id (UUID) }
Request
ResponseResponseEntity -> { 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 – Создание и изменение субъекта
ОписаниеМетод доступен администратору и оператору при наличии полномочий на управление субъектами
URLsubjects-service/api/v3/public/subjects
Swaggerhttps://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[] } [опционально] }
ResponseResponseEntity -> { 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)
ОписаниеМетод доступен администратору и оператору при наличии полномочий на управление субъектами
URLsubjects-service/api/v3/public/subjects/pkcs10
Swaggerhttps://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[] } [опционально] }
ResponseResponseEntity -> { 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)
ОписаниеМетод доступен администратору и оператору при наличии полномочий на управление субъектами
URLsubjects-service/api/v3/public/subjects/pkcs10
Swaggerhttps://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[] } [опционально] }
ResponseResponseEntity -> { 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 – Удаление субъекта
ОписаниеМетод доступен администратору и оператору при наличии полномочий на локальную РС
URLsubjects-service/api/v3/public/subjects/{id}
Swaggerhttps://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv3%5D%20Контроллер%3A%20субъекты/deleteById
Query{ (id – обязательный параметр) id (UUID) }
Request
Response
ПараметрЗначение
МетодGET API – Поиск ID субъектов
ОписаниеМетод доступен администратору и оператору
URLsubjects-service/api/v3/public/subjects/ids
Swaggerhttps://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
ResponseResponseEntity -> { CollectionResponse -> items (UUID) }

Сопоставление идентификаторов шаблонов

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

Сопоставление идентификаторов шаблонов

Идентификатор 1.2.0Идентификатор 2.x
1000019129245a-eaad-4ebc-a2a4-8845ac0336fb
100002af3b0355-1798-4c64-98f7-a9c70407db1c
100003bf2dac0a-f05f-49dd-95b4-e50691489b6a
100004aa03e458-50cd-46b8-82cd-d5612ed3b647
100005aac2e49b-9c8e-4869-80c1-eef526ba75ab
100006059a38f5-f345-4275-b79f-e7e6cc3cbb68
10000708c66f99-218a-46ef-bdee-6a2b3b26a4f1
1000080c234243-18cf-4c05-b699-537731b2436f
10000911ec34a4-d03e-4059-92f0-9c09b08bffea
10001018d9bd4e-6f15-423f-8137-ac8416ad6874
ПараметрЗначение
МетодGET API – Поиск шаблонов
ОписаниеМетод доступен администратору и оператору. В ответе для оператора содержатся только те шаблоны, на использование которых ему предоставлены полномочия
URLtemplates-service/api/v3/public/templates
Swaggerhttps://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
ResponseResponseEntity -> { 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.
URLtemplates-service/api/v3/public/templates/{id}
Swaggerhttps://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv3%5D%20Контроллер%3A%20шаблоны/findById
Query{ id (UUID) }
Request
ResponseResponseEntity -> { 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.
URLcertificate-authority-service/api/v3/public/certificate-authorities/active
Swaggerhttps://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv3%5D%20Контроллер%3A%20Центры%20сертификации/active
Query
Request
ResponseResponseEntity -> { 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.
URLcertificate-authority-service/api/v3/public/certificate-authorities/{id}
Swaggerhttps://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv3%5D%20Контроллер%3A%20Центры%20сертификации/findById_14
Query{ id (UUID) }
Request
ResponseResponseEntity -> { 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.
URLcertificate-authority-service/api/v3/public/certificate-authorities
Swaggerhttps://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
ResponseResponseEntity -> { 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 и текстом «Пароль не соответствует регулярному выражению, указанному в шаблоне».
URLcertificate-authority-service/api/v3/public/certificates/enroll/{caId}
Swaggerhttps://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) }
ResponseResponseEntity -> { 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)
ОписаниеМетод доступен: администратору; оператору при наличии полномочий на управление сертификатами субъектов и использование шаблона, идентификаторы которых передаются во входных параметрах. Использование данного метода оператором для создания сертификатов для учетных записей запрещено.
URLcertificate-authority-service/api/v3/public/certificates/enroll/{caId}/pkcs10
Swaggerhttps://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[] } [опционально] }
ResponseResponseEntity -> { 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)
ОписаниеМетод доступен: администратору; оператору при наличии полномочий на управление сертификатами субъектов и использование шаблона, идентификаторы которых передаются во входных параметрах. Использование данного метода оператором для создания сертификатов для учетных записей запрещено.
URLcertificate-authority-service/api/v3/public/certificates/enroll/{caId}/pkcs10
Swaggerhttps://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[] } [опционально] }
ResponseResponseEntity -> { 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 в найденном сертификате. При соответствии значений будет осуществлен выпуск сертификата по запросу на сертификат из входных параметров метода, иначе запрос пользователя будет отклонен.
URLcertificate-authority-service/api/v3/public/certificates/renewal/{caId}/pkcs10
Swaggerhttps://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[] } [опционально] }
ResponseResponseEntity -> { 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 в найденном сертификате. При соответствии значений будет осуществлен выпуск сертификата по запросу на сертификат из входных параметров метода, иначе запрос пользователя будет отклонен.
URLcertificate-authority-service/api/v3/public/certificates/renewal/{caId}/pkcs10
Swaggerhttps://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[] } [опционально] }
ResponseResponseEntity -> { 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 (формат запроса на сертификат из входных параметров – multipart/form-data)

Заголовок раздела «Метод валидации запроса pkcs#10 (формат запроса на сертификат из входных параметров – multipart/form-data)»
ПараметрЗначение
МетодPOST API – Валидация запроса pkcs#10 (multipart/form-data)
ОписаниеМетод доступен: администратору; оператору при наличии полномочий на управление сертификатами субъектов и использование шаблона, идентификаторы которых передаются во входных параметрах. Использование данного метода оператором для валидации запросов на сертификат для учетных записей запрещено.
URLcertificate-authority-service/api/v3/public/certificates/validate/{caId}/pkcs10
Swaggerhttps://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[] } [опционально] }
ResponseResponseEntity -> { 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)
ОписаниеМетод доступен: администратору; оператору при наличии полномочий на управление сертификатами субъектов и использование шаблона, идентификаторы которых передаются во входных параметрах. Использование данного метода оператором для валидации запросов на сертификат для учетных записей запрещено.
URLcertificate-authority-service/api/v3/public/certificates/validate/{caId}/pkcs10
Swaggerhttps://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[] } [опционально] }
ResponseResponseEntity -> { 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.
URLcertificate-authority-service/api/v3/public/certificates
Swaggerhttps://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
ResponseResponseEntity -> { 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.
URLcertificate-authority-service/api/v3/public/certificates/{id}
Swaggerhttps://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv3%5D%20Контроллер%3A%20сертификаты/findById_13
Query{ id (UUID) }
Request
ResponseResponseEntity -> { 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.
URLcertificate-authority-service/api/v3/public/certificates/serialNumber/{serialnumber}
Swaggerhttps://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv3%5D%20Контроллер%3A%20сертификаты/getBySerialNumber
Query{ serialnumber (string) }
Request
ResponseResponseEntity -> { 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.
URLcertificate-authority-service/api/v3/public/certificates/fingerprint/{fingerprint}
Swaggerhttps://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv3%5D%20Контроллер%3A%20сертификаты/getByFingerprint_1
Query{ fingerprint (String) }
Request
ResponseResponseEntity -> { 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 – Отзыв (приостановка) сертификата по идентификатору
ОписаниеМетод доступен администратору и оператору при наличии полномочий на управление сертификатом, идентификатор которого передается во входных параметрах
URLcertificate-authority-service/api/v3/public/certificates/{id}/revoke
Swaggerhttps://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 – Активация сертификата по идентификатору
ОписаниеМетод доступен администратору и оператору при наличии полномочий на управление сертификатом, идентификатор которого передается во входных параметрах
URLcertificate-authority-service/api/v3/public/certificates/{id}/reactivate
Swaggerhttps://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv3%5D%20Контроллер%3A%20сертификаты/reactivateById
Query{ id (UUID) }
Request
Response

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

Заголовок раздела «Метод публикации сертификата в РС по идентификатору»
ПараметрЗначение
МетодPUT API – Активация сертификата по идентификатору
ОписаниеМетод доступен администратору и оператору при наличии полномочий на управление сертификатом, идентификатор которого передается во входных параметрах
URLcertificate-authority-service/api/v3/public/certificates/{id}/reactivate
Swaggerhttps://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.
URLcertificate-authority-service/api/v3/public/parse/pkcs12
Swaggerhttps://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.
URLcertificate-authority-service/api/v3/public/parse/pem
Swaggerhttps://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.
URLcertificate-authority-service/api/v3/public/parse/pkcs10
Swaggerhttps://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 – Получение сертификата по идентификатору сертификата
ОписаниеМетод доступен администратору и оператору при наличии полномочий на управление сертификатом, идентификатор которого передается во входных параметрах
URLexport-service/api/v3/public/export/certificates/{certificateId}/certificate
Swaggerhttps://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv3%5D%20Контроллер%20экспорта/findCertificateById
Query{ certificateId (UUID) }
Request
ResponseResponseEntity->byte[]

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

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

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

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

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

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

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

Заголовок раздела «Метод получения сертификата Центра сертификации по идентификатору»
ПараметрЗначение
МетодGET API – Получение сертификата по идентификатору Центра сертификации
ОписаниеМетод доступен администратору
URLexport-service/api/v3/public/export/certificate-authorities/{caId}/certificate
Swaggerhttps://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv3%5D%20Контроллер%20экспорта/findCertificateByCaId
Query{ caId (UUID) }
Request
ResponseResponseEntity->byte[]

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

Заголовок раздела «Метод получения цепочки сертификатов Центра сертификации по идентификатору»
ПараметрЗначение
МетодGET API – Получение цепочки сертификатов по идентификатору Центра сертификации
ОписаниеМетод доступен администратору
URLexport-service/api/v3/public/export/certificate-authorities/{caId}/chain
Swaggerhttps://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv3%5D%20Контроллер%20экспорта/findChainByCaId
Query{ caId (UUID) }
Request
ResponseResponseEntity->byte[]

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

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

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

Заголовок раздела «Метод получения DeltaCRL по идентификатору Центра сертификации»
ПараметрЗначение
МетодGET API – Получение DeltaCRL по идентификатору Центра сертификации
ОписаниеМетод доступен администратору и оператору
URLexport-service/api/v3/public/export/certificate-authorities/{caId}/delta-crl
Swaggerhttps://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv3%5D%20Контроллер%20экспорта/findDeltaCrlByCaId
Query{ caId (UUID) }
Request
ResponseResponseEntity->byte[]

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

Заголовок раздела «Метод генерации и публикации CRL по идентификатору Центра сертификации»
ПараметрЗначение
МетодPOST API – Генерация и публикация CRL по идентификатору Центра сертификации
ОписаниеМетод доступен администратору
URLpublisher-service/api/v3/public/certificate-authorities/{caId}/crl-configuration/generate
Swaggerhttps://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 в последующих версиях. Метод доступен администратору
URLpublisher-service/api/v3/ui/certificate-authorities/{caId}/crl-configuration/generate
Swaggerhttps://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 – Поиск ресурсных систем
ОписаниеМетод доступен администратору и оператору. В ответе для оператора содержатся только те ресурсные системы, к субъектам которых ему предоставлен доступ.
URLsubjects-service/api/v3/public/resources
Swaggerhttps://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
ResponseResponseEntity -> { 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 – Получение ресурсной системы по идентификатору
ОписаниеМетод доступен администратору и оператору при наличии доступа к субъектам РС, идентификатор которой передается во входных параметрах
URLsubjects-service/api/v3/public/resources/{id}
Swaggerhttps://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv3%5D%20Контроллер%3A%20ресурсные%20системы/findById_4
Query{ id (uuid) [опционально] }
Request
ResponseResponseEntity -> { 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 – Полная синхронизация РС
ОписаниеМетод доступен администратору и оператору при наличии полномочий на субъектов данной РС
URLldap-service/api/v3/public/resources/{resourceId}/synchronize
Swaggerhttps://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv3%5D%20Контроллер%3A%20ресурсные%20системы/synchronize
Query{ resourceId (UUID) }
Request
Response

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

Заголовок раздела «Метод поиска идентификаторов ресурсных систем»
ПараметрЗначение
МетодGET API – Поиск ID ресурсных систем
ОписаниеМетод доступен администратору и оператору
URLsubjects-service/api/v3/public/subjects/dict/resources
Swaggerhttps://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
ResponseResponseEntity -> { CollectionResponse -> id (UUID), value (string) }

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

Заголовок раздела «Метод поиска точек подключения к ресурсной системе»
ПараметрЗначение
МетодGET API – Поиск точек подключения к РС
ОписаниеМетод доступен администратору и оператору
URLldap-service/api/v3/public/connection-points
Swaggerhttps://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
ResponseResponseEntity -> { 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 – Получение точки подключения по идентификатору
ОписаниеМетод доступен администратору и оператору
URLldap-service/api/v3/public/connection-points/{id}
Swaggerhttps://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv3%5D%20Контроллер%3A%20Точки%20подключения%20ресурсных%20систем/findById_11
Query{ id (uuid) }
Request
ResponseResponseEntity -> { 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 – Частичная синхронизация точки подключения
ОписаниеМетод доступен администратору и оператору при наличии полномочий. У оператора имеется возможность выполнять синхронизацию с теми внешними ресурсными системами, к субъектам которых у него есть доступ
URLldap-service/api/v3/public/connection-points/{pointId}/synchronize
Swaggerhttps://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» (по умолчанию), доступ к методу будет разрешен без аутентификации.
URLsecurity-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» (по умолчанию), доступ к методу будет разрешен без аутентификации.
URLsecurity-service/actuator/health
Swagger
Query
Request
Response{ “status”: “<UP | DOWN | OUT_OF_SERVICE | UNKNOWN>” }

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

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

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

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

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

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

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

Заголовок раздела «Метод получения эндпоинтов для запроса информации о сервисе лицензий (license-service)»
ПараметрЗначение
МетодGET – Получение списка доступных эндпоинтов для запроса информации о сервисе лицензий
ОписаниеДоступность метода для неаутентифицированного пользователя зависит от значения параметра «actuator_authenticate» конфигурационного файла: если параметр имеет значение «true», доступ к методу будет разрешен только аутентифицированным пользователям; если параметр имеет значение «false» (по умолчанию), доступ к методу будет разрешен без аутентификации.
URLlicense-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» (по умолчанию), доступ к методу будет разрешен без аутентификации.
URLlicense-service/actuator/health
Swagger
Query
Request
Response{ “status”: “<UP | DOWN | OUT_OF_SERVICE | UNKNOWN>” }

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

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

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

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

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

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

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

Заголовок раздела «Метод получения эндпоинтов для запроса информации о сервисе журнала событий (logs-service)»
ПараметрЗначение
МетодGET – Получение списка доступных эндпоинтов для запроса информации о сервисе журнала событий
ОписаниеДоступность метода для неаутентифицированного пользователя зависит от значения параметра «actuator_authenticate» конфигурационного файла: если параметр имеет значение «true», доступ к методу будет разрешен только аутентифицированным пользователям; если параметр имеет значение «false» (по умолчанию), доступ к методу будет разрешен без аутентификации.
URLlogs-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» (по умолчанию), доступ к методу будет разрешен без аутентификации.
URLlogs-service/actuator/health
Swagger
Query
Request
Response{ “status”: “<UP | DOWN | OUT_OF_SERVICE | UNKNOWN>” }

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

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

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

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

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

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

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

Заголовок раздела «Метод получения эндпоинтов для запроса информации о сервисе настроек (settings-service)»
ПараметрЗначение
МетодGET – Получение списка доступных эндпоинтов для запроса информации о сервисе настроек
ОписаниеДоступность метода для неаутентифицированного пользователя зависит от значения параметра «actuator_authenticate» конфигурационного файла: если параметр имеет значение «true», доступ к методу будет разрешен только аутентифицированным пользователям; если параметр имеет значение «false» (по умолчанию), доступ к методу будет разрешен без аутентификации.
URLsettings-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» (по умолчанию), доступ к методу будет разрешен без аутентификации.
URLsettings-service/actuator/health
Swagger
Query
Request
Response{ “status”: “<UP | DOWN | OUT_OF_SERVICE | UNKNOWN>” }

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

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

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

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

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

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

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

Заголовок раздела «Метод получения эндпоинтов для запроса информации о сервисе хранения данных (storage-service)»
ПараметрЗначение
МетодGET – Получение списка доступных эндпоинтов для запроса информации о сервисе хранения данных
ОписаниеДоступность метода для неаутентифицированного пользователя зависит от значения параметра «actuator_authenticate» конфигурационного файла: если параметр имеет значение «true», доступ к методу будет разрешен только аутентифицированным пользователям; если параметр имеет значение «false» (по умолчанию), доступ к методу будет разрешен без аутентификации.
URLstorage-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» (по умолчанию), доступ к методу будет разрешен без аутентификации.
URLstorage-service/actuator/health
Swagger
Query
Request
Response{ “status”: “<UP | DOWN | OUT_OF_SERVICE | UNKNOWN>” }

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

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

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

Заголовок раздела «Метод получения Prometheus-метрик сервиса хранения данных (storage-service)»
ПараметрЗначение
МетодGET – Получение Prometheus-метрик сервиса хранения данных
ОписаниеДоступность метода для неаутентифицированного пользователя зависит от значения параметра «actuator_authenticate» конфигурационного файла: если параметр имеет значение «true», доступ к методу будет разрешен только аутентифицированным пользователям; если параметр имеет значение «false» (по умолчанию), доступ к методу будет разрешен без аутентификации.
URLstorage-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» (по умолчанию), доступ к методу будет разрешен без аутентификации.
URLevent-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» (по умолчанию), доступ к методу будет разрешен без аутентификации.
URLevent-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» (по умолчанию), доступ к методу будет разрешен без аутентификации.
URLevent-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» (по умолчанию), доступ к методу будет разрешен без аутентификации.
URLevent-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» (по умолчанию), доступ к методу будет разрешен без аутентификации.
URLexternal-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» (по умолчанию), доступ к методу будет разрешен без аутентификации.
URLexternal-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» (по умолчанию), доступ к методу будет разрешен без аутентификации.
URLexternal-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» (по умолчанию), доступ к методу будет разрешен без аутентификации.
URLexternal-integration-service/actuator/prometheus
Swagger
Query
Request
ResponseМетод возвращает метрики сервиса в формате Prometheus (text/plain)
ПараметрЗначение
МетодGET API – Поиск Syslog-серверов
ОписаниеМетод доступен только администратору
URLlogs-service/api/v3/public/syslog
Swaggerhttps://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv3%5D%20Контроллер%3A%20Syslog%20сервера/findAll_10
Query
Request
ResponseResponseEntity -> { CollectionResponse -> id (UUID), host (string), port (int32), protocol (enum: UDP, TCP, UNKNOWN), active (boolean) }

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

Заголовок раздела «Метод получения Syslog-сервера по идентификатору»
ПараметрЗначение
МетодGET API – Получение Syslog-сервера по идентификатору
ОписаниеМетод доступен только администратору
URLlogs-service/api/v3/public/syslog/{id}
Swaggerhttps://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) }
ПараметрЗначение
МетодPOST API – Создание Syslog-сервера
ОписаниеМетод доступен только администратору
URLlogs-service/api/v3/public/syslog
Swaggerhttps://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) }
ПараметрЗначение
МетодPUT API – Обновление Syslog-сервера
ОписаниеМетод доступен только администратору
URLlogs-service/api/v3/public/syslog/{id}
Swaggerhttps://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) }
ПараметрЗначение
МетодPATCH API – Деактивация Syslog-сервера
ОписаниеМетод доступен только администратору
URLlogs-service/api/v3/public/syslog/{id}/deactivate
Swaggerhttps://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv3%5D%20Контроллер%3A%20Syslog%20сервера/deactivate
Query{ id (uuid) }
Request
Response
ПараметрЗначение
МетодPATCH API – Активация Syslog-сервера
ОписаниеМетод доступен только администратору
URLlogs-service/api/v3/public/syslog/{id}/activate
Swaggerhttps://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv3%5D%20Контроллер%3A%20Syslog%20сервера/activate
Query{ id (uuid) }
Request
Response
ПараметрЗначение
МетодDELETE API – Удаление Syslog-сервера
ОписаниеМетод доступен только администратору
URLlogs-service/api/v3/public/syslog/{id}
Swaggerhttps://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv3%5D%20Контроллер%3A%20Syslog%20сервера/deleteById_2
Query{ id (uuid) }
Request
Response
ПараметрЗначение
МетодGET API – Поиск учетных записей
ОписаниеМетод доступен администратору
URLsecurity-service/api/v3/public/accounts
Swaggerhttps://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
ResponseResponseEntity -> { CollectionResponse -> id (UUID), login (string), principalName (string), role (enum: ADMINISTRATOR, OPERATOR, UNKNOWN), status (enum: ACTIVE, BLOCKED, UNKNOWN), created (instant), isLinked (boolean) }

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

Заголовок раздела «Метод получения учетной записи по идентификатору»
ПараметрЗначение
МетодGET API – Получение учетной записи по идентификатору
ОписаниеМетод доступен администратору, а также оператору для получения данных о его собственной учетной записи
URLsecurity-service/api/v3/public/accounts/{id}
Swaggerhttps://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv3%5D%20Контроллер%3A%20Учетные%20записи/findById_8
Query{ id (uuid) }
Request
ResponseResponseEntity -> { CollectionResponse -> id (UUID), login (string), principalName (string), role (enum: ADMINISTRATOR, OPERATOR, UNKNOWN), status (enum: ACTIVE, BLOCKED, UNKNOWN), created (instant), isLinked (boolean) }

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

Заголовок раздела «Метод получения учетной записи по отпечатку сертификата»
ПараметрЗначение
МетодGET API – Получение учетной записи по отпечатку сертификата
ОписаниеМетод доступен администратору
URLsecurity-service/api/v3/public/accounts/fingerprint/{fingerprint}
Swaggerhttps://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv3%5D%20Контроллер%3A%20Учетные%20записи/getByFingerprint
Query{ fingerprint (string) }
Request
ResponseResponseEntity -> { CollectionResponse -> id (UUID), login (string), principalName (string), role (enum: ADMINISTRATOR, OPERATOR, UNKNOWN), status (enum: ACTIVE, BLOCKED, UNKNOWN), created (instant), isLinked (boolean) }

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

Заголовок раздела «Метод получения учетной записи по идентификатору субъекта»
ПараметрЗначение
МетодGET API – Получение учетной записи по идентификатору субъекта
ОписаниеМетод доступен администратору
URLsecurity-service/api/v3/public/accounts/subject/{subjectId}
Swaggerhttps://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv3%5D%20Контроллер%3A%20Учетные%20записи/findBySubjectId
Query{ subjectId (string) }
Request
ResponseResponseEntity -> { CollectionResponse -> id (UUID), login (string), principalName (string), role (enum: ADMINISTRATOR, OPERATOR, UNKNOWN), status (enum: ACTIVE, BLOCKED, UNKNOWN), created (instant), isLinked (boolean) }
ПараметрЗначение
МетодGET API – Поиск учетных записей
ОписаниеМетод доступен администратору
URLsettings-service/api/v3/public/issuer
Swaggerhttps://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
ResponseResponseEntity -> { CollectionResponse -> id (UUID), caId (UUID), validFrom (instant), validTo (instant), name (string), title (string), subjectKeyIdentifier (string), authorityKeyIdentifier (string), active (boolean) }
ПараметрЗначение
МетодGET API – Поиск групп безопасности
ОписаниеМетод доступен администратору
URLsubjects-service/api/v3/public/security-groups
Swaggerhttps://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
ResponseResponseEntity -> { CollectionResponse -> id (UUID), commonName (string), distinguishedName (string), resource: { id (UUID), commonName (string), distinguishedName (string), }, isActive (boolean), modify (instant), updated (instant), created (instant) }

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

Заголовок раздела «Метод получения группы безопасности по идентификатору»
ПараметрЗначение
МетодGET API – Получение группы безопасности по идентификатору
ОписаниеМетод доступен администратору
URLsubjects-service/api/v3/public/security-groups/{id}
Swaggerhttps://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 – Метод проверки доступности центра валидации
ОписаниеМетод доступен только администратору
URLvalidation-authority-service/api/v3/public/validation-authorities/{id}/heartbeat
Swaggerhttps://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv3%5D%20Контроллер%3A%20центры%20валидации/heartbeat
Query{ id (uuid) }
Request
Response
ПараметрЗначение
МетодPOST API – Регистрация центра валидации
ОписаниеМетод доступен только администратору
URLvalidation-authority-service/api/v3/public/validation-authorities/{id}
Swaggerhttps://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 – Удаление центра валидации
ОписаниеМетод доступен только администратору
URLvalidation-authority-service/api/v3/public/validation-authorities/{id}
Swaggerhttps://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv3%5D%20Контроллер%3A%20центры%20валидации/delete
Query{ id (uuid) }
Request
Response
ПараметрЗначение
МетодPOST API – Создание службы OCSP
ОписаниеМетод доступен только администратору
URLvalidation-authority-service/api/v3/public/validation-authorities/{vaId}/ocsp-services
Swaggerhttps://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) }
ПараметрЗначение
МетодDELETE API – Удаление службы OCSP
ОписаниеМетод доступен только администратору
URLvalidation-authority-service/api/v3/public/validation-authorities/{vaId}/ocsp-services
Swaggerhttps://HOST/external-integration-service/swagger/swagger-ui/index.html#/Контроллер%3A%20Службы%20OCSP%20Центров%20валидации/deleteOcspByVaId
Query{ id (uuid) }
Request
Response
  1. Отличных от JaCarta®. ↩