Устройства
При работе с устройствами через API вам доступны следующие операции:
- получить список устройств по заданным фильтрам;
- найти устройство по идентификатору;
- отозвать устройство;
- изъять отозванное устройство;
- временно отключить устройство;
- включить устройство;
- отозвать неактуальный сертификат пользователя.
GET /Cards
Возвращает список устройств по заданным фильтрам.
Параметры запроса
| Параметр | Описание |
|---|---|
userName | Имя пользователя в формате DOMAIN\LogonName или User principal name (UPN). |
policyName | Название политики, действующей на устройство. |
serialNumber | Серийный номер устройства. |
cardTypeName | Название типа устройства. |
cardModelName | Название модели устройства. Значение выводится только для устройств Рутокен, JaCarta, eToken PRO Java 72K и IDPrime MD, если в разделе Типы устройств для данных устройств заданы отдельные настройки для различных моделей. |
comment | Комментарий. |
tags | Теги. |
state | Состояние устройства: - Clean – пустое; - Assigned – назначено; - Pending – в ожидании; - Issued – выпущено; - Disabled – выключено; - Revoked – отозвано. |
contentExpirationStatus | Информация об истечении срока действия сертификатов на устройстве: - None – нет истекающих или истекших сертификатов; - ManagedCertificatesExpiring – управляемые сертификаты истекают; - ManagedCertificatesExpired – управляемые сертификаты истекли; - CommonCertificatesExpiring – общие сертификаты истекают; - CommonCertificatesExpired – общие сертификаты истекли; - TracedCertificatesExpiring – отслеживаемые сертификаты истекают; - TracedCertificatesExpired – отслеживаемые сертификаты истекли. |
timeIssued | Время выпуска устройства в формате ISO 8601. Например: 2024-12-03T11:22:20.1824104Z, 2024-12-03. |
timeUpdated | Время обновления устройства в формате ISO 8601. |
timeRevoked | Время отзыва устройства в формате ISO 8601. |
offset | Сдвиг на указанное количество устройств. |
count | Количество устройств, информация о которых передается в ответе. |
Возвращаемые значения
| Параметр | Описание |
|---|---|
id | Идентификатор устройства. |
serialNumber | Серийный номер устройства. |
cardTypeName | Название типа устройства. |
cardModelName | Название модели устройства. Указывается только для устройств Рутокен, JaCarta, eToken PRO Java 72K и IDPrime MD, если в разделе Типы устройств для данных устройств заданы отдельные настройки для различных моделей. |
atr | Answer To Reset устройства. |
label | Метка устройства. |
comment | Комментарий. |
tags | Теги. |
state | Состояние устройства. |
formFactor | Форм-фактор устройства. |
pacNumber | HID-метка устройства. |
expirationDate | Срок действия устройства. |
timeIssued | Время выпуска устройства. |
timeDisabled | Время выключения устройства. |
timeUpdated | Время обновления устройства. |
timeRevoked | Время отзыва устройства. |
userId | Идентификатор пользователя, на которого назначено устройство. |
userName | Имя пользователя устройства в формате DOMAIN\LogonName или User principal name (UPN). |
policyId | Идентификатор политики, действующей на устройство. |
policyName | Название политики, действующей на устройство. |
certificates | type – тип сертификата;serialNumber – серийный номер сертификата;thumbprint – отпечаток сертификата;subject – общее имя (CN) субъекта сертификата;issuer – общее имя (CN) издателя сертификата;validFrom- дата начала срока действия сертификата в формате ISO 8601;validTo – дата окончания срока действия сертификата в формате ISO 8601. |
http://localhost/cm/api/Cards – вывод всех устройств;
http://localhost/cm/api/Cards?offset=0&count=50 – вывод 50 устройств без сдвига.
GET /Cards/{id}
Возвращает информацию об устройстве по его идентификатору.
Параметры запроса: id – идентификатор устройства.
http://localhost/cm/api/Cards/1
POST /Cards/{id}/Revoke
Позволяет отозвать устройство.
Параметры запроса
| Параметр | Обязательно/необязательно | Описание |
|---|---|---|
id | Required | Идентификатор устройства. |
reason | Optional | Причина отзыва устройства: - 0 – -- – причина отзыва не указана;- 1 – CardBroken – устройство неисправно; - 2 – CardLost – устройство утеряно; - 3 – CardUpgrade – обновление устройства; - 4 – CardExpired – истечение срока действия устройства; - 4 – CardWithdraw – изъятие устройства; - 5 – UserRemoved – пользователь удален; - 6 – CardCompromised – компрометация устройства. |
http://localhost/cm/api/cards/1/revoke
POST /Cards/{id}/Withdraw
Позволяет изъять отозванное устройство. При изъятии устройство не очищается.
Чтобы изъять устройство, оно должно находиться в состоянии Отозвано (Revoked).
Параметры запроса
| Параметр | Обязательно/необязательно | Описание |
|---|---|---|
id | Required | Идентификатор устройства. |
destructor | Optional | Если в Indeed CM ведется учет СКЗИ, и устройство является СКЗИ, при изъятии можно указать ФИО сотрудников органа криптографической защиты, пользователей СКЗИ, производивших уничтожение/изъятие СКЗИ. Имена указываются в формате Common name через запятую. |
http://localhost/cm/api/cards/1/withdraw
POST /Cards/{id}/Disable
Позволяет временно отключить устройство.
Параметры запроса: id – идентификатор устройства.
http://localhost/cm/api/cards/1/disable
POST /Cards/{id}/Enable
Позволяет включить устройство.
Параметры запроса: id – идентификатор устройства.
http://localhost/cm/api/cards/1/enable
POST /Cards/{id}/Preupdate
Позволяет отозвать неактуальный сертификат пользователя.
Параметры запроса: id – идентификатор устройства.
http://localhost/cm/api/cards/1/preupdate
Метод Preupdate можно использовать при изменении политики использования устройств. Если выпущенный сертификат не поддерживается в новой политике и в шаблоне сертификата в старой политике включена опция Отзывать сертификат при отзыве/выключении устройства, то сертификат отзывается.
Метод Preupdate нельзя выполнить для выключенного, назначенного, отозванного и ожидающего выпуск или обновление устройства.