Метод поиска шаблонов
GET API – Поиск шаблонов | |
Для УЗ с ролью «Пользователь» с использованием данного метода должно быть доступно получение только тех шаблонов, которые указаны в правилах выпуска с режимом обработки «Автоматический выпуск» или «Ручная обработка» для ассоциированного с текущей учетной записью субъекта. Для УЗ с ролью «Оператор» с использованием данного метода должно быть доступно получение только тех шаблонов, доступ к которым данному оператору предоставлен по правилам доступа подключенного eCA-CA. Для УЗ с ролью «Администратор» с использованием данного метода должно быть доступно получение любых шаблонов. | |
URL – /middleware-service/api/v2/public/templates | |
Query |
|
{ |
|
pageLimit (integer), [опционально] | Ограничение на размер выборки (пагинация) |
pageOffset (integer), [опционально] | Смещение от начала списка (пагинация) |
sortBy (string[]), [опционально] | Список полей, к которым применяется сортировка |
sortDirection (string), [опционально] | Направления сортировки (ASC;DESC) |
types (enum[]: EMBEDDED, CLONED, IMPORTED, UNKNOWN), [опционально] | Тип шаблона |
endEntityType (enum[]: USER, DEVICE, ROOT_CA, SUB_CA, UNKNOWN) [опционально], | Тип субъекта |
certificateType (enum[]: CERTIFICATE, ROOT_CA, SUB_CA, UNKNOWN), [опционально] | Тип выпускаемого сертификата |
search (string), [опционально] | Полнотекстовый поиск по имени шаблона |
removed (boolean), [опционально] | Флаг: шаблон удален |
id (UUID[]), [опционально] | ID шаблона |
notId (UUID[]) [опционально] | Исключая ID шаблона |
keyAlgorithm (enum[]: RSA, ECDSA, GOST_R_34_10_2012, UNKNOWN) [опционально] | Фильтр: алгоритм ключа включен в шаблоне[1] |
} |
|
Request |
|
- | |
Response |
|
ResponseEntity -> CollectionResponse -> { | Ответ JSON в HTTP-body |
id (UUID), | ID шаблона[2] |
name (string), | Имя шаблона |
type (enum: EMBEDDED, CLONED, IMPORTED, UNKNOWN), | Тип шаблона |
certificateType (enum: CERTIFICATE, ROOT_CA, SUB_CA, UNKNOWN), | Тип выпускаемого сертификата |
certificateAuthorityId (UUID), | ID ЦС, который должен использоваться при выпуске сертификата по данному шаблону. Шаблоны, у которых в поле «Центр сертификации» указано «Любой», будут иметь в данном поле значение NULL |
certificateCount (int64), | Число выпущенных по шаблону сертификатов |
removed (boolean), | Флаг: шаблон удален |
updated (instant), | Время обновления (ISO 8601) |
created (instant) | Время создания (ISO 8601) |
} |
|
[1] В случае использования множественных значений для фильтра «keyAlgorithm» в ответе метода будут содержаться шаблоны, в которых включен хотя бы один алгоритм из перечня, указанного в данном фильтре.
[2] Шаблоны ЦС Aladdin eCA и ЦР Aladdine eCA имеют сквозную идентификацию.
Метод получения шаблона по идентификатору
GET API – Получение шаблона по идентификатору | |
Для УЗ с ролью «Пользователь» с использованием данного метода должно быть доступно получение только тех шаблонов, которые указаны в правилах выпуска с режимом обработки «Автоматический выпуск» или «Ручная обработка» для ассоциированного с текущей учетной записью субъекта. Для УЗ с ролью «Оператор» с использованием данного метода должно быть доступно получение только тех шаблонов, доступ к которым данному оператору предоставлен по правилам доступа подключенного eCA-CA. Для УЗ с ролью «Администратор» с использованием данного метода должно быть доступно получение любых шаблонов. | |
URL – /middleware-service/api/v2/public/templates/{id} | |
Query |
|
{ |
|
templateId (UUID) | ID шаблона[1] |
} |
|
Request |
|
- | |
Response |
|
{ | Ответ JSON в HTTP-body |
id (UUID), | ID шаблона[2] |
name (string), | Имя шаблона |
validity (int64), | Время действия выпускаемого сертификата (мс) |
certificateType (enum: CERTIFICATE, ROOT_CA, SUB_CA, UNKNOWN), | Тип выпускаемого сертификата |
type (enum: EMBEDDED, CLONED, IMPORTED, UNKNOWN), | Тип шаблона |
certificateAuthorityId (UUID), | ID ЦС, который должен использоваться при выпуске сертификата по данному шаблону. Шаблоны, у которых в поле «Центр сертификации» указано «Любой», будут иметь в данном поле значение NULL |
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), | Флаг: доступен к редактированию |
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, UNKNOWN) | Код компонента |
}], |
|
subjectAltName: [{ | Расширенное имя субъекта сертификата |
index (int32), | Индекс (для сортировки, по умолчанию – 0) |
name (string), | Имя компонента |
description (string), | Описание компонента |
required (boolean), | Флаг: обязателен к заполнению |
validation (boolean), | Флаг: валидация значения |
modifiable (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) |
} |
|
[1] Шаблоны eCA-CA и eCA-RA имеют сквозную идентификацию.
[2] Шаблоны eCA-CA и eCA-RA имеют сквозную идентификацию.