7.2.2. REST API eCA-RA (версия 3)
Aladdin Enterprise CAAPI и SDKAladdin Enterprise CA
Раздел: REST API eCA-RA.
Методы работы с заявками
Заголовок раздела «Методы работы с заявками»Метод создания новой заявки на выпуск сертификата с закрытым ключом (PKCS#12)
Заголовок раздела «Метод создания новой заявки на выпуск сертификата с закрытым ключом (PKCS#12)»| POST API – Создание новой заявки на выпуск сертификата в контейнере PKCS#12 | |
|---|---|
| Для УЗ с ролью “Получатель сертификата” с использованием данного метода доступно только создание заявок, получателем сертификата по которым является субъект, связанный с данной учетной записью. Для УЗ с ролью “Администратор” или “Оператор” с использованием данного метода доступно создание заявок для субъектов ресурсных систем eCA-СA. | |
| URL – /tasks-service/api/v3/public/tasks/pkcs12 | |
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/ | |
| Query | |
| certificateAuthorityId (uuid), [опционально | ID Центра сертификации, на котором должен быть выпущен сертификат по заявке. Если для данного параметра не указано значение, выпуск будет осуществляться на Центре сертификации подключенного eCA-CA, который определен в используемом шаблоне (поле “templateId”). Если в используемом шаблоне не определен конкретный центр сертификации (указано значение “Любой”), выпуск будет осуществляться на активном на момент создания заявки Центре сертификации подключенного eCA-CA. |
| subjectId (uuid), [опционально | ID субъекта[36]. Должен отсутствовать при использовании метода учетной записью с ролью “Пользователь”. |
| templateId (uuid), [обязательно | ID шаблона сертификата[37]. |
| foreignKey (string) [опционально | Внешний ключ заявки. Внешний ключ должен быть уникальным. |
| Request | |
| subjectDN: { (enum: CN, UID, E, EMAILADDRESS, MAIL, SN, GIVENNAME, INITIALS, SURNAME, OU, O, L, ST, DC, C, UNSTRUCTUREDADDRESS, UNSTRUCTUREDNAME, POSTALCODE, BUSINESSCATEGORY, TELEPHONENUMBER, PSEUDONYM, POSTALADDRESS, STREET, NAME, T, DN, DESCRIPTION, INN, OGRN, OGRNIP, SNILS, INNLE, DATEOFBIRTH, PLACEOFBIRTH, ROLE, UNKNOWN): string[] }, | Поля разделенного имени субъекта, которое должно попасть в сертификат. В формате key-value. Где key – один из перечисленных в enum параметров, а value – значение параметра |
| subjectAltName: { (enum: RFC822NAME, DNS_NAME, IPADDRESS, DIRECTORY_NAME, UNIFORM_RESOURCE_ID, REGISTERED_ID, MS_UPN, MS_GUID, KRB5PRINCIPAL, PERMANENT_IDENTIFIER, XMPP_ADDR, SRV_NAME, SUBJECT_IDENTIFICATION_METHOD, UNKNOWN): string[] }, | Поля альтернативного имени субъекта, которое должно попасть в сертификат. В формате key-value. Где key – один из перечисленных в enum параметров, а value – значение параметра |
| keyBits (integer), | Длина ключа |
| keyAlgorithm (enum: RSA, ECDSA, GOST_R_34_10_2012, UNKNOWN), | Алгоритм ключевой пары сертификата |
| password (string) | Пароль контейнера |
| Response ResponseEntity -> ItemResponse -> | Ответ JSON в HTTP-body |
| id (uuid), | ID заявки |
| templateId (uuid), | ID шаблона сертификата[38] |
| type (enum: PKCS10, PKCS12, ON_TOKEN, SCEP, WSTEP, UNKNOWN), | Тип заявки |
| status (enum: NEW, FOR_APPROVE, ISSUE_ERROR, REJECTED, AWAITING_IMPORT, COMPLETED, CANCELLED, UNKNOWN), | Статус заявки |
| creatorId (uuid), | ID учетной записи автора заявки |
| subjectId (uuid), | ID субъекта[39] |
| certificateId(uuid), | Идентификатор сертификата. Заполняется по итогам успешной отработки заявки. |
| name (string), | Common Name сертификата |
| updated (instant), | Время обновления заявки (ISO 8601) |
| created (instant), | Время создания заявки (ISO 8601) |
| foreignKey (string) | Внешний ключ заявки |
Методы создания новой заявки на основании запроса PKCS#10
Заголовок раздела «Методы создания новой заявки на основании запроса PKCS#10»Метод создания новой заявки на основании запроса PKCS#10 (формат запроса на сертификат из входных параметров – multipart/form-data)
Заголовок раздела «Метод создания новой заявки на основании запроса PKCS#10 (формат запроса на сертификат из входных параметров – multipart/form-data)»| POST API – Создание новой заявки на основании запроса PKCS#10 | |
|---|---|
| Для УЗ с ролью “Получатель сертификата” с использованием данного метода доступно только создание заявок, получателем сертификата по которым является субъект, связанный с данной учетной записью. Для УЗ с ролью “Администратор” или “Оператор” с использованием данного метода доступно создание заявок для субъектов ресурсных систем eCA-СA. | |
| URL – /tasks-service/api/v3/public/tasks/pkcs10 | |
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/ | |
| Query | |
| certificateAuthorityId (uuid), [опционально | ID Центра сертификации, на котором должен быть выпущен сертификат по заявке. Если для данного параметра не указано значение, выпуск будет осуществляться на Центре сертификации подключенного eCA-CA, который определен в используемом шаблоне (поле “templateId”). Если в используемом шаблоне не определен конкретный центр сертификации (указано значение “Любой”), выпуск будет осуществляться на активном на момент создания заявки Центре сертификации подключенного eCA-CA. |
| subjectId (uuid), [опционально | ID субъекта[40]. Должен отсутствовать при использовании метода учетной записью с ролью “Пользователь”. Может быть указан при использовании метода учетной записью с ролью “Администратор”.[41] |
| templateId (uuid), [обязательно | ID шаблона сертификата[42]. |
| foreignKey (string) [опционально | Внешний ключ заявки. Внешний ключ должен быть уникальным. |
| Request | |
| request (MultipartFile), | PKCS#10 файл запроса на сертификат |
| subjectName: { (enum: CN, UID, E, EMAILADDRESS, MAIL, SN, GIVENNAME, INITIALS, SURNAME, OU, O, L, ST, DC, C, UNSTRUCTUREDADDRESS, UNSTRUCTUREDNAME, POSTALCODE, BUSINESSCATEGORY, TELEPHONENUMBER, PSEUDONYM, POSTALADDRESS, STREET, NAME, T, DN, DESCRIPTION, INN, OGRN, OGRNIP, SNILS, INNLE, DATEOFBIRTH, PLACEOFBIRTH, ROLE, UNKNOWN): string[] }, [опционально | Поля отличительного имени субъекта, которое должно попасть в сертификат. В формате key-value. Где key – один из перечисленных в enum параметров, а value – значение параметра. Значения полей, указанные в subjectName, переопределяют значения соответствующих полей SDN запроса на сертификат, при условии, что они соответствуют значениям атрибутов субъекта. |
| subjectAltName: { (enum: RFC822NAME, DNS_NAME, IPADDRESS, DIRECTORY_NAME, UNIFORM_RESOURCE_ID, REGISTERED_ID, MS_UPN, MS_GUID, KRB5PRINCIPAL, PERMANENT_IDENTIFIER, XMPP_ADDR, SRV_NAME, SUBJECT_IDENTIFICATION_METHOD, UNKNOWN): string[] | Поля альтернативного имени субъекта, которое должно попасть в сертификат. В формате key-value. Где key – один из перечисленных в enum параметров, а value – значение параметра. Необязательный параметр, задается в случае невозможности поместить данные в PKCS10. Значения полей, указанные в subjectAltName, переопределяют значения соответствующих полей SAN запроса на сертификат, при условии, что они соответствуют значениям атрибутов субъекта. |
| Response ResponseEntity -> ItemResponse -> | Ответ JSON в HTTP-body |
| id (uuid), | ID заявки |
| templateId (uuid), | ID шаблона сертификата[43] |
| type (enum: PKCS10, PKCS12, ON_TOKEN, SCEP, WSTEP, UNKNOWN), | Тип заявки |
| status (enum: NEW, FOR_APPROVE, ISSUE_ERROR, REJECTED, AWAITING_IMPORT, COMPLETED, CANCELLED, UNKNOWN), | Статус заявки |
| creatorId (uuid), | ID учетной записи автора заявки |
| subjectId (uuid), | ID субъекта[44] |
| certificateId (string), | Идентификатор сертификата. Заполняется по итогам успешной отработки заявки |
| name (string), | Common Name сертификата |
| updated (instant), | Время обновления заявки (ISO 8601) |
| created (instant), | Время создания заявки (ISO 8601) |
| foreignKey (string) | Внешний ключ заявки |
Метод создания новой заявки на основании запроса PKCS#10 (формат запроса на сертификат из входных параметров – application/json)
Заголовок раздела «Метод создания новой заявки на основании запроса PKCS#10 (формат запроса на сертификат из входных параметров – application/json)»| POST API – Создание новой заявки на основании запроса PKCS#10 | |
|---|---|
| Для УЗ с ролью “Получатель сертификата” с использованием данного метода доступно только создание заявок, получателем сертификата по которым является субъект, связанный с данной учетной записью. Для УЗ с ролью “Администратор” или “Оператор” с использованием данного метода доступно создание заявок для субъектов ресурсных систем eCA-СA. | |
| URL – /tasks-service/api/v3/public/tasks/pkcs10 | |
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/ | |
| Query | |
| certificateAuthorityId (uuid), [опционально | ID Центра сертификации, на котором должен быть выпущен сертификат по заявке. Если для данного параметра не указано значение, выпуск будет осуществляться на Центре сертификации подключенного eCA-CA, который определен в используемом шаблоне (поле “templateId”). Если в используемом шаблоне не определен конкретный центр сертификации (указано значение “Любой”), выпуск будет осуществляться на активном на момент создания заявки Центре сертификации подключенного eCA-CA. |
| subjectId (uuid), [опционально | ID субъекта[45]. Должен отсутствовать при использовании метода учетной записью с ролью “Пользователь”. Может быть указан при использовании метода учетной записью с ролью “Администратор”.[46] |
| templateId (uuid), [обязательно | ID шаблона сертификата[47]. |
| foreignKey (string) [опционально | Внешний ключ заявки. Внешний ключ должен быть уникальным. |
| Request | |
| request: | Запрос на сертификат |
| contentType (string) [опционально], | Тип загружаемого файла (HTTP MediaType) - application/octet-stream) |
| fileName (string) [опционально], | Имя загружаемого файла |
| data (string:binary) | Содержимое PEM файла запроса на сертификат (массив байт в Base64) |
| subjectName: { (enum: CN, UID, E, EMAILADDRESS, MAIL, SN, GIVENNAME, INITIALS, SURNAME, OU, O, L, ST, DC, C, UNSTRUCTUREDADDRESS, UNSTRUCTUREDNAME, POSTALCODE, BUSINESSCATEGORY, TELEPHONENUMBER, PSEUDONYM, POSTALADDRESS, STREET, NAME, T, DN, DESCRIPTION, INN, OGRN, OGRNIP, SNILS, INNLE, DATEOFBIRTH, PLACEOFBIRTH, ROLE, UNKNOWN): string[] }, [опционально | Поля отличительного имени субъекта, которое должно попасть в сертификат. В формате key-value. Где key – один из перечисленных в enum параметров, а value – значение параметра. Значения полей, указанные в subjectName, переопределяют значения соответствующих полей SDN запроса на сертификат, при условии, что они соответствуют значениям атрибутов субъекта. |
| subjectAltName: { (enum: RFC822NAME, DNS_NAME, IPADDRESS, DIRECTORY_NAME, UNIFORM_RESOURCE_ID, REGISTERED_ID, MS_UPN, MS_GUID, KRB5PRINCIPAL, PERMANENT_IDENTIFIER, XMPP_ADDR, SRV_NAME, SUBJECT_IDENTIFICATION_METHOD, UNKNOWN): string[] | Поля альтернативного имени субъекта, которое должно попасть в сертификат. В формате key-value. Где key – один из перечисленных в enum параметров, а value – значение параметра. Необязательный параметр, задается в случае невозможности поместить данные в PKCS10. Значения полей, указанные в subjectAltName, переопределяют значения соответствующих полей SAN запроса на сертификат, при условии, что они соответствуют значениям атрибутов субъекта. |
| Response ResponseEntity -> ItemResponse -> | Ответ JSON в HTTP-body |
| id (uuid), | ID заявки |
| templateId (uuid), | ID шаблона сертификата[48] |
| type (enum: PKCS10, PKCS12, ON_TOKEN, SCEP, WSTEP, UNKNOWN), | Тип заявки |
| status (enum: NEW, FOR_APPROVE, ISSUE_ERROR, REJECTED, AWAITING_IMPORT, COMPLETED, CANCELLED, UNKNOWN), | Статус заявки |
| creatorId (uuid), | ID учетной записи автора заявки |
| subjectId (uuid), | ID субъекта[49] |
| certificateId (string), | Идентификатор сертификата. Заполняется по итогам успешной отработки заявки |
| name (string), | Common Name сертификата |
| updated (instant), | Время обновления заявки (ISO 8601) |
| created (instant), | Время создания заявки (ISO 8601) |
| foreignKey (string) | Внешний ключ заявки |
Метод получения данных сертификата, выпущенного по заявке, по идентификатору заявки
Заголовок раздела «Метод получения данных сертификата, выпущенного по заявке, по идентификатору заявки»| GET API – Получение данных сертификата, выпущенного по заявке, по идентификатору заявки | |
|---|---|
| Для УЗ с ролью “Получатель сертификата” с использованием данного метода доступно получение данных о выпущенных сертификатах только по тем заявкам, получателем сертификата по которым является субъект, связанный с данной УЗ. Для УЗ с ролью “Оператор” с использованием данного метода доступно получение данных о выпущенных сертификатах только по созданным данным оператором заявкам, а также по заявкам для субъектов, доступ к которым данному оператору предоставлен по правилам доступа подключенного eCA-CA. Для УЗ с ролью “Администратор” с использованием данного метода доступно получение данных о выпущенных сертификатах по любым заявкам. | |
| URL – /middleware-service/api/v3/public/tasks/{id}/certificate | |
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/ | |
| Query | |
| id (uuid) | ID заявки |
| Request - | |
| Response ResponseEntity -> CollectionResponse -> | Ответ JSON в HTTP-body |
| id (uuid), | Идентификатор сертификата |
| chain: | Цепочка сертификатов (рекурсивный объект) |
| id (uuid), | Идентификатор сертификата |
| name (string), | Имя сертификата (на основе CN) |
| subjectDN: | Имя субъекта сертификата |
| (enum: CN, UID, E, EMAILADDRESS, MAIL, SN, GIVENNAME, INITIALS, SURNAME, OU, O, L, ST, DC, C, UNSTRUCTUREDADDRESS, UNSTRUCTUREDNAME, POSTALCODE, BUSINESSCATEGORY, TELEPHONENUMBER, PSEUDONYM, POSTALADDRESS, STREET, NAME, T, DN, DESCRIPTION, INN, OGRN, OGRNIP, SNILS, INNLE, DATEOFBIRTH, PLACEOFBIRTH, ROLE, UNKNOWN): string | Поля разделенного имени субъекта из сертификата. В формате key-value. Где key – один из перечисленных в enum параметров, а value – значение параметра |
| issuer: {… | Издатель сертификата (вложенный объект) |
| serialnumber (string), | Серийный номер сертификата |
| fingerprint (string), | Фингерпринт сертификата |
| name (string), | Имя сертификата (на основе CN) |
| issuerId (uuid), | Идентификатор издателя сертификата |
| issuerDN: | Имя субъекта издателя сертификата |
| (enum: CN, UID, E, EMAILADDRESS, MAIL, SN, GIVENNAME, INITIALS, SURNAME, OU, O, L, ST, DC, C, UNSTRUCTUREDADDRESS, UNSTRUCTUREDNAME, POSTALCODE, BUSINESSCATEGORY, TELEPHONENUMBER, PSEUDONYM, POSTALADDRESS, STREET, NAME, T, DN, DESCRIPTION, INN, OGRN, OGRNIP, SNILS, INNLE, DATEOFBIRTH, PLACEOFBIRTH, ROLE, UNKNOWN): string | Поля разделенного имени субъекта издателя из сертификата. В формате key-value. Где key – один из перечисленных в enum параметров, а value – значение параметра |
| subjectDN: | Имя субъекта сертификата |
| (enum: CN, UID, E, EMAILADDRESS, MAIL, SN, GIVENNAME, INITIALS, SURNAME, OU, O, L, ST, DC, C, UNSTRUCTUREDADDRESS, UNSTRUCTUREDNAME, POSTALCODE, BUSINESSCATEGORY, TELEPHONENUMBER, PSEUDONYM, POSTALADDRESS, STREET, NAME, T, DN, DESCRIPTION, INN, OGRN, OGRNIP, SNILS, INNLE, DATEOFBIRTH, PLACEOFBIRTH, ROLE, UNKNOWN): string | Поля разделенного имени субъекта из сертификата. В формате key-value. Где key – один из перечисленных в enum параметров, а value – значение параметра |
| subjectAltName: | Альтернативное имя субъекта сертификата |
| (enum: RFC822NAME, DNS_NAME, IPADDRESS, DIRECTORY_NAME, UNIFORM_RESOURCE_ID, REGISTERED_ID, MS_UPN, MS_GUID, KRB5PRINCIPAL, PERMANENT_IDENTIFIER, XMPP_ADDR, SRV_NAME, SUBJECT_IDENTIFICATION_METHOD, UNKNOWN): string | Поля альтернативного имени субъекта из сертификата. В формате key-value. Где key – один из перечисленных в enum параметров, а value – значение параметра |
| keyAlgorithm (enum: RSA, ECDSA, GOST_R_34_10_2012, UNKNOWN), | Алгоритм ключа сертификата ЦС |
| hashAlgorithm (enum: SHA1, SHA256, SHA384, SHA512, SHA3_256, SHA3_384, SHA3_512, RSASSA_PSS, MD5, GOST_R_34_11_2012, UNKNOWN), | Алгоритм подписи сертификата ЦС |
| keyBits (int32), | Длина ключа сертификата ЦС |
| templateId (uuid), | Идентификатор шаблона[50] |
| templateName (string), | Имя шаблона |
| type (enum: CERTIFICATE, ROOT_CA, SUB_CA, UNKNOWN), | Тип сертификата |
| endEntityType (enum: ROOT_CA, SUB_CA, USER, DEVICE, UNKNOWN), | Тип субъекта |
| validFrom (instant), | Дата начала действия сертификата (ISO 8601) |
| validTo (instant), | Дата окончания действия сертификата (ISO 8601) |
| status (enum: ACTIVE, HOLD, REVOKE, REQUEST, UNKNOWN), | Статус сертификата |
| isValid (boolean), | Флаг: сертификат действителен |
| isExpired (boolean), | Флаг: сертификат истек |
| actions: | Доступные действия по выгрузке |
| p12 (boolean), | Флаг: выгрузка pkcs12 |
| csr (boolean), | Флаг: выгрузка pkcs10 |
| pem (boolean) | Флаг: выгрузка сертификата |
| publicKey (string), | Открытый ключ |
| certificateType (string), | Тип сертификата (X.509) |
| version (int32), | Версия сертификата |
| subjectKeyIdentifier (string), | Идентификатор ключа сертификата |
| authorityKeyIdentifier (string) | Идентификатор ключа издателя сертификата |
| keyUsages: | Назначение ключа сертификата |
| id (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 (enum: EKU_PKIX_ANY_EXTENDED_KEY_USAGE, CSN_369791_TLS_CLIENT, CSN_369791_TLS_SERVER, CLIENT_AUTHENTICATION, CODE_SIGNING, EAP_OVER_LAN, EAP_OVER_PPP, ETSI_TSL_SIGNING, EMAIL_PROTECTION, ICAO_DEVIATION_LIST_SIGNING, EKU_INTEL_AMT, INTERNET_KEY_EXCHANGE_FOR_IPSEC, KERBEROS_CLIENT_AUTHENTICATION, EKU_KRB_PKINIT_KDC, MS_COMMERCIAL_CODE_SIGNING, MS_DOCUMENT_SIGNING, MS_EFS_RECOVERY, MS_ENCRYPTED_FILE_SYSTEM, MS_INDIVIDUAL_CODE_SIGNING, MS_SMART_CARD_LOGON, OCSP_SIGNER, EKU_ADOBE_PDF_SIGNING, PIV_CARD_AUTHENTICATION, SCVP_CLIENT, SCVP_SERVER, SIP_DOMAIN, EKU_PKIX_SSH_CLIENT, SSH_SERVER, SERVER_AUTHENTICATION, TIME_STAMPING, ICAO_MASTER_LIST_SIGNING, UNKNOWN), | Перечисление расширенного использования ключа |
| value (string), | Наименование элемента |
| oid (string), | OID назначения |
| description (string), | Описание использования ключа |
| created (instant), | Дата создания EKU (ISO 8601) |
| updated (instant), | Дата создания EKU (ISO 8601) |
| default (boolean) | Флаг: EKU по умолчанию |
| ca (boolean), | Флаг: сертификат ЦС |
| revocation: | Сведения об отзыве сертификата ЦС |
| date (instant), | Дата отзыва |
| number (int4), | Код причины отзыва |
| value (string) | Значение причины отзыва |
| aiaUrls (string[]), | URL AIA |
| ocspUrls (string[]), | URL OCSP |
| crlUrls (string[]), | URL CRL |
| deltaCrlUrls (string[]), | URL Delta CRL |
| userId (uuid), | Идентификатор УЗ |
| subjectId (uuid), | Идентификатор субъекта |
| created (instant), | Время создания (ISO 8601) |
| updated (instant) | Время обновления (ISO 8601) |
Методы работы с субъектами
Заголовок раздела «Методы работы с субъектами»Метод поиска субъектов
Заголовок раздела «Метод поиска субъектов»| GET API – Поиск субъектов | |
|---|---|
| Для УЗ с ролью “Получатель сертификата” с использованием данного метода доступно только получение данных субъекта, связанный с данной УЗ. Для УЗ с ролью “Оператор” или “Администратор” с использованием данного метода доступно получение данных любого субъекта подключенного eCA-CA. | |
| URL – /middleware-service/api/v3/public/subjects | |
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/ | |
| Query | |
| id (UUID[]), [опционально | ID субъекта[51] |
| resourceId (UUID[]), [опционально | ID ресурсной системы |
| securityGroupId (UUID[]), [опционально | ID группы безопасности |
| search (string), [опционально | Полнотекстовый поиск (имя субъекта) |
| isConnected (boolean), [опционально | Флаг: субъект подключен к ресурсной системе |
| isBlocked (boolean), [опционально | Флаг: субъект заблокирован в ресурсной системе |
| pageLimit (integer), [опционально | Ограничение на размер выборки (пагинация) |
| pageOffset (integer), [опционально | Смещение от начала списка (пагинация) |
| sortBy (string[]), [опционально | Список полей, к которым применяется сортировка |
| sortDirection (string) [опционально | Направления сортировки (ASC;DESC) |
| Request - | |
| Response ResponseEntity -> CollectionResponse -> | Ответ JSON в HTTP-body |
| id (UUID), | ID субъекта[52] |
| commonName (string), | Имя субъекта |
| distinguishedName (string), | Расположение субъекта в ресурсной системе |
| resource: | Ресурсная система |
| id (uuid), | ID ресурсной системы |
| commonName (string), | Имя ресурсной системы |
| distinguishedName (string) | BaseDN точки подключения к ресурсной системе |
| subjectName: | Имя субъекта |
| (enum: CN, UID, E, EMAILADDRESS, MAIL, SN, GIVENNAME, INITIALS, SURNAME, OU, O, L, ST, DC, C, UNSTRUCTUREDADDRESS, UNSTRUCTUREDNAME, POSTALCODE, BUSINESSCATEGORY, TELEPHONENUMBER, PSEUDONYM, POSTALADDRESS, STREET, NAME, T, DN, DESCRIPTION, INN, OGRN, OGRNIP, SNILS, INNLE, DATEOFBIRTH, PLACEOFBIRTH, ROLE, UNKNOWN): | Поля разделенного имени субъекта |
| values (string[]), | Значения компонента |
| editable (boolean), | Флаг: компонент доступен для редактирования |
| subjectAltName: | Альтернативное имя субъекта |
| (enum: RFC822NAME, DNS_NAME, IPADDRESS, DIRECTORY_NAME, UNIFORM_RESOURCE_ID, REGISTERED_ID, MS_UPN, MS_GUID, KRB5PRINCIPAL, PERMANENT_IDENTIFIER, XMPP_ADDR, SRV_NAME, SUBJECT_IDENTIFICATION_METHOD, UNKNOWN): | Поля альтернативного имени субъекта |
| values (string[]), | Значения компонента |
| editable (boolean), | Флаг: компонент доступен для редактирования |
| isConnected (boolean), | Флаг: субъект подключен к ресурсной системе |
| isBlocked (boolean), | Флаг: субъект заблокирован в ресурсной системе |
| modify (instant), | Время изменения (ISO 8601) |
| certificatesCount (integer), | Количество действующих сертификатов у субъекта |
| updated (instant), | Время обновления (ISO 8601) |
| created (instant), | Время создания (ISO 8601) |
| sid (string) | SID субъекта |
Метод получения субъекта по идентификатору
Заголовок раздела «Метод получения субъекта по идентификатору»| GET API – Получение субъекта по идентификатору | |
|---|---|
| Для УЗ с ролью “Получатель сертификата” с использованием данного метода доступно только получение данных субъекта, связанный с данной УЗ. Для УЗ с ролью “Оператор” или “Администратор” с использованием данного метода доступно получение данных любого субъекта подключенного eCA-CA. | |
| URL – /middleware-service/api/v3/public/subjects/{id | |
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/ | |
| Query | |
| id (UUID) | ID субъекта[53] |
| Request - | |
| Response | Ответ JSON в HTTP-body |
| id (UUID), | ID субъекта[54] |
| commonName (string), | Имя субъекта |
| distinguishedName (string), | Расположение субъекта в ресурсной системе |
| resource: | Ресурсная система |
| id (uuid), | ID ресурсной системы |
| commonName (string), | Имя ресурсной системы |
| distinguishedName (string) | BaseDN точки подключения к ресурсной системе |
| subjectName: | Имя субъекта |
| (enum: CN, UID, E, EMAILADDRESS, MAIL, SN, GIVENNAME, INITIALS, SURNAME, OU, O, L, ST, DC, C, UNSTRUCTUREDADDRESS, UNSTRUCTUREDNAME, POSTALCODE, BUSINESSCATEGORY, TELEPHONENUMBER, PSEUDONYM, POSTALADDRESS, STREET, NAME, T, DN, DESCRIPTION, INN, OGRN, OGRNIP, SNILS, INNLE, DATEOFBIRTH, PLACEOFBIRTH, ROLE, UNKNOWN): | Поля разделенного имени субъекта |
| values (string[]), | Значения компонента |
| editable (boolean), | Флаг: компонент доступен для редактирования |
| subjectAltName: | Альтернативное имя субъекта |
| (enum: RFC822NAME, DNS_NAME, IPADDRESS, DIRECTORY_NAME, UNIFORM_RESOURCE_ID, REGISTERED_ID, MS_UPN, MS_GUID, KRB5PRINCIPAL, PERMANENT_IDENTIFIER, XMPP_ADDR, SRV_NAME, SUBJECT_IDENTIFICATION_METHOD, UNKNOWN): | Поля альтернативного имени субъекта |
| values (string[]), | Значения компонента |
| editable (boolean), | Флаг: компонент доступен для редактирования |
| isConnected (boolean), | Флаг: субъект подключен к ресурсной системе |
| isBlocked (boolean), | Флаг: субъект заблокирован в ресурсной системе |
| modify (instant), | Время изменения (ISO 8601) |
| certificatesCount (integer), | Количество действующих сертификатов у субъекта |
| updated (instant), | Время обновления (ISO 8601) |
| created (instant), | Время создания (ISO 8601) |
| sid (string) | SID субъекта |
Методы работы с шаблонами
Заголовок раздела «Методы работы с шаблонами»Метод получения шаблона по идентификатору
Заголовок раздела «Метод получения шаблона по идентификатору»| GET API – Получение шаблона по идентификатору | |
|---|---|
| Для УЗ с ролью “Получатель сертификата” с использованием данного метода доступно получение только тех шаблонов, которые указаны в правилах выпуска с режимом обработки “Автоматический выпуск” или “Ручная обработка” для ассоциированного с текущей учетной записью субъекта. Для УЗ с ролью “Оператор” с использованием данного метода доступно получение только тех шаблонов, доступ к которым данному оператору предоставлен по правилам доступа подключенного eCA-CA. Для УЗ с ролью “Администратор” с использованием данного метода доступно получение любых шаблонов. | |
| URL – /middleware-service/api/v3/public/templates/{id | |
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/ | |
| Query | |
| templateId (UUID) | ID шаблона[55] |
| Request - | |
| Response | Ответ JSON в HTTP-body |
| id (UUID), | ID шаблона[56] |
| name (string), | Имя шаблона |
| validity (int64), | Время действия выпускаемого сертификата (мс) |
| certificateType (enum: CERTIFICATE, ROOT_CA, SUB_CA, UNKNOWN), | Тип выпускаемого сертификата |
| type (enum: EMBEDDED, CLONED, IMPORTED, UNKNOWN), | Тип шаблона |
| endEntityType (enum: USER, DEVICE, ROOT_CA, SUB_CA, UNKNOWN), | Тип субъекта |
| removed (boolean), | Флаг: шаблон удален |
| rsa: | Описание RSA-криптографии |
| use (boolean), | Флаг: RSA-ключи доступны для шаблона |
| minLength (int32), | Минимальная длина RSA-ключа |
| lengths (int32[]) | Доступные длины RSA-ключа |
| ecdsa: | Описание ESDCA-криптографии |
| use (boolean), | Флаг: ESDCA -ключи доступны для шаблона |
| minLength (int32), | Минимальная длина ESDCA -ключа |
| lengths (int32[]) | Доступные длины ESDCA -ключа |
| gost: | Описание ГОСТ-криптографии |
| use (boolean), | Флаг: ГОСТ -ключи доступны для шаблона |
| minLength (int32), | Минимальная длина ГОСТ -ключа |
| lengths (int32[]) | Доступные длины ГОСТ -ключа |
| keyUsages: | Назначение ключа сертификата |
| critical (boolean), | Флаг: расширение критическое |
| values (enum[]:DIGITAL_SIGNATURE, NON_REPUDIATION, KEY_ENCIPHERMENT, DATA_ENCIPHERMENT, KEY_AGREEMENT, KEY_CERT_SIGN, CRL_SIGN, ENCIPHER_ONLY, DECIPHER_ONLY, UNKNOWN) | Значение расширения |
| extendedKeyUsages: | Расширенное назначение ключа сертификата |
| critical (boolean), | Флаг: расширение критическое |
| values (string[]) | Значение расширения (OIDs) |
| policies: | Политики сертификата |
| critical (boolean), | Флаг: расширение критическое |
| values (string[]) | Значение расширения (OIDs) |
| subjectDN: | Имя субъекта сертификата |
| index (int32), | Индекс (для сортировки, по умолчанию – 0) |
| name (string), | Имя компонента |
| description (string), | Описание компонента |
| required (boolean), | Флаг: обязателен к заполнению |
| validation (boolean), | Флаг: валидация значения |
| modifiable (boolean), | Флаг: доступен к редактированию |
| extendable (boolean), | Флаг: расширяемое поле |
| regex (string), | Регулярное значение для валидации значения |
| defaultValue (string), | Значение по умолчанию |
| alert (string), | Предупреждение о неудачной валидации значения |
| code (enum: CN, UID, E, EMAILADDRESS, MAIL, SN, GIVENNAME, INITIALS, SURNAME, OU, O, L, ST, DC, C, UNSTRUCTUREDADDRESS, UNSTRUCTUREDNAME, POSTALCODE, BUSINESSCATEGORY, TELEPHONENUMBER, PSEUDONYM, POSTALADDRESS, STREET, NAME, T, DN, DESCRIPTION, INN, OGRN, OGRNIP, SNILS, INNLE, DATEOFBIRTH, PLACEOFBIRTH, ROLE, UNKNOWN) | Код компонента |
| subjectAltName: | Расширенное имя субъекта сертификата |
| index (int32), | Индекс (для сортировки, по умолчанию – 0) |
| name (string), | Имя компонента |
| description (string), | Описание компонента |
| required (boolean), | Флаг: обязателен к заполнению |
| validation (boolean), | Флаг: валидация значения |
| modifiable (boolean), | Флаг: доступен к редактированию |
| extendable (boolean), | Флаг: расширяемое поле |
| regex (string), | Регулярное значение для валидации значения |
| defaultValue (string), | Значение по умолчанию |
| alert (string), | Предупреждение о неудачной валидации значения |
| code (enum: RFC822NAME, DNS_NAME, IPADDRESS, DIRECTORY_NAME, UNIFORM_RESOURCE_ID, REGISTERED_ID, MS_UPN, MS_GUID, KRB5PRINCIPAL, PERMANENT_IDENTIFIER, XMPP_ADDR, SRV_NAME, SUBJECT_IDENTIFICATION_METHOD, UNKNOWN), | Код компонента |
| generalName (int32), | Идентификатор компонента в RFC |
| oid (string) | OID компонента в RFC |
| updated (instant), | Время обновления (ISO 8601) |
| created (instant), | Время создания (ISO 8601) |
| certificateAuthorityId (UUID), | ID ЦС, который должен использоваться при выпуске сертификата по данному шаблону Шаблоны, у которых в поле “Центр сертификации” указано “Любой”, будут иметь в данном поле значение NULL |
| appendSubjectSId (boolean), | Флаг: включать SID субъекта в сертификат |
| publication (boolean) | Флаг: публиковать сертификат в РС |
[36]. Субъекты eCA-CA и eCA-RA имеют сквозную идентификацию. ↑
[37]. Шаблоны eCA-CA и eCA-RA имеют сквозную идентификацию. ↑
[38]. Шаблоны eCA-CA и eCA-RA имеют сквозную идентификацию. ↑
[39]. Субъекты eCA-CA и eCA-RA имеют сквозную идентификацию. ↑
[40]. Субъекты eCA-CA и eCA-RA имеют сквозную идентификацию. ↑
[41]. Если при создании администратором заявки на сертификат на основании запроса во входных параметрах метода не указан subjectId, ПО eCA-RA на основании указанного в запросе значения Common name автоматически определяет (или создаёт) получателя сертификата по заявке в соответствии со следующими правилами: • если в списке субъектов присутствует один субъект, имеющий Common name аналогичный указанному в запросе, получателем сертификата по заявке будет считаться данный субъект; • если в списке субъектов присутствует несколько субъектов, имеющих Common name аналогичный указанному в запросе, получателем сертификата по заявке из данного перечня субъектов будет считаться субъект с самой поздней датой последнего редактирования; • если в списке субъектов отсутствуют субъекты, имеющие Common name аналогичный указанному в запросе, eCA-RA создаст в eCA-СA локальный субъект на основании запроса. ↑
[42]. Шаблоны eCA-CA и eCA-RA имеют сквозную идентификацию. ↑
[43]. Шаблоны eCA-CA и eCA-RA имеют сквозную идентификацию. ↑
[44]. Субъекты eCA-CA и eCA-RA имеют сквозную идентификацию. ↑
[45]. Субъекты eCA-CA и eCA-RA имеют сквозную идентификацию. ↑
[46]. Если при создании администратором заявки на сертификат на основании запроса во входных параметрах метода не указан subjectId, ПО eCA-RA на основании указанного в запросе значения Common name автоматически определяет (или создаёт) получателя сертификата по заявке в соответствии со следующими правилами: • если в списке субъектов присутствует один субъект, имеющий Common name аналогичный указанному в запросе, получателем сертификата по заявке будет считаться данный субъект ; • если в списке субъектов присутствует несколько субъектов, имеющих Common name аналогичный указанному в запросе, получателем сертификата по заявке из данного перечня субъектов будет считаться субъект с самой поздней датой последнего редактирования; • если в списке субъектов отсутствуют субъекты, имеющие Common name аналогичный указанному в запросе, eCA-RA создаст в eCA-СA локальный субъект на основании запроса. ↑
[47]. Шаблоны eCA-CA и eCA-RA имеют сквозную идентификацию. ↑
[48]. Шаблоны eCA-CA и eCA-RA имеют сквозную идентификацию. ↑
[49]. Субъекты eCA-CA и eCA-RA имеют сквозную идентификацию. ↑
[50]. Шаблоны eCA-CA и eCA-RA имеют сквозную идентификацию. ↑
[51]. Субъекты eCA-CA и eCA-RA имеют сквозную идентификацию. ↑
[52]. Субъекты eCA-CA и eCA-RA имеют сквозную идентификацию. ↑
[53]. Субъекты eCA-CA и eCA-RA имеют сквозную идентификацию. ↑
[54]. Субъекты eCA-CA и eCA-RA имеют сквозную идентификацию. ↑
[55]. Шаблоны eCA-CA и eCA-RA имеют сквозную идентификацию. ↑
[56]. Шаблоны eCA-CA и eCA-RA имеют сквозную идентификацию. ↑