Версия: Indeed Certificate Manager 7.1

СКЗИ

Для управления СКЗИ через API убедитесь, что в Мастере настройки в разделе Журнал учета СКЗИ включена опция Вести журнал учета СКЗИ.

При работе с СКЗИ через API вам доступны следующие операции:

получить список СКЗИ по заданным фильтрам;
выполнить поиск СКЗИ по идентификатору;
выполнить поиск СКЗИ по типу;
добавить СКЗИ в Indeed CM;
назначить СКЗИ на пользователя;
изменить состояние СКЗИ;
уничтожить/изъять СКЗИ.

`GET /Skzi`

Возвращает список объектов skzi record.

Параметры запроса

Параметр	Обязательно/необязательно	Описание
`objectType`	Optional	Тип объекта: - Distributive – дистрибутив; - License – лицензия; - Documentation – документация; - KeyDocument – ключевой документ; - Card – ключевой носитель; - Custom – пользовательский.
`skziTypeId`	Optional	Идентификатор типа СКЗИ.
`serialNumber`	Optional	Серийный номер СКЗИ.
`instanceNumber`	Optional	Номер экземпляра.
`state`	Optional	Состояние: - Created – изготовлено; - Assigned – назначено; - Sent – передано; - Returned – возвращено; - Issued – выдано; - Installed – установлено; - Destructed/Withdrawn – уничтожено/изъято.
`userName`	Optional	Имя пользователя в формате Common Name.
`startDate`	Optional	Поиск СКЗИ с указанной даты.
`endDate`	Optional	Поиск СКЗИ до указанной даты.
`offset`	Optional	Сдвиг на указанное количество записей СКЗИ.
`count`	Optional	Количество СКЗИ для вывода в ответе.

Возвращаемые значения

Параметр	Описание
`id`	Идентификатор СКЗИ.
`timeCreated`	Время изготовления СКЗИ.
`userId`	Идентификатор пользователя.
`userName`	Имя пользователя в формате Common Name.
`logonName`	Имя учетной записи пользователя в формате DOMAIN\LogonName.
`objectType`	Тип объекта: - Distributive – дистрибутив; - License – лицензия; - Documentation – документация; - KeyDocument – ключевой документ; - Card – ключевой носитель; - Custom – пользовательский.
`skziTypeId`	Идентификатор типа СКЗИ.
`serialNumber`	Серийный номер СКЗИ.
`instanceNumber`	Номер экземпляра.
`creationData`	Объект с информацией об изготовлении СКЗИ: `creator` – имя изготовителя; `timeCreated`– время изготовления; `docNumber` – номер документа об изготовлении.
`sendingData`	Объект с информацией о передаче СКЗИ: `docNumber` – номер сопроводительного письма; `recipient` – ФИО сотрудника, который подтверждает получение СКЗИ; `timeSent`– время передачи; `timeConfirmed` – время подтверждения получения; `confirmationDocNumber` – номер документа о подтверждении получения.
`returnData`	Объект с информацией о возврате СКЗИ: `docNumber` – номер сопроводительного письма; `timeReturned`– время возврата; `timeConfirmed` – время подтверждения получения СКЗИ; `confirmationDocNumber` – номер документа о подтверждении получения.
`issueData`	Объект с информацией о выдаче СКЗИ: `docNumber` – номер сопроводительного письма; `timeIssued`– время выдачи.
`installationData`	Объект с информацией об установке СКЗИ: `docNumber` – номер документа об установке; `installer` – ФИО сотрудников органа криптографической защиты, пользователей СКЗИ, производивших установку СКЗИ; `timeInstalled`– время установки; `hardwareId` – номер аппаратного средства, на котором установлено или к которому подключено СКЗИ; `location` – место установки.
`destructionData`	Объект с информацией об уничтожении/изъятии СКЗИ: `destructor` – ФИО сотрудников органа криптографической защиты, пользователей СКЗИ, производивших уничтожение/изъятие СКЗИ; `timeDestructed` – время уничтожения/изъятия; `docNumber` – номер акта или расписки об уничтожении.
`comment`	Примечание.
`customFields`	Объект с информацией о дополнительных полях в журнале учета СКЗИ; `id` – идентификатор атрибута, который подставляется в шаблоны печати нормативных документов; `value` – имя поля, которое отображается в журнале СКЗИ. Дополнительные поля задаются в Мастере настройки Indeed CM в разделе Журнал учета СКЗИ.
`state`	Состояние СКЗИ: - Created – изготовлено; - Assigned – назначено; - Sent – передано; - Returned – возвращено; - Issued – выдано; - Installed – установлено; - Destructed/Withdrawn – уничтожено/изъято.

Пример запроса

http://localhost/cm/api/Object?type=Distributive&state=Installed&offset=0&count=5 – вывод 5 записей СКЗИ типа объекта Дистрибутив в состоянии Installed (установлено).

`POST /Skzi`

Позволяет добавить СКЗИ в Indeed CM.

Параметры запроса

Параметр	Обязательно/необязательно	Описание
`objectType`	Required	Тип объекта: - Distributive – дистрибутив; - License – лицензия; - Documentation – документация; - KeyDocument – ключевой документ; - Card – ключевой носитель; - Custom – пользовательский.
`skziTypeId`	Required	Идентификатор типа СКЗИ.
`serialNumber`	Required	Серийный номер СКЗИ.
`instanceNumber`	Optional	Номер экземпляра.
`docNumber`	Optional	Номер документа, на основании которого добавляется СКЗИ. Если номер документа не указан, то номер генерируется по шаблону, настроенному для конкретного типа СКЗИ в разделе Конфигурация→СКЗИ→Нормативные документы.
`creationDate`	Optional	Время создания документа. Указывается в формате yyyyMMddHHmmss (UTC). Если значение не указано, то подставляется текущее время.

Пример тела запроса

{
  "objectType": "Distributive",
  "skziType": "3",
  "serialNumber": "0578393357",
  "instanceNumber": "4",
  "docNumber": "35",
  "creationDate": "2024-11-12T15:24:41.979Z"
}

`GET /Skzi/Types`

Возвращает список значений skziType – список типов СКЗИ.

Параметры запроса

Параметр	Обязательно/необязательно	Описание
`skziTypeName`	Optional	Название типа СКЗИ.
`family`	Optional	Семейство СКЗИ: - Hardware – аппаратный; - Software – программный; - HardwareSoftware – аппаратно-программный.
`includeArchived`	Optional	- true – включить в возвращаемые значения информацию об СКЗИ архивных типов; - false – не включать в возвращаемые значения информацию об СКЗИ архивных типов. Значение по умолчанию – false.

Возвращаемые значения

Параметр	Описание
`id`	Идентификатор СКЗИ.
`skziTypeName`	Название типа СКЗИ.
`family`	Семейство СКЗИ: - Hardware – аппаратный; - Software – программный; - HardwareSoftware – аппаратно-программный.
`conformityCertificate`	Информация о сертификате соответствия на СКЗИ: `number` – номер; `issueDate` – дата выдачи; `notAfter` – дата окончания срока действия.
`supportCertificate`	Информация о сертификате технической поддержки: `number` – номер; `issueDate` – дата выдачи; `notAfter` – дата окончания срока действия.
`cardTypeName`	Название типа устройства. Параметр отображается только для СКЗИ аппаратных типов.
`cardTypeModel`	Название модели устройства. Параметр отображается только для устройств Рутокен и JaCarta, если в разделе Типы СКЗИ настроены типы СКЗИ для различных моделей.
`isDefault`	- true – тип СКЗИ, используемый по умолчанию (для программных СКЗИ); - false – тип СКЗИ, не используемый по умолчанию.
`isArchived`	- true – архивный тип СКЗИ; - false – действующий тип СКЗИ.

Пример запроса

http://localhost/cm/api/Skzi/Types?skziTypeName=JaCarta%20PKI&family=Hardware&includeArchived=false – вывод списка действующих СКЗИ аппаратного типа JaCarta PKI.

`GET /Skzi/{id}`

Возвращает объект skzi record по его идентификатору.

Параметры запроса: id – идентификатор СКЗИ.

Возвращаемые значения

Параметр	Описание
`id`	Идентификатор СКЗИ.
`timeCreated`	Время изготовления СКЗИ.
`userId`	Идентификатор пользователя.
`userName`	Имя пользователя в формате Common Name.
`logonName`	Имя учетной записи пользователя.
`objectType`	Тип объекта: - Distributive – дистрибутив; - License – лицензия; - Documentation – документация; - KeyDocument – ключевой документ; - Card – ключевой носитель; - Custom – пользовательский.
`skziTypeId`	Идентификатор типа СКЗИ.
`serialNumber`	Серийный номер СКЗИ.
`instanceNumber`	Номер экземпляра.
`creationData`	Объект с информацией об изготовлении СКЗИ: `creator` – имя изготовителя; `timeCreated`– время изготовления; `docNumber` – номер документа об изготовлении.
`sendingData`	Объект с информацией о передаче СКЗИ: `docNumber` – номер сопроводительного письма; `recipient` – ФИО сотрудника, который подтверждает получение СКЗИ; `timeSent`– время передачи; `timeConfirmed` – время подтверждения получения; `confirmationDocNumber` – номер документа о подтверждении получения.
`returnData`	Объект с информацией о возврате СКЗИ: `docNumber` – номер сопроводительного письма; `timeReturned`– время возврата; `timeConfirmed` – время подтверждения получения СКЗИ; `confirmationDocNumber` – номер документа о подтверждении получения.
`issueData`	Объект с информацией о выдаче СКЗИ: `docNumber` – номер сопроводительного письма; `timeIssued`– время выдачи.
`installationData`	Объект с информацией об установке СКЗИ: `docNumber` – номер документа об установке; `installer` – ФИО сотрудников органа криптографической защиты, пользователей СКЗИ, производивших установку СКЗИ; `timeInstalled`– время установки; `hardwareId` – номер аппаратного средства, на котором установлено или к которому подключено СКЗИ; `location` – место установки.
`destructionData`	Объект с информацией об уничтожении/изъятии СКЗИ: `destructor` – ФИО сотрудников органа криптографической защиты, пользователей СКЗИ, производивших уничтожение/изъятие СКЗИ; `timeDestructed` – время уничтожения/изъятия; `docNumber` – номер акта или расписки об уничтожении.
`comment`	Примечание.
`customFields`	Объект с информацией о дополнительных полях в журнале учета СКЗИ: `id` – идентификатор атрибута, который подставляется в шаблоны печати нормативных документов; `value` – имя поля, которое отображается в журнале СКЗИ. Дополнительные поля задаются в Мастере настройки Indeed CM в разделе Журнал учета СКЗИ.
`state`	Состояние СКЗИ: - Created – изготовлено; - Assigned – назначено; - Sent – передано; - Returned – возвращено; - Issued – выдано; - Installed – установлено; - Destructed/Withdrawn – уничтожено/изъято.

Пример запроса

http://localhost/cm/api/Skzi/1 – вывод записи СКЗИ с идентификатором 1.

`PUT /Skzi/{id}/Assign`

Позволяет назначить СКЗИ на пользователя.

Параметры запроса

Параметр	Обязательно/необязательно	Описание
`id`	Required	Идентификатор СКЗИ.
`userName`	Required	Имя пользователя в формате Common Name или имя учетной записи пользователя в формате DOMAIN\LogonName или User principal name (UPN).

Пример запроса

http://localhost/cm/api/Skzi/8/assign?userName=evgeniy.belov%40demo.com – назначить СКЗИ с идентификатором 8 на пользователя evgeniy.belov@demо.cоm.

`PUT /Skzi/{id}`

Позволяет перевести СКЗИ из текущего состояния в следующие состояния по жизненному циклу. Перед изменением состояния СКЗИ рекомендуем назначить СКЗИ на пользователя.

СКЗИ может находиться в следующих состояниях: Created (изготовлено), Assigned (назначено), Sent (передано), Returned (возвращено), Issued (выдано), Installed (установлено), Destructed/Withdrawn (уничтожено/изъято).

Возможности изменения состояний СКЗИ:

Created или Assigned можно перевести в Sent, Returned, Issued, Installed;
Sent можно перевести в Returned, Issued, Installed;
Returned можно перевести в Issued, Installed;
Issued можно перевести в Installed.

СКЗИ в состоянии Destructed/Withdrawn нельзя перевести в другое состояние – оно завершает свой жизненный цикл. СКЗИ в состоянии Installed можно только уничтожить/изъять.

предупреждение

Состояние Sent должно передаваться во всех запросах на изменение состояния СКЗИ. Например, нельзя перевести СКЗИ из состояния Created в Installed, если в теле запроса нет параметра sendingData.

Параметры тела запроса

Объект	Параметр	Описание
`id`		Идентификатор СКЗИ.
`sendingData`– информация о передаче СКЗИ	`recipient`	ФИО сотрудника, который подтверждает получение СКЗИ.
	`timeSent`	Время отправления документа. Указывается в формате yyyyMMddHHmmss (UTC). Если значение не указано, то подставляется текущее время.
	`timeConfirmed`	Время подтверждения получения. Указывается в формате yyyyMMddHHmmss (UTC). Если значение не указано, то подставляется текущее время.
	`confirm`	Укажите значение: - true, чтобы сформировать документ, подтверждающий получение СКЗИ; - false, чтобы документ, подтверждающий получение СКЗИ, не формировался.
	`confirmationDocNumber`	Номер документа о подтверждении получения СКЗИ. Если номер документа не указан, то номер генерируется по шаблону, настроенному для конкретного типа СКЗИ в разделе Конфигурация→СКЗИ→Нормативные документы.
`returnData`– информация о возврате СКЗИ	`timeReturned`	Время возврата СКЗИ. Указывается в формате yyyyMMddHHmmss (UTC). Если значение не указано, то подставляется текущее время.
	`timeConfirmed`	Время подтверждения получения СКЗИ. Указывается в формате yyyyMMddHHmmss (UTC). Если значение не указано, то подставляется текущее время.
	`confirm`	Укажите значение: - true, чтобы сформировать документ о подтверждении получения СКЗИ; - false, чтобы не формировать документ о подтверждении получения СКЗИ.
	`confirmationDocNumber`	Номер документа о подтверждении получения СКЗИ. Если номер документа не указан, то номер генерируется по шаблону, настроенному для конкретного типа СКЗИ в разделе Конфигурация→СКЗИ→Нормативные документы.
`issueData` – информация о выдаче СКЗИ	`timeIssued`	Время выдачи СКЗИ. Указывается в формате yyyyMMddHHmmss (UTC). Если значение не указано, то подставляется текущее время.
`installationData`– информация об установке СКЗИ	`installer`	ФИО сотрудников органа криптографической защиты, пользователей СКЗИ, производивших установку СКЗИ. Имена указываются в формате Common name через запятую.
	`timeInstalled`	Время установки СКЗИ. Указывается в формате yyyyMMddHHmmss (UTC). Если значение не указано, то подставляется текущее время.
	`hardwareId`	Номер аппаратного средства, на котором установлено или к которому подключено СКЗИ.
	`location`	Место установки СКЗИ.
`comment`		Примечание.
`customFields`	`id`	Идентификатор атрибута, который подставляется в шаблоны печати нормативных документов.
`customFields`	value	Отображаемое имя поля в журнале СКЗИ.

Пример тела запроса для перевода СКЗИ из Created в Installed
{
  "sendingData": {
    "recipient": "evgeniy.belov@demo.com",
    "timeSent": "2024-11-11T14:24:16.641Z",
    "timeConfirmed": "2024-11-11T14:24:16.641Z",
    "confirm": true,
    "confirmationDocNumber": "3"
},
  "installationData": {
    "installer": "Никифорова Ольга Петровна",
    "timeInstalled": "2024-11-11T14:24:16.641Z",
    "hardwareId": "PF3N9LFM",
    "location": "г. Москва, ул. Примерная, д. 9, каб. 368"
  },
}

В примере тела запроса для перевода СКЗИ из состония Created в Installed пропущены состояния Returned и Issued. Если вам необходимо внести информацию об СКЗИ в состояниях Returned и Issued, вы можете прописать значения параметров returnData и issueData в теле запроса:

  "sendingData": {
    "recipient": "evgeniy.belov@demo.com",
    "timeSent": "2024-11-11T14:24:16.641Z",
    "timeConfirmed": "2024-11-11T14:24:16.641Z",
    "confirm": true,
    "confirmationDocNumber": "4"
  },
  "returnData": {
    "timeReturned": "2024-12-04T16:11:05.247Z",
    "timeConfirmed": "2024-12-04T16:11:05.247Z",
    "confirm": true,
    "confirmationDocNumber": "5"
  },
  "issueData": {
    "timeIssued": "2024-12-04T16:11:05.247Z"
  },
  "installationData": {
    "installer": "Никифорова Ольга Петровна",
    "timeInstalled": "2024-11-11T14:24:16.641Z",
    "hardwareId": "PF3N9LFM",
    "location": "г. Москва, ул. Примерная, д. 9, каб. 368"
  }

`DELETE /Skzi/{id}`

Позволяет уничтожить/изъять СКЗИ.

Параметры запроса

Параметр	Обязательно/необязательно	Значение
`id`	Required	Идентификатор СКЗИ.
`reuse`	Optional	Укажите значение: - true, чтобы изъять СКЗИ у пользователя и использовать повторно – например, для другого пользователя; - false, чтобы уничтожить СКЗИ. Значение по умолчанию – false.
`destructor`	Optional	ФИО сотрудников органа криптографической защиты, пользователей СКЗИ, производивших уничтожение/изъятие СКЗИ. Имена указываются в формате Common name через запятую.
`timeDestructed`	Optional	Время уничтожения/изъятия. Указывается в формате yyyyMMddHHmmss (UTC). Если значение не указано, то подставляется текущее время.

Пример запроса

http://localhost/cm/api/Skzi/5?reuse=false&destructor=evgeniy.belov%40demo.com – уничтожить СКЗИ с идентификатором 5. Пользователь, производивший уничтожение – evgeniy.belov@dеmo.com.

GET /Skzi​

POST /Skzi​

GET /Skzi/Types​

GET /Skzi/{id}​

PUT /Skzi/{id}/Assign​

PUT /Skzi/{id}​

DELETE /Skzi/{id}​

`GET /Skzi`

`POST /Skzi`

`GET /Skzi/Types`

`GET /Skzi/{id}`

`PUT /Skzi/{id}/Assign`

`PUT /Skzi/{id}`

`DELETE /Skzi/{id}`