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. GetCardsCards - получить список устройств пользователя, добавленных в систему.
Тип запроса:
- GET
Параметры:
- без указания параметров
- offset - сдвиг на указанное количество устройств
- count - количество выводимых устройств
- filter.serialNumber - серийный номер устройства
- filter.cardTypeName - тип устройств
- filter.userName Name - имя пользователя устройства в формате UPN (user principal name)
Возвращаемые значения (cписок объектов CardInfo):
- atr - ATR устройства
- expirationDate - срок действия устройства
- formFactor - форм-фактор устройства
- id - идентификатор устройства
- label - метка устройства
- pacNumber - HID-метка устройства
- serialNumber - серийный номер устройства
- state - состояние устройства
Info | ||||
---|---|---|---|---|
| ||||
http://localhost/icmapi/user/getcards?name=user1 |
2. GetAllCards - получить список устройств, добавленных в систему.
Тип запроса:
- GET
Параметры:
- формате Логин (sAMAccountName) или UPN (userPrincipalName)
- filter.comment - комментарий к устройствам
- filter.tags - теги устройств
- filter.state - состояние устройств:
– Clean - пустое
– Assigned - назначено
– Pending - в ожидании
– Issued - выпущено
– Disabled - выключено
– Revoked - отозвано - filter.contentExpirationStatus - статус истечения содержимого устройства:
– None - нет истекающих или истекших сертификатов
– ManagedCertificatesExpiring - управляемые сертификаты истекают
– ManagedCertificatesExpired - управляемые сертификаты истекли
– CommonCertificatesExpiring - общие сертификаты истекают
– CommonCertificatesExpired - общие сертификаты истекли
– TracedCertificatesExpiring - отслеживаемые сертификаты истекают
– TracedCertificatesExpired - отслеживаемые сертификаты истекли - без указания параметров
- offset=&count= - вывод указанного количества устройств со сдвигом
– offset - сдвиг на указанное количество устройств
– count - количество выводимых устройств
Возвращаемые значения (cписок объектов CardInfo):
- atr id - ATR идентификатор устройства
- expirationDate serialNumber - срок действия серийный номер устройства
- formFactor - форм-фактор устройства
- cardTypeName - тип устройства
- cardModelName - модель устройства (доступна только для устройств JaСarta, eToken PRO Java 72K и IDPrime MD, если в разделе Типы устройств для данных карт добавлено разделение по различным моделям)
- atr - Answer To Reset id - идентификатор устройства
- label - метка устройстваpacNumber - HID-
- comment - комментарий к устройству
- tags - теги метка устройства
- serialNumber state - серийный номер состояние устройстваstate
- formFactor - форм- состояние фактор устройства
- pacNumber - HID-метка устройства
- expirationDate - срок действия устройства
Info | ||||||
---|---|---|---|---|---|---|
| ||||||
Code Block | ||||||
| ||||||
http://localhost/icmapi/ Card/GetAllCards - вывод всех устройствCards - вывод всех устройств Cards?offset=0&count=50 - вывод 50 устройств без сдвига |
Info | ||||
---|---|---|---|---|
| ||||
3. 2. Cards/{id}/Revoke - отозвать устройство пользователя.
Тип запроса:
- POST
Параметры:
- id - идентификатор устройства
reason - причина отзыва устройства:
– 0 - noneNone
– 1 - broken CardBroken
– 2 - lostCardLost
– 3 - upgradeCardUpgrade
– 4 - expiredCardExpired
– 5 - withdrawCardWithdraw
– 6 - user removedUserRemoved
– 7 - compromisedCardCompromised
Возвращаемые значения:
- нет
Info | ||||
---|---|---|---|---|
| ||||
http://localhost/icmapi/cards/card1/revoke?id=id1 |
Тело запроса:
- Причина отзыва устройства - например , { reason: 5 }
Scroll Pagebreak |
---|
4. 3. Cards/{id}/Disable - временно отключить устройство пользователя.
Тип запроса:
- POST
Параметры:
- id - идентификатор устройства
Возвращаемые значения:
- нет
Info | ||||
---|---|---|---|---|
| ||||
http://localhost/icmapi/cardcards/1/disable?id=id1 |
5. 4. Cards/{id}/Enable - включить устройство пользователя.
Тип запроса:
- POST
Параметры:
- id - идентификатор устройства
Возвращаемые значения:
- нет
Info | ||||
---|---|---|---|---|
| ||||
http://localhost/icmapi/cards/card1/enable?id=id1 |
6. 5. Cards/{id}/Preupdate - отозвать неактуальный сертификат пользователя.
Warning |
---|
Метод Preupdate необходим при изменении политики использования устройств. Если выпущенный сертификат не поддерживается в новой политике не поддерживается выпущенный сертификати включена опция Отзывать сертификат при отзыве/выключении устройства в шаблоне сертификата в старой политике, то он будет удаленотозван. Метод Preupdate нельзя выполнить для выключенного, назначенного, отозванного и ожидающего выпуск или обновление устройства. |
Тип запроса:
- POST
Параметры:
- id - идентификатор устройства
Возвращаемые значения:
- нет
Info | ||||
---|---|---|---|---|
| ||||
http://localhost/icmapi/cardcards/1/preupdate?id=id1 |