Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Назначение
Набор API-функций позволяет управлять устройствами (токенами, смарт-картами) средствами клиентских приложений.
Использование
Доступ к API-функциям реализован через веб-приложение icmapi, входящее в состав сервера Indeed Certificate Manager. Для взаимодействия с Indeed CM через API в разделе Роли в конфигурации Indeed CM потребуются создать сервисную роль, включить в нее учетную запись, от имени которой будет производиться обращение по API, и определить для роли привилегии:
- Поиск пользователей
- Просмотр репозитория устройств
- Отзыв устройства
- Выключение устройства
- Включение устройства
- Обновление устройства
1. GetCards - получить список устройств пользователя.
Тип запроса:
- GET
Параметры:
- Name name - имя пользователя в формате UPN (user principal name)
Возвращаемые значения (cписок объектов CardInfo):
- atr id - ATR идентификатор устройства
- expirationDate serialNumber - срок действия серийный номер устройства
- atr - ATR устройства
- label - метка formFactor - форм-фактор устройства
- id state - идентификатор состояние устройства
- label formFactor - форм- метка фактор устройства
- pacNumber - HID-метка устройства
- serialNumber expirationDate - серийный номер срок действия устройства
- state - состояние устройства
| Info | ||||
|---|---|---|---|---|
| ||||
http://localhost/icmapi/user/getcards?name=evgeniy.belov@demo.local |
2. GetAllCards - получить список устройств, добавленных в систему.
Тип запроса:
- GET
Параметры:
- без указания параметровoffset=&count= - вывод указанного количества устройств со сдвигом
- – offset - сдвиг на указанное количество устройств–
- count - количество выводимых устройств
Возвращаемые значения (cписок объектов CardInfo):
- atr id - ATR идентификатор устройства
- expirationDate serialNumber - срок действия серийный номер устройства
- atr - ATR устройства
- label - метка formFactor - форм-фактор устройства
- id state - идентификатор состояние устройства
- label formFactor - форм- метка фактор устройства
- pacNumber - HID-метка устройства
- serialNumber - серийный номер устройства
- state - состояние expirationDate - срок действия устройства
| Info | ||||
|---|---|---|---|---|
| ||||
http://localhost/icmapi/Card/GetAllCards - вывод всех устройств |
3. Revoke - отозвать устройство пользователя.
Тип запроса:
- POST
Параметры:
- id - идентификатор устройства
reason - причина отзыва устройства:
– 0 - none
– 1 - broken
– 2 - lost
– 3 - upgrade
– 4 - expired
– 5 - withdraw
– 6 - user removed
– 7 - compromised
Возвращаемые значения:
- нет
| Info | ||||
|---|---|---|---|---|
| ||||
http://localhost/icmapi/card/revoke?id=id1 |
Тело запроса:
- Причина отзыва устройства - например, { reason: 5 }
4. Disable - временно отключить устройство пользователя.
Тип запроса:
- POST
Параметры:
- id - идентификатор устройства
Возвращаемые значения:
- нет
| Info | ||||
|---|---|---|---|---|
| ||||
http://localhost/icmapi/card/disable?id=id1 |
5. Enable - включить устройство пользователя.
Тип запроса:
- POST
Параметры:
- id - идентификатор устройства
Возвращаемые значения:
- нет
| Info | ||||
|---|---|---|---|---|
| ||||
http://localhost/icmapi/card/enable?id=id1 |
6. Preupdate - отозвать неактуальный сертификат пользователя.
| Warning |
|---|
Метод Preupdate необходим при изменении политики использования устройств. Если в новой политике не поддерживается выпущенный сертификат, то он будет удален. Метод Preupdate нельзя выполнить для выключенного, назначенного, отозванного и ожидающего выпуск или обновление устройства. |
Тип запроса:
- POST
Параметры:
- id - идентификатор устройства
Возвращаемые значения:
- нет
| Info | ||||
|---|---|---|---|---|
| ||||
http://localhost/icmapi/card/preupdate?id=id1 |