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

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

Aladdin Enterprise CAAPI и SDKAladdin Enterprise CA

Методы публичного REST API v.4 eCA-CA

ПараметрЗначение
МетодGET API – Поиск субъектов
ОписаниеМетод доступен администратору и оператору
URLsubjects-service/api/v4/public/subjects
Swaggerhttps://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv4%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 -> { range -> count (int), offset (int), limit (int), totalPages (int), pageNumber (int) -> items -> { 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, DATEOFBIRTH, PLACEOFBIRTH, ROLE, UNKNOWN): { values (string[]), editable (boolean), } }, subjectAltName: { (enum: RFC822NAME, DNS_NAME, IPADDRESS, DIRECTORY_NAME, UNIFORM_RESOURCE_ID, REGISTERED_ID, MS_UPN, MS_GUID, KRB5PRINCIPAL, PERMANENT_IDENTIFIER, XMPP_ADDR, SRV_NAME, SUBJECT_IDENTIFICATION_METHOD, UNKNOWN): { values (string[]), editable (boolean), } }, isConnected (boolean), isBlocked (boolean), certificatesCount (integer), modify (instant, null), updated (instant), created (instant), sid (string, null) } }

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

Заголовок раздела «Метод получения субъекта по идентификатору»
ПараметрЗначение
МетодGET API – Получение субъекта по идентификатору
ОписаниеМетод доступен администратору и оператору при наличии полномочий на управление субъектом, идентификатор которого передается во входных параметрах
URLsubjects-service/api/v4/public/subjects/{id}
Swaggerhttps://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv4%5D%20Контроллер%3A%20субъекты/findById_3
Query{ id (UUID) }
Request
ResponseResponseEntity -> { 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, DATEOFBIRTH, PLACEOFBIRTH, ROLE, UNKNOWN): { values (string[]), editable (boolean), } -> subjectAltName -> (enum: RFC822NAME, DNS_NAME, IPADDRESS, DIRECTORY_NAME, UNIFORM_RESOURCE_ID, REGISTERED_ID, MS_UPN, MS_GUID, KRB5PRINCIPAL, PERMANENT_IDENTIFIER, XMPP_ADDR, SRV_NAME, SUBJECT_IDENTIFICATION_METHOD, UNKNOWN): { values (string[]), editable (boolean), } -> isConnected (boolean) -> isBlocked (boolean) -> certificatesCount (integer) -> modify (instant, null) -> updated (instant) -> created (instant) -> sid (string, null) -> }
ПараметрЗначение
МетодPUT API – Создание и изменение субъекта
ОписаниеМетод доступен администратору и оператору при наличии полномочий
URLsubjects-service/api/v4/public/subjects
Swaggerhttps://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv4%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, DATEOFBIRTH, PLACEOFBIRTH, ROLE, UNKNOWN): string[]} [опционально], subjectAltName: {(enum: RFC822NAME, DNS_NAME, IPADDRESS, DIRECTORY_NAME, UNIFORM_RESOURCE_ID, REGISTERED_ID, MS_UPN, MS_GUID, KRB5PRINCIPAL, PERMANENT_IDENTIFIER, XMPP_ADDR, SRV_NAME, SUBJECT_IDENTIFICATION_METHOD, UNKNOWN): string[]} [опционально] }
ResponseResponseEntity -> { 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, DATEOFBIRTH, PLACEOFBIRTH, ROLE, UNKNOWN): { values (string[]), editable (boolean), } -> subjectAltName -> (enum: RFC822NAME, DNS_NAME, IPADDRESS, DIRECTORY_NAME, UNIFORM_RESOURCE_ID, REGISTERED_ID, MS_UPN, MS_GUID, KRB5PRINCIPAL, PERMANENT_IDENTIFIER, XMPP_ADDR, SRV_NAME, SUBJECT_IDENTIFICATION_METHOD, UNKNOWN): { values (string[]), editable (boolean), } -> isConnected (boolean) -> isBlocked (boolean) -> certificatesCount (integer) -> modify (instant, null) -> updated (instant) -> created (instant) -> sid (string, null) -> }

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

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

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

Заголовок раздела «Метод создания и изменения субъекта на основании запроса pkcs#10 (формат запроса на сертификат из входных параметров – multipart/form-data)»
ПараметрЗначение
МетодPUT API – Создание и изменение субъекта на основании запроса pkcs#10 (multipart/form-data)
ОписаниеМетод доступен администратору и оператору при наличии полномочий
URLsubjects-service/api/v4/public/subjects/pkcs10
Swaggerhttps://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv4%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 -> { 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, DATEOFBIRTH, PLACEOFBIRTH, ROLE, UNKNOWN): { values (string[]), editable (boolean), } -> subjectAltName -> (enum: RFC822NAME, DNS_NAME, IPADDRESS, DIRECTORY_NAME, UNIFORM_RESOURCE_ID, REGISTERED_ID, MS_UPN, MS_GUID, KRB5PRINCIPAL, PERMANENT_IDENTIFIER, XMPP_ADDR, SRV_NAME, SUBJECT_IDENTIFICATION_METHOD, UNKNOWN): { values (string[]), editable (boolean), } -> isConnected (boolean) -> isBlocked (boolean) -> certificatesCount (integer) -> modify (instant, null) -> updated (instant) -> created (instant) -> sid (string, null) -> }

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

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

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

ПараметрЗначение
МетодPUT API – Создание и изменение субъекта на основании запроса pkcs#10 (application/json)
ОписаниеМетод доступен администратору и оператору при наличии полномочий
URLsubjects-service/api/v4/public/subjects/pkcs10
Swaggerhttps://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv4%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 -> { 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, DATEOFBIRTH, PLACEOFBIRTH, ROLE, UNKNOWN): { values (string[]), editable (boolean), } -> subjectAltName -> (enum: RFC822NAME, DNS_NAME, IPADDRESS, DIRECTORY_NAME, UNIFORM_RESOURCE_ID, REGISTERED_ID, MS_UPN, MS_GUID, KRB5PRINCIPAL, PERMANENT_IDENTIFIER, XMPP_ADDR, SRV_NAME, SUBJECT_IDENTIFICATION_METHOD, UNKNOWN): { values (string[]), editable (boolean), } -> isConnected (boolean) -> isBlocked (boolean) -> certificatesCount (integer) -> modify (instant, null) -> updated (instant) -> created (instant) -> sid (string, null) -> }
ПараметрЗначение
МетодGET API – Получение субъекта по Principal
ОписаниеМетод доступен администратору.Метод является технологическим и предназначен для поддержки работы Kerberos-аутентификации в eCA-RA и eCA-VA.Метод возвращает данные субъекта только при условии, что он подключен к домену. При использовании метода субъект с запрашиваемым Principal будет дополнительно синхронизирован.
URL/subjects-service/api/v4/public/subjects/principal
Swaggerhttps://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv4%5D%20Контроллер%3A%20субъекты/findByPrincipal
Request{ principal (string) [обязателен], }
ResponseResponseEntity -> { id (UUID) -> isBlocked (boolean) -> }
ПараметрЗначение
МетодGET API – Поиск шаблонов
ОписаниеМетод доступен администратору и оператору.В ответе для оператора содержатся только те шаблоны, на использование которых ему предоставлены полномочия.
URLtemplates-service/api/v4/public/templates
Swaggerhttps://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv4%5D%20Контроллер%3A%20шаблоны/findAll_5
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) [опционально], issuePkcs12Allow (boolean) [опционально], deprecated (boolean) [опционально], keyUsage (enum[]:DIGITAL_SIGNATURE, NON_REPUDIATION, KEY_ENCIPHERMENT, DATA_ENCIPHERMENT, KEY_AGREEMENT, KEY_CERT_SIGN, CRL_SIGN, ENCIPHER_ONLY, DECIPHER_ONLY, UNKNOWN) [опционально], keyUsageMatchAll (boolean) [опционально], sortDirection (string) [опционально], sortBy (string[])[опционально], pageOffset (integer) [опционально], pageLimit (integer) [опционально] }
Request
ResponseResponseEntity -> { range -> count (int), offset (int), limit (int), totalPages (int), pageNumber (int) -> items -> { id (UUID), name (string), type (enum: EMBEDDED, CLONED, IMPORTED, UNKNOWN), certificateType (enum: CERTIFICATE, ROOT_CA, SUB_CA, UNKNOWN), certificateAuthorityId (UUID, null), endEntityType (enum: USER, DEVICE, ROOT_CA, SUB_CA, UNKNOWN), certificateCount (int64), removed (boolean), updated (instant), created (instant), appendSubjectSId (boolean), pkcs12Policies: { passwordRegex (string, null), issueAllow(boolean) }, subjectValidationEnabled(boolean), deprecated (boolean) } }

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

Заголовок раздела «Метод получения шаблона по идентификатору»
ПараметрЗначение
МетодGET API – Получение шаблона по идентификатору
ОписаниеМетод доступен:администратору;оператору при наличии полномочий на использование шаблона, идентификатор которого передается во входных параметрах.
URLtemplates-service/api/v4/public/templates/{id}
Swaggerhttps://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv4%5D%20Контроллер%3A%20шаблоны/findById
Query{ id (UUID) }
Request
ResponseResponseEntity -> { id (UUID) -> name (string) -> type (enum: EMBEDDED, CLONED, IMPORTED, UNKNOWN) -> certificateType (enum: CERTIFICATE, ROOT_CA, SUB_CA, UNKNOWN) -> certificateAuthorityId (UUID, null) -> endEntityType (enum: USER, DEVICE, ROOT_CA, SUB_CA, UNKNOWN) -> removed (boolean) -> validity (int64) -> rsa -> use (boolean), minLength (int32, null), lengths (int32[]) -> ecdsa -> use (boolean), minLength (int32, null), lengths (int32[]) -> gost -> use (boolean), minLength (int32, null), 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, null), regex (string, null), alert (string, null), code (enum: CN, UID, E, EMAILADDRESS, MAIL, SN, GIVENNAME, INITIALS, SURNAME, OU, O, L, ST, DC, C, UNSTRUCTUREDADDRESS, UNSTRUCTUREDNAME, POSTALCODE, BUSINESSCATEGORY, TELEPHONENUMBER, PSEUDONYM, POSTALADDRESS, STREET, NAME, T, DN, DESCRIPTION, INN, OGRN, OGRNIP, SNILS, INNLE, DATEOFBIRTH, PLACEOFBIRTH, ROLE, UNKNOWN) } -> subjectAltName -> { index (int32), name (string), description (string), required (boolean), validation (boolean), modifiable (boolean), defaultValue (string, null), regex (string, null), alert (string, null), 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, null) } -> updated (instant) -> created (instant) -> appendSubjectSId (boolean) -> publication (boolean) -> pkcs12Policies -> passwordRegex (string, null), issueAllow (boolean) -> allowThrowaway (boolean) -> appendIssuerSignTool(boolean) -> issuerSignTool -> signTool(string, null), caTool(string, null), signToolCert(string, null), caToolCert(string, null) -> appendSubjectSignTool (boolean) -> subjectSignTool -> signTool (string, null) -> subjectValidationEnabled(boolean) -> deprecated (boolean) -> version (int64) -> }
ПараметрЗначение
МетодGET API – Получение активного ЦС
ОписаниеМетод доступен администратору и оператору.
URLcertificate-authority-service/api/v4/public/certificate-authorities/active
Swaggerhttps://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv4%5D%20Контроллер%3A%20Центры%20сертификации/active
Query{ - }
Request
ResponseResponseEntity -> { 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, DATEOFBIRTH, PLACEOFBIRTH, ROLE, 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, DATEOFBIRTH, PLACEOFBIRTH, ROLE, UNKNOWN): string[] }, subjectAltName: { (enum: RFC822NAME, DNS_NAME, IPADDRESS, DIRECTORY_NAME, UNIFORM_RESOURCE_ID, REGISTERED_ID, MS_UPN, MS_GUID, KRB5PRINCIPAL, PERMANENT_IDENTIFIER, XMPP_ADDR, SRV_NAME, SUBJECT_IDENTIFICATION_METHOD, UNKNOWN): string[] }, 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, DATEOFBIRTH, PLACEOFBIRTH, ROLE, UNKNOWN): string[] }, issuer: {…} -> certificateCount (int64) -> title (string) -> cryptographyProviders -> (enum: RSA, ECDSA, GOST_R_34_10_2012, UNKNOWN): { cryptographyProvider (enum: DEFAULT, CRYPTO_PRO, ALADDIN_JCP, UNKNOWN), isAvailable (boolean), } -> primaryCryptographyProvider -> cryptographyProvider (enum: DEFAULT, CRYPTO_PRO, ALADDIN_JCP, UNKNOWN), isAvailable (boolean), -> isAvailable (boolean) -> updated (instant) -> created (instant) -> }
ПараметрЗначение
МетодGET API – Получение ЦС по идентификатору
ОписаниеМетод доступен администратору.
URLcertificate-authority-service/api/v4/public/certificate-authorities/{id}
Swaggerhttps://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv4%5D%20Контроллер%3A%20Центры%20сертификации/findById_15
Query{ id (UUID) }
Request
ResponseResponseEntity -> { 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, DATEOFBIRTH, PLACEOFBIRTH, ROLE, 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, DATEOFBIRTH, PLACEOFBIRTH, ROLE, UNKNOWN): string[] }, subjectAltName: { (enum: RFC822NAME, DNS_NAME, IPADDRESS, DIRECTORY_NAME, UNIFORM_RESOURCE_ID, REGISTERED_ID, MS_UPN, MS_GUID, KRB5PRINCIPAL, PERMANENT_IDENTIFIER, XMPP_ADDR, SRV_NAME, SUBJECT_IDENTIFICATION_METHOD, UNKNOWN): string[] }, 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, DATEOFBIRTH, PLACEOFBIRTH, ROLE, UNKNOWN): string[] }, issuer: {…} -> certificateCount (int64) -> title (string) -> cryptographyProviders -> (enum: RSA, ECDSA, GOST_R_34_10_2012, UNKNOWN): { cryptographyProvider (enum: DEFAULT, CRYPTO_PRO, ALADDIN_JCP, UNKNOWN), isAvailable (boolean), } -> primaryCryptographyProvider -> cryptographyProvider (enum: DEFAULT, CRYPTO_PRO, ALADDIN_JCP, UNKNOWN), isAvailable (boolean), -> isAvailable (boolean) -> updated (instant) -> created (instant) -> }
ПараметрЗначение
МетодGET API – Получение ЦС
ОписаниеМетод доступен администратору.
URLcertificate-authority-service/api/v4/public/certificate-authorities
Swaggerhttps://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv4%5D%20Контроллер%3A%20Центры%20сертификации/findAll_15
Query{ status (enum[]:ACTIVE, HOLD, REVOKE, REQUEST, UNKNOWN) [опционально], type (enum[]: CERTIFICATE2Тип 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 -> { range -> count (int), offset (int), limit (int), totalPages (int), pageNumber (int) -> items -> { 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, DATEOFBIRTH, PLACEOFBIRTH, ROLE, 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, DATEOFBIRTH, PLACEOFBIRTH, ROLE, UNKNOWN): string[] }, subjectAltName: { (enum: RFC822NAME, DNS_NAME, IPADDRESS, DIRECTORY_NAME, UNIFORM_RESOURCE_ID, REGISTERED_ID, MS_UPN, MS_GUID, KRB5PRINCIPAL, PERMANENT_IDENTIFIER, XMPP_ADDR, SRV_NAME, SUBJECT_IDENTIFICATION_METHOD, UNKNOWN): string[] }, 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, DATEOFBIRTH, PLACEOFBIRTH, ROLE, UNKNOWN): string[] }, issuer: {…} }, certificateCount (int64), title (string), cryptographyProviders: { (enum: RSA, ECDSA, GOST_R_34_10_2012, UNKNOWN): { cryptographyProvider (enum: DEFAULT, CRYPTO_PRO, ALADDIN_JCP, UNKNOWN), isAvailable (boolean), } }, primaryCryptographyProvider: { cryptographyProvider (enum: DEFAULT, CRYPTO_PRO, ALADDIN_JCP, UNKNOWN), isAvailable (boolean), }, isAvailable (boolean), updated (instant), created (instant) } }

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

Заголовок раздела «Метод выпуска сертификата в контейнере pkcs#12»
ПараметрЗначение
МетодPOST API – Выпуск сертификата в контейнере pkcs#12
ОписаниеМетод доступен:администратору;оператору при наличии полномочий на управление субъектами и использование шаблона, идентификаторы которых передаются во входных параметрах.Использование данного метода оператором для создания сертификатов для учетных записей запрещено.
URLcertificate-authority-service/api/v4/public/certificates/enroll/{caId}
Swaggerhttps://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv4%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, DATEOFBIRTH, PLACEOFBIRTH, ROLE, UNKNOWN): string[]}, subjectAltName: {(enum: RFC822NAME, DNS_NAME, IPADDRESS, DIRECTORY_NAME, UNIFORM_RESOURCE_ID, REGISTERED_ID, MS_UPN, MS_GUID, KRB5PRINCIPAL, PERMANENT_IDENTIFIER, XMPP_ADDR, SRV_NAME, SUBJECT_IDENTIFICATION_METHOD, UNKNOWN): string[]}, keyBits (integer), keyAlgorithm (enum: RSA, ECDSA, GOST_R_34_10_2012, UNKNOWN), password (string) }
ResponseResponseEntity -> { 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, DATEOFBIRTH, PLACEOFBIRTH, ROLE, 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, DATEOFBIRTH, PLACEOFBIRTH, ROLE, UNKNOWN): string[] -> subjectAltName -> (enum: RFC822NAME, DNS_NAME, IPADDRESS, DIRECTORY_NAME, UNIFORM_RESOURCE_ID, REGISTERED_ID, MS_UPN, MS_GUID, KRB5PRINCIPAL, PERMANENT_IDENTIFIER, XMPP_ADDR, SRV_NAME, SUBJECT_IDENTIFICATION_METHOD, UNKNOWN): string[] -> 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/v4/public/certificates/enroll/{caId}/pkcs10
Swaggerhttps://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv4%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, DATEOFBIRTH, PLACEOFBIRTH, ROLE, UNKNOWN): string[]},[опционально] subjectAltName: {(enum: RFC822NAME, DNS_NAME, IPADDRESS, DIRECTORY_NAME, UNIFORM_RESOURCE_ID, REGISTERED_ID, MS_UPN, MS_GUID, KRB5PRINCIPAL, PERMANENT_IDENTIFIER, XMPP_ADDR, SRV_NAME, SUBJECT_IDENTIFICATION_METHOD, UNKNOWN): string[]} [опционально] }
ResponseResponseEntity -> { 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, DATEOFBIRTH, PLACEOFBIRTH, ROLE, 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, DATEOFBIRTH, PLACEOFBIRTH, ROLE, UNKNOWN): string[] -> subjectAltName -> (enum: RFC822NAME, DNS_NAME, IPADDRESS, DIRECTORY_NAME, UNIFORM_RESOURCE_ID, REGISTERED_ID, MS_UPN, MS_GUID, KRB5PRINCIPAL, PERMANENT_IDENTIFIER, XMPP_ADDR, SRV_NAME, SUBJECT_IDENTIFICATION_METHOD, UNKNOWN): string[] -> validFrom (instant) -> validTo (instant) -> }

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

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

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

ПараметрЗначение
МетодPOST API – Выпуск сертификата по запросу pkcs#10 (application/json)
ОписаниеМетод доступен:администратору;оператору при наличии полномочий на управление субъектами и использование шаблона, идентификаторы которых передаются во входных параметрах.Использование данного метода оператором для создания сертификатов для учетных записей запрещено.
URLcertificate-authority-service/api/v4/public/certificates/enroll/{caId}/pkcs10
Swaggerhttps://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv4%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, DATEOFBIRTH, PLACEOFBIRTH, ROLE, UNKNOWN): string[]},[опционально] subjectAltName: {(enum: RFC822NAME, DNS_NAME, IPADDRESS, DIRECTORY_NAME, UNIFORM_RESOURCE_ID, REGISTERED_ID, MS_UPN, MS_GUID, KRB5PRINCIPAL, PERMANENT_IDENTIFIER, XMPP_ADDR, SRV_NAME, SUBJECT_IDENTIFICATION_METHOD, UNKNOWN): string[]} [опционально] }
ResponseResponseEntity -> { 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, DATEOFBIRTH, PLACEOFBIRTH, ROLE, 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, DATEOFBIRTH, PLACEOFBIRTH, ROLE, UNKNOWN): string[] -> subjectAltName -> (enum: RFC822NAME, DNS_NAME, IPADDRESS, DIRECTORY_NAME, UNIFORM_RESOURCE_ID, REGISTERED_ID, MS_UPN, MS_GUID, KRB5PRINCIPAL, PERMANENT_IDENTIFIER, XMPP_ADDR, SRV_NAME, SUBJECT_IDENTIFICATION_METHOD, UNKNOWN): string[] -> 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)
ОписаниеМетод доступен:администратору;оператору при наличии полномочий на управление субъектами и использование шаблона, идентификаторы которых передаются во входных параметрах.Использование данного метода оператором для создания сертификатов для учетных записей запрещено. Метод позволяет перевыпустить сертификат по запросу, по которому ранее уже был выпущен сертификат.При использовании метода проверяется наличие в базе данных программы выпущенного сертификата, имеющего «Subject Key Identifier» аналогичный указанному в запросе на сертификат из входных параметров. Если такой сертификат не будет найден, данный метод осуществит выпуск нового сертификата по запросу аналогично методу выпуска сертификата по запросу.Если сертификат с аналогичным указанному в запросе на сертификат «Subject Key Identifier» будет найден, программа:1) проверит статус найденного сертификата. Если срок действия данного сертификата истек, запрос пользователя будет отклонен.2) проверит соответствие значений в полях SDN и SAN, указанных в запросе (или во входных параметрах метода), значениям в полях SDN и SAN в найденном сертификате. При соответствии значений будет осуществлен выпуск сертификата по запросу на сертификат из входных параметров метода, иначе запрос пользователя будет отклонен.
URLcertificate-authority-service/api/v4/public/certificates/renewal/{caId}/pkcs10
Swaggerhttps://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv4%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, DATEOFBIRTH, PLACEOFBIRTH, ROLE, UNKNOWN): string[]},[опционально] subjectAltName: {(enum: RFC822NAME, DNS_NAME, IPADDRESS, DIRECTORY_NAME, UNIFORM_RESOURCE_ID, REGISTERED_ID, MS_UPN, MS_GUID, KRB5PRINCIPAL, PERMANENT_IDENTIFIER, XMPP_ADDR, SRV_NAME, SUBJECT_IDENTIFICATION_METHOD, UNKNOWN): string[]} [опционально] }
ResponseResponseEntity -> { 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, DATEOFBIRTH, PLACEOFBIRTH, ROLE, 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, DATEOFBIRTH, PLACEOFBIRTH, ROLE, UNKNOWN): string[] -> subjectAltName -> (enum: RFC822NAME, DNS_NAME, IPADDRESS, DIRECTORY_NAME, UNIFORM_RESOURCE_ID, REGISTERED_ID, MS_UPN, MS_GUID, KRB5PRINCIPAL, PERMANENT_IDENTIFIER, XMPP_ADDR, SRV_NAME, SUBJECT_IDENTIFICATION_METHOD, UNKNOWN): string[] -> validFrom (instant) -> validTo (instant) -> }

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

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

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

ПараметрЗначение
МетодPOST API – Перевыпуск сертификата в по запросу pkcs#10 (application/json)
ОписаниеМетод доступен:администратору;оператору при наличии полномочий на управление субъектами и использование шаблона, идентификаторы которых передаются во входных параметрах.Использование данного метода оператором для создания сертификатов для учетных записей запрещено. Метод позволяет перевыпустить сертификат по запросу, по которому ранее уже был выпущен сертификат.При использовании метода проверяется наличие в базе данных программы выпущенного сертификата, имеющего «Subject Key Identifier» аналогичный указанному в запросе на сертификат из входных параметров. Если такой сертификат не будет найден, данный метод осуществит выпуск нового сертификата по запросу аналогично методу выпуска сертификата по запросу.Если сертификат с аналогичным указанному в запросе на сертификат «Subject Key Identifier» будет найден, программа:1) проверит статус найденного сертификата. Если срок действия данного сертификата истек, запрос пользователя будет отклонен.2) проверит соответствие значений в полях SDN и SAN, указанных в запросе (или во входных параметрах метода), значениям в полях SDN и SAN в найденном сертификате. При соответствии значений будет осуществлен выпуск сертификата по запросу на сертификат из входных параметров метода, иначе запрос пользователя будет отклонен.
URLcertificate-authority-service/api/v4/public/certificates/renewal/{caId}/pkcs10
Swaggerhttps://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv4%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, DATEOFBIRTH, PLACEOFBIRTH, ROLE, UNKNOWN): string[]},[опционально] subjectAltName: {(enum: RFC822NAME, DNS_NAME, IPADDRESS, DIRECTORY_NAME, UNIFORM_RESOURCE_ID, REGISTERED_ID, MS_UPN, MS_GUID, KRB5PRINCIPAL, PERMANENT_IDENTIFIER, XMPP_ADDR, SRV_NAME, SUBJECT_IDENTIFICATION_METHOD, UNKNOWN): string[]} [опционально] }
ResponseResponseEntity -> { 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, DATEOFBIRTH, PLACEOFBIRTH, ROLE, 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, DATEOFBIRTH, PLACEOFBIRTH, ROLE, UNKNOWN): string[] -> subjectAltName -> (enum: RFC822NAME, DNS_NAME, IPADDRESS, DIRECTORY_NAME, UNIFORM_RESOURCE_ID, REGISTERED_ID, MS_UPN, MS_GUID, KRB5PRINCIPAL, PERMANENT_IDENTIFIER, XMPP_ADDR, SRV_NAME, SUBJECT_IDENTIFICATION_METHOD, UNKNOWN): string[] -> validFrom (instant) -> validTo (instant) -> }

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

Заголовок раздела «Метод валидации запроса pkcs#10 (формат запроса на сертификат из входных параметров – multipart/form-data)»
ПараметрЗначение
МетодPOST API – Валидация запроса pkcs#10 (multipart/form-data)
ОписаниеМетод доступен:администратору;оператору при наличии полномочий на управление субъектами и использование шаблона, идентификаторы которых передаются во входных параметрах.Использование данного метода оператором для валидации запросов на сертификат для учетных записей запрещено.
URLcertificate-authority-service/api/v4/public/certificates/validate/{caId}/pkcs10
Swaggerhttps://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv4%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, DATEOFBIRTH, PLACEOFBIRTH, ROLE, UNKNOWN): string[]},[опционально] subjectAltName: {(enum: RFC822NAME, DNS_NAME, IPADDRESS, DIRECTORY_NAME, UNIFORM_RESOURCE_ID, REGISTERED_ID, MS_UPN, MS_GUID, KRB5PRINCIPAL, PERMANENT_IDENTIFIER, XMPP_ADDR, SRV_NAME, SUBJECT_IDENTIFICATION_METHOD, UNKNOWN): string[]} [опционально] }
ResponseResponseEntity -> { 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, DATEOFBIRTH, PLACEOFBIRTH, ROLE, UNKNOWN), fieldValue (string), required (boolean), additional (boolean), valid (boolean), message (string, null) } -> 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, null) } -> }

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

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

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

ПараметрЗначение
МетодPOST API – Валидация запроса pkcs#10 (application/json)
ОписаниеМетод доступен:администратору;оператору при наличии полномочий на управление субъектами и использование шаблона, идентификаторы которых передаются во входных параметрах.Использование данного метода оператором для валидации запросов на сертификат для учетных записей запрещено.
URLcertificate-authority-service/api/v4/public/certificates/validate/{caId}/pkcs10
Swaggerhttps://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv4%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, DATEOFBIRTH, PLACEOFBIRTH, ROLE, UNKNOWN): string[]},[опционально] subjectAltName: {(enum: RFC822NAME, DNS_NAME, IPADDRESS, DIRECTORY_NAME, UNIFORM_RESOURCE_ID, REGISTERED_ID, MS_UPN, MS_GUID, KRB5PRINCIPAL, PERMANENT_IDENTIFIER, XMPP_ADDR, SRV_NAME, SUBJECT_IDENTIFICATION_METHOD, UNKNOWN): string[]} [опционально] }
ResponseResponseEntity -> { 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, DATEOFBIRTH, PLACEOFBIRTH, ROLE, UNKNOWN), fieldValue (string), required (boolean), additional (boolean), valid (boolean), message (string, null) } -> 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, null) } -> }
ПараметрЗначение
МетодGET API – Поиск сертификатов
ОписаниеМетод доступен администратору и оператору
URLcertificate-authority-service/api/v4/public/certificates
Swaggerhttps://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv4%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 -> { range -> count (int), offset (int), limit (int), totalPages (int), pageNumber (int) -> items -> { id (UUID), issuerId (UUID), issuerFingerprint (string), serialnumber (string), fingerprint (string), issuerDN: { (enum: CN, UID, E, EMAILADDRESS, MAIL, SN, GIVENNAME, INITIALS, SURNAME, OU, O, L, ST, DC, C, UNSTRUCTUREDADDRESS, UNSTRUCTUREDNAME, POSTALCODE, BUSINESSCATEGORY, TELEPHONENUMBER, PSEUDONYM, POSTALADDRESS, STREET, NAME, T, DN, DESCRIPTION, INN, OGRN, OGRNIP, SNILS, INNLE, DATEOFBIRTH, PLACEOFBIRTH, ROLE, UNKNOWN): string[] }, subjectDN: { (enum: CN, UID, E, EMAILADDRESS, MAIL, SN, GIVENNAME, INITIALS, SURNAME, OU, O, L, ST, DC, C, UNSTRUCTUREDADDRESS, UNSTRUCTUREDNAME, POSTALCODE, BUSINESSCATEGORY, TELEPHONENUMBER, PSEUDONYM, POSTALADDRESS, STREET, NAME, T, DN, DESCRIPTION, INN, OGRN, OGRNIP, SNILS, INNLE, DATEOFBIRTH, PLACEOFBIRTH, ROLE, UNKNOWN): string[] }, 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 – Получение сертификата по идентификатору
ОписаниеМетод доступен администратору и оператору при наличии полномочий
URLcertificate-authority-service/api/v4/public/certificates/{id}
Swaggerhttps://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv4%5D%20Контроллер%3A%20сертификаты/findById_14
Query{ id (UUID) }
Request
ResponseResponseEntity -> { 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, DATEOFBIRTH, PLACEOFBIRTH, ROLE, 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, DATEOFBIRTH, PLACEOFBIRTH, ROLE, 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, DATEOFBIRTH, PLACEOFBIRTH, ROLE, UNKNOWN): string[] -> subjectAltName -> (enum: RFC822NAME, DNS_NAME, IPADDRESS, DIRECTORY_NAME, UNIFORM_RESOURCE_ID, REGISTERED_ID, MS_UPN, MS_GUID, KRB5PRINCIPAL, PERMANENT_IDENTIFIER, XMPP_ADDR, SRV_NAME, SUBJECT_IDENTIFICATION_METHOD, UNKNOWN): string[] -> 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, null) -> subjectId (uuid, null) -> created (instant) -> updated (instant) -> }

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

Заголовок раздела «Метод получения сертификата по серийному номеру»
ПараметрЗначение
МетодGET API – Получение сертификата по его серийному номеру
ОписаниеМетод доступен администратору и оператору при наличии полномочий
URLcertificate-authority-service/api/v4/public/certificates/serialNumber/{serialnumber}
Swaggerhttps://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv4%5D%20Контроллер%3A%20сертификаты/getBySerialNumber
Query{ serialnumber (string) }
Request
ResponseResponseEntity -> { 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, DATEOFBIRTH, PLACEOFBIRTH, ROLE, 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, DATEOFBIRTH, PLACEOFBIRTH, ROLE, 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, DATEOFBIRTH, PLACEOFBIRTH, ROLE, UNKNOWN): string[] -> subjectAltName -> (enum: RFC822NAME, DNS_NAME, IPADDRESS, DIRECTORY_NAME, UNIFORM_RESOURCE_ID, REGISTERED_ID, MS_UPN, MS_GUID, KRB5PRINCIPAL, PERMANENT_IDENTIFIER, XMPP_ADDR, SRV_NAME, SUBJECT_IDENTIFICATION_METHOD, UNKNOWN): string[] -> 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, null) -> subjectId (uuid, null) -> created (instant) -> updated (instant) -> }

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

Заголовок раздела «Метод получения сертификата по его отпечатку»
ПараметрЗначение
МетодGET API – Получение сертификата по его отпечатку
ОписаниеМетод доступен администратору и оператору при наличии полномочий
URLcertificate-authority-service/api/v4/public/certificates/fingerprint/{fingerprint}
Swaggerhttps://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv4%5D%20Контроллер%3A%20сертификаты/getByFingerprint_1
Query{ fingerprint (String) }
Request
ResponseResponseEntity -> { 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, DATEOFBIRTH, PLACEOFBIRTH, ROLE, 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, DATEOFBIRTH, PLACEOFBIRTH, ROLE, 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, DATEOFBIRTH, PLACEOFBIRTH, ROLE, UNKNOWN): string[] -> subjectAltName -> (enum: RFC822NAME, DNS_NAME, IPADDRESS, DIRECTORY_NAME, UNIFORM_RESOURCE_ID, REGISTERED_ID, MS_UPN, MS_GUID, KRB5PRINCIPAL, PERMANENT_IDENTIFIER, XMPP_ADDR, SRV_NAME, SUBJECT_IDENTIFICATION_METHOD, UNKNOWN): string[] -> 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, null) -> subjectId (uuid, null) -> created (instant) -> updated (instant) -> }

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

Заголовок раздела «Метод расшифровки контейнера сертификата»
ПараметрЗначение
МетодPOST API – Расшифровка контейнера сертификата
ОписаниеМетод доступен администратору
URLcertificate-authority-service/api/v4/public/parse/pkcs12
Swaggerhttps://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv4%5D%20Контроллер%3A%20контейнеры%20сертификатов/parse
Query
Request{ container: { contentType (string) [опционально], fileName (string) [опционально], data (string:binary) password(string), templateId (UUID) }
ResponseResponseEntity -> { 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, DATEOFBIRTH, PLACEOFBIRTH, ROLE, 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, DATEOFBIRTH, PLACEOFBIRTH, ROLE, UNKNOWN): string[] -> subjectAltName -> (enum: RFC822NAME, DNS_NAME, IPADDRESS, DIRECTORY_NAME, UNIFORM_RESOURCE_ID, REGISTERED_ID, MS_UPN, MS_GUID, KRB5PRINCIPAL, PERMANENT_IDENTIFIER, XMPP_ADDR, SRV_NAME, SUBJECT_IDENTIFICATION_METHOD, UNKNOWN): string[] -> 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 – Расшифровка сертификата
ОписаниеМетод доступен администратору
URLcertificate-authority-service/api/v4/public/parse/pem
Swaggerhttps://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv4%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, DATEOFBIRTH, PLACEOFBIRTH, ROLE, 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, DATEOFBIRTH, PLACEOFBIRTH, ROLE, 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, DATEOFBIRTH, PLACEOFBIRTH, ROLE, UNKNOWN): string[] subjectAltName: { (enum: RFC822NAME, DNS_NAME, IPADDRESS, DIRECTORY_NAME, UNIFORM_RESOURCE_ID, REGISTERED_ID, MS_UPN, MS_GUID, KRB5PRINCIPAL, PERMANENT_IDENTIFIER, XMPP_ADDR, SRV_NAME, SUBJECT_IDENTIFICATION_METHOD, UNKNOWN): string[] 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, null), subjectId (uuid, null), created (instant) updated (instant), }
ПараметрЗначение
МетодPOST API – Расшифровка запроса на сертификат
ОписаниеМетод доступен администратору
URLcertificate-authority-service/api/v4/public/parse/pkcs10
Swaggerhttps://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv4%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, DATEOFBIRTH, PLACEOFBIRTH, ROLE, UNKNOWN): string[]},[опционально] subjectAltName: {(enum: RFC822NAME, DNS_NAME, IPADDRESS, DIRECTORY_NAME, UNIFORM_RESOURCE_ID, REGISTERED_ID, MS_UPN, MS_GUID, KRB5PRINCIPAL, PERMANENT_IDENTIFIER, XMPP_ADDR, SRV_NAME, SUBJECT_IDENTIFICATION_METHOD, UNKNOWN): string[]} [опционально] }
ResponseResponseEntity -> { 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, DATEOFBIRTH, PLACEOFBIRTH, ROLE, UNKNOWN): string[] -> subjectAltName -> (enum: RFC822NAME, DNS_NAME, IPADDRESS, DIRECTORY_NAME, UNIFORM_RESOURCE_ID, REGISTERED_ID, MS_UPN, MS_GUID, KRB5PRINCIPAL, PERMANENT_IDENTIFIER, XMPP_ADDR, SRV_NAME, SUBJECT_IDENTIFICATION_METHOD, UNKNOWN): string[] -> keyAlgorithm (enum: RSA, ECDSA, GOST_R_34_10_2012, UNKNOWN) -> keyBits (int32) -> subjectKeyIdentifier (string) -> }

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

Заголовок раздела «Метод выпуска короткоживущего (short-lived, throwaway) сертификата в контейнере PKCS#12»
ПараметрЗначение
МетодPOST API – Выпуск короткоживущего (short-lived, throwaway) сертификата в контейнере PKCS#12
ОписаниеМетод доступен:администратору;оператору при наличии полномочий на использование шаблона, идентификатор которого передается во входных параметрах.Выпуск короткоживущего (short-lived, throwaway) сертификата с помощью данного метода будет выполняться успешно только при соблюдении следующих условий:выпуск данного вида сертификатов разрешен в соответствии с параметрами лицензии, примененной в ПО eCA-CA. В противном случае будет возвращено сообщение об ошибке с кодом 403 и текстом «Выпуск короткоживущих (short-lived, throwaway) сертификатов недоступен в соответствии с параметрами лицензии»;для выпуска используется шаблон с включенной опцией «Короткоживущий (short-lived, throwaway) сертификат». В противном случае будет возвращено сообщение об ошибке с кодом 400 и текстом «Выпуск короткоживущих (short-lived, throwaway) сертификатов недоступен по данному шаблону»;для выпуска используется шаблон с включенной опцией «Выпуск сертификатов с закрытым ключом (PKCS#12)», иначе метод вернет сообщение об ошибке с кодом 400 и текстом «Выпуск сертификатов с закрытым ключом (PKCS#12) недоступен по данному шаблону».указываемый во входных параметрах пароль от контейнера соответствует требованиям регулярного выражения по шаблону, иначе метод вернет сообщение об ошибке с кодом 400 и текстом «Пароль не соответствует регулярному выражению, указанному в шаблоне».Успешно выпущенный с использованием данного метода сертификат:не будет сохранен в базе данных ПО eCA-CA;не будет содержать записей о точках распространения CRL, Delta CRL и службах OCSP, однако может содержать записи о точках AIA;не будет иметь владельца-субъекта, и, как следствие, не повлияет на лицензируемое количество субъектов с действующими сертификатами.
URLcertificate-authority-service/api/v4/public/certificates/enroll/{caId}/throwaway
Query{ caId (UUID) }
Request{ templateId (UUID), subjectDN: {(enum: CN, UID, E, EMAILADDRESS, MAIL, SN, GIVENNAME, INITIALS, SURNAME, OU, O, L, ST, DC, C, UNSTRUCTUREDADDRESS, UNSTRUCTUREDNAME, POSTALCODE, BUSINESSCATEGORY, TELEPHONENUMBER, PSEUDONYM, POSTALADDRESS, STREET, NAME, T, DN, DESCRIPTION, INN, OGRN, OGRNIP, SNILS, INNLE, DATEOFBIRTH, PLACEOFBIRTH, ROLE, UNKNOWN): string[]}, subjectAltName: {(enum: RFC822NAME, DNS_NAME, IPADDRESS, DIRECTORY_NAME, UNIFORM_RESOURCE_ID, REGISTERED_ID, MS_UPN, MS_GUID, KRB5PRINCIPAL, PERMANENT_IDENTIFIER, XMPP_ADDR, SRV_NAME, SUBJECT_IDENTIFICATION_METHOD, UNKNOWN): string[]}, keyBits (integer), keyAlgorithm (enum: RSA, ECDSA, GOST_R_34_10_2012, UNKNOWN), password (string) }
Response

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

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

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

Заголовок раздела «Выпуск короткоживущего (short-lived, throwaway) сертификата на основании запроса PKCS#10 (формат запроса на сертификат из входных параметров – multipart/form-data)»
ПараметрЗначение
МетодPOST API – Выпуск короткоживущего (short-lived, throwaway) сертификата на основании запроса PKCS#10
ОписаниеМетод доступен:администратору;оператору при наличии полномочий на использование шаблона, идентификатор которого передается во входных параметрах.Выпуск короткоживущего (short-lived, throwaway) сертификата с помощью данного метода будет выполняться успешно только при соблюдении следующих условий:выпуск данного вида сертификатов разрешен в соответствии с параметрами лицензии, примененной в ПО eCA-CA. В противном случае будет возвращено сообщение об ошибке с кодом 403 и текстом «Выпуск короткоживущих (short-lived, throwaway) сертификатов недоступен в соответствии с параметрами лицензии»;для выпуска используется шаблон с включенной опцией «Короткоживущий (short-lived, throwaway) сертификат». В противном случае будет возвращено сообщение об ошибке с кодом 400 и текстом «Выпуск короткоживущих (short-lived, throwaway) сертификатов недоступен по данному шаблону».Успешно выпущенный с использованием данного метода сертификат:не будет сохранен в базе данных ПО eCA-CA;не будет содержать записей о точках распространения CRL, Delta CRL и службах OCSP, однако может содержать записи о точках AIA;не будет иметь владельца-субъекта, и, как следствие, не повлияет на лицензируемое количество субъектов с действующими сертификатами.
URLcertificate-authority-service/api/v4/public/certificates/enroll/{caId}/pkcs10/throwaway
Query{ caId (UUID) }
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, DATEOFBIRTH, PLACEOFBIRTH, ROLE, UNKNOWN): string[]},[опционально] subjectAltName: {(enum: RFC822NAME, DNS_NAME, IPADDRESS, DIRECTORY_NAME, UNIFORM_RESOURCE_ID, REGISTERED_ID, MS_UPN, MS_GUID, KRB5PRINCIPAL, PERMANENT_IDENTIFIER, XMPP_ADDR, SRV_NAME, SUBJECT_IDENTIFICATION_METHOD, UNKNOWN): string[]} [опционально] }
Response

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

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

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

ПараметрЗначение
МетодPOST API – Выпуск короткоживущего (short-lived, throwaway) сертификата на основании запроса PKCS#10
ОписаниеМетод доступен:администратору;оператору при наличии полномочий на использование шаблона, идентификатор которого передается во входных параметрах.Выпуск короткоживущего (short-lived, throwaway) сертификата с помощью данного метода будет выполняться успешно только при соблюдении следующих условий:выпуск данного вида сертификатов разрешен в соответствии с параметрами лицензии, примененной в ПО eCA-CA. В противном случае будет возвращено сообщение об ошибке с кодом 403 и текстом «Выпуск короткоживущих (short-lived, throwaway) сертификатов недоступен в соответствии с параметрами лицензии»;для выпуска используется шаблон с включенной опцией «Короткоживущий (short-lived, throwaway) сертификат». В противном случае будет возвращено сообщение об ошибке с кодом 400 и текстом «Выпуск короткоживущих (short-lived, throwaway) сертификатов недоступен по данному шаблону».Успешно выпущенный с использованием данного метода сертификат:не будет сохранен в базе данных ПО eCA-CA;не будет содержать записей о точках распространения CRL, Delta CRL и службах OCSP, однако может содержать записи о точках AIA;не будет иметь владельца-субъекта, и, как следствие, не повлияет на лицензируемое количество субъектов с действующими сертификатами.
URLcertificate-authority-service/api/v4/public/certificates/enroll/{caId}/pkcs10/throwaway
Query{ caId (UUID) }
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, DATEOFBIRTH, PLACEOFBIRTH, ROLE, UNKNOWN): string[]},[опционально] subjectAltName: {(enum: RFC822NAME, DNS_NAME, IPADDRESS, DIRECTORY_NAME, UNIFORM_RESOURCE_ID, REGISTERED_ID, MS_UPN, MS_GUID, KRB5PRINCIPAL, PERMANENT_IDENTIFIER, XMPP_ADDR, SRV_NAME, SUBJECT_IDENTIFICATION_METHOD, UNKNOWN): string[]} [опционально] }
Response
ПараметрЗначение
МетодGET API – Поиск точек подключения к РС
ОписаниеМетод доступен администратору и оператору
URLldap-service/api/v4/public/connection-points
Swaggerhttps://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv4%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 -> { range -> count (int), offset (int), limit (int), totalPages (int), pageNumber (int) -> items -> { id (UUID), title (string), domainType(enum: SAMBA_DC, MS_AD, RED_ADM, FREE_IPA, ALD_PRO, ALT_DOMAIN, ROSA_DD, UNKNOWN), connectionAddress (string), useTls (boolean), baseDn(string), username (string), status (string) resourceId (UUID), updated (instant), created (instant), inQueue (boolean) } }

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

Заголовок раздела «Метод получения точки подключения по идентификатору»
ПараметрЗначение
МетодGET API – Получение точки подключения по идентификатору
ОписаниеМетод доступен администратору и оператору
URLldap-service/api/v4/public/connection-points/{id}
Swaggerhttps://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv4%5D%20Контроллер%3A%20Точки%20подключения%20ресурсных%20систем/findById_11
Query{ id (uuid) }
Request
ResponseResponseEntity -> { id (UUID) -> title (string) -> domainType(enum: SAMBA_DC, MS_AD, RED_ADM, FREE_IPA, ALD_PRO, ALT_DOMAIN, ROSA_DD, UNKNOWN) -> connectionAddress (string) -> useTls (boolean) -> baseDn(string) -> username (string) -> status (string) -> resourceId (UUID) -> updated (instant) -> created (instant) -> inQueue (boolean) -> }

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

Заголовок раздела «Метод частичной синхронизации точки подключения»
ПараметрЗначение
МетодPUT API – Частичная синхронизация точки подключения
ОписаниеМетод доступен администратору и оператору при наличии полномочий. У оператора имеется возможность выполнять синхронизацию с теми внешними ресурсными системами, к субъектам которых у него есть доступ.
URLldap-service/api/v4/public/connection-points/{pointId}/synchronize
Swaggerhttps://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv4%5D%20Контроллер%3A%20Точки%20подключения%20ресурсных%20систем/synchronize
Query{ pointId (UUID) }
Request
Response
ПараметрЗначение
МетодGET API – Поиск Syslog-серверов
ОписаниеМетод доступен только администратору
URLlogs-service/api/v4/public/syslog
Swaggerhttps://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv4%5D%20Контроллер%3A%20Syslog%20сервера/findAll_3
Query{ - }
Request
ResponseResponseEntity -> { range -> count (int), offset (int), limit (int), totalPages (int), pageNumber (int) -> items -> { id (UUID), host (string), port (int32), protocol (enum: UDP, TCP, TCP_TLS, UNKNOWN), active (boolean) } }

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

Заголовок раздела «Метод получения Syslog-сервера по идентификатору»
ПараметрЗначение
МетодGET API – Получение Syslog-сервера по идентификатору
ОписаниеМетод доступен только администратору
URLlogs-service/api/v4/public/syslog/{id}
Swaggerhttps://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv4%5D%20Контроллер%3A%20Syslog%20сервера/findById
Query{ id (uuid) }
Request
ResponseResponseEntity -> { id (UUID) -> host (string) -> port (int32) -> protocol (enum: UDP, TCP, TCP_TLS, UNKNOWN) -> active (boolean) -> }
ПараметрЗначение
МетодPOST API – Создание Syslog-сервера
ОписаниеМетод доступен только администратору
URLlogs-service/api/v4/public/syslog
Swaggerhttps://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv4%5D%20Контроллер%3A%20Syslog%20сервера/create_1
Query{ - }
Request{ host (string), port (int32), protocol (enum: UDP, TCP, TCP_TLS, UNKNOWN) }
ResponseResponseEntity -> { id (UUID) -> host (string) -> port (int32) -> protocol (enum: UDP, TCP, TCP_TLS, UNKNOWN) -> active (boolean) -> }
ПараметрЗначение
МетодPUT API – Обновление Syslog-сервера
ОписаниеМетод доступен только администратору
URLlogs-service/api/v4/public/syslog/{id}
Swaggerhttps://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv4%5D%20Контроллер%3A%20Syslog%20сервера/updateById
Query{ id (uuid) }
Request{ host (string), port (int32), protocol (enum: UDP, TCP, TCP_TLS, UNKNOWN) }
ResponseResponseEntity -> { id (UUID) -> host (string) -> port (int32) -> protocol (enum: UDP, TCP, TCP_TLS, UNKNOWN) -> active (boolean) -> }
ПараметрЗначение
МетодPATCH API – Деактивация Syslog-сервера
ОписаниеМетод доступен только администратору
URLlogs-service/api/v4/public/syslog/{id}/deactivate
Swaggerhttps://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv4%5D%20Контроллер%3A%20Syslog%20сервера/deactivate
Query{ id (uuid) }
Request
Response
ПараметрЗначение
МетодPATCH API – Активация Syslog-сервера
ОписаниеМетод доступен только администратору
URLlogs-service/api/v4/public/syslog/{id}/activate
Swaggerhttps://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv4%5D%20Контроллер%3A%20Syslog%20сервера/activate
Query{ id (uuid) }
Request
Response
ПараметрЗначение
МетодDELETE API – Удаление Syslog-сервера
ОписаниеМетод доступен только администратору
URLlogs-service/api/v4/public/syslog/{id}
Swaggerhttps://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv4%5D%20Контроллер%3A%20Syslog%20сервера/deleteById
Query{ id (uuid) }
Request
Response

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

Заголовок раздела «Метод получения контейнера PFX по идентификатору сертификата»
ПараметрЗначение
МетодGET API – Получение контейнера PFX по идентификатору сертификата
ОписаниеМетод доступен администратору и оператору при наличии полномочий на управление сертификатом, идентификатор которого передается во входных параметрах
URL/export-service/api/v4/public/export/certificates/{certificateId}/pfx
Swaggerhttps://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv4%5D%20Контроллер%20экспорта/findPfxById
Query{ certificateId (UUID) }
Request
Response

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

Заголовок раздела «Метод получения сертификата по идентификатору сертификата»
ПараметрЗначение
МетодGET API – Получение сертификата по идентификатору сертификата
ОписаниеМетод доступен администратору и оператору при наличии полномочий на управление сертификатом, идентификатор которого передается во входных параметрах.
URL/export-service/api/v4/public/export/certificates/{certificateId}/certificate
Swaggerhttps://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv4%5D%20Контроллер%20экспорта/findCertificateById
Query{ fileEncod (enum: PEM, DER) [опционально] }
Request
Response

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

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

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

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

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

Заголовок раздела «Метод получения сертификата Центра сертификации по идентификатору Центра сертификации»
ПараметрЗначение
МетодGET API – Получение сертификата по идентификатору Центра сертификации
ОписаниеМетод доступен администратору
URL/export-service/api/v4/public/export/certificate-authorities/{caId}/certificate
Swaggerhttps://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv4%5D%20Контроллер%20экспорта/findCertificateByCaId
Query{ fileEncod (enum: PEM, DER) [опционально] }
Request
Response

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

Заголовок раздела «Метод получения цепочки сертификатов Центра сертификации по идентификатору Центра сертификации»
ПараметрЗначение
МетодGET API – Получение цепочки сертификатов по идентификатору Центра сертификации
ОписаниеМетод доступен администратору
URL/export-service/api/v4/public/export/certificate-authorities/{caId}/chain
Swaggerhttps://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv4%5D%20Контроллер%20экспорта/findChainByCaId
Query{ fileEncod (enum: PEM, DER) [опционально] }
Request
Response

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

Заголовок раздела «Метод получения CRL по идентификатору Центра сертификации»
ПараметрЗначение
МетодGET API – Получение CRL по идентификатору Центра сертификации
ОписаниеМетод доступен администратору и оператору
URL/export-service/api/v4/public/export/certificate-authorities/{caId}/crl
Swaggerhttps://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv4%5D%20Контроллер%20экспорта/findCrlByCaId
Query{ fileEncod (enum: PEM, DER) [опционально] }
Request
Response

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

Заголовок раздела «Метод получения DeltaCRL по идентификатору Центра сертификации»
ПараметрЗначение
МетодGET API – Получение DeltaCRL по идентификатору Центра сертификации
ОписаниеМетод доступен администратору и оператору
URL/export-service/api/v4/public/export/certificate-authorities/{caId}/delta-crl
Swaggerhttps://HOST/external-integration-service/swagger/swagger-ui/index.html#/%5Bv4%5D%20Контроллер%20экспорта/findDeltaCrlByCaId
Query{ fileEncod (enum: PEM, DER) [опционально] }
Request
Response
ПараметрЗначение
МетодPOST API – Импорт событий журнала
Доступность метода определяется состоянием флага «сentralized_event_log_enabled» конфигурационного флага eCA-CA: если флаг выключен, метод будет недоступен для использования.При включенном флаге метод доступен для использования только пользователям с ролью «Администратор».
Swagger:
URL – /logs-service/api/v4/public/logs/import
Request{ sourceType (enum: CA, VA, RA), sourceHostname (string), sourceInstanceId(uuid), logs:[{ sourceEventId (uuid), dateTime (instant), serviceName (string), action (string), description (string), attributes [{, fieldname (string), currentValue (string), fromValue (string), toValue (string) }], ipAddress (string), username (string), role (string), system (boolean) }
ResponseResponseEntity -> { eventId (uuid) -> status (enum: SUCCESS, ERROR, DUPLICATE) -> cause (string) -> }