You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 21 Next »

Назначение

Набор API-функций позволяет управлять устройствами (токенами, смарт-картами) средствами клиентских приложений.

Использование

Доступ к API-функциям реализован через веб-приложение icmapi, входящее в состав сервера Indeed Certificate Manager. Для взаимодействия с Indeed CM через API в разделе Роли в конфигурации Indeed CM потребуются создать сервисную роль, включить в нее учетную запись, от имени которой будет производиться обращение по API, и определить для роли привилегии:

  • Поиск пользователей
  • Просмотр репозитория устройств
  • Отзыв устройства
  • Выключение устройства
  • Включение устройства
  • Обновление устройства

1. GetCards - получить список устройств пользователя.

Тип запроса:

    • GET

Параметры:

    • name - имя пользователя в формате UPN (user principal name)

Возвращаемые значения (cписок объектов CardInfo):

    • id - идентификатор устройства
    • serialNumber - серийный номер устройства
    • cardTypeName - тип устройства
    • cardModelName - модель устройства доступна только для устройств JaСarta, eToken PRO Java 72K и IDPrime MD, если в разделе Типы устройств для данных карт добавлено разделение по различным моделям
    • atr - Answer To Reset устройства
    • label - метка устройства
    • state - состояние устройства
    • formFactor - форм-фактор устройства
    • pacNumber - HID-метка устройства
    • expirationDate - срок действия устройства

Пример вызова:

http://localhost/icmapi/user/getcards?name=evgeniy.belov@demo.local

2. GetAllCards - получить список устройств, добавленных в систему.

Тип запроса:

    • GET

Параметры:

    • без указания параметров
    • offset - сдвиг на указанное количество устройств
    • count - количество выводимых устройств
    • filter.serialNumber -  серийный номер устройства
    • filter.cardTypeName - тип устройств
    • filter.comment - комментарий к устройствам
    • filter.tags - теги устройств
    • filter.state - состояние устройств:
      – Clean - пустое
      – Assigned - назначено
      – Pending - в ожидании
      – Issued - выпущено
      – Disabled - выключено
      – Revoked - отозвано
    • filter.contentExpirationStatus - статус истечения содержимого устройства:
      – None - нет истекающих или истекших сертификатов
      – ManagedCertificatesExpiring - управляемые сертификаты истекают
      – ManagedCertificatesExpired - управляемые сертификаты истекли
      – CommonCertificatesExpiring - общие сертификаты истекают
      – CommonCertificatesExpired - общие сертификаты истекли
      – TracedCertificatesExpiring - отслеживаемые сертификаты истекают
      – TracedCertificatesExpired - отслеживаемые сертификаты истекли

Возвращаемые значения (cписок объектов CardInfo):

    • id - идентификатор устройства
    • serialNumber - серийный номер устройства
    • cardTypeName - тип устройства
    • cardModelName - модель устройства доступна только для устройств JaСarta, eToken PRO Java 72K и IDPrime MD, если в разделе Типы устройств для данных карт добавлено разделение по различным моделям
    • atr - Answer To Reset устройства
    • label - метка устройства
    • comment - комментарий к устройству
    • tags - теги устройства
    • state - состояние устройства
    • formFactor - форм-фактор устройства
    • pacNumber - HID-метка устройства
    • expirationDate - срок действия устройства

Пример вызова:

http://localhost/icmapi/Card/GetAllCards - вывод всех устройств
http://localhost/icmapi/Card/GetAllCards?offset=0&count=50 - вывод 50 устройств без сдвига

3. Revoke - отозвать устройство пользователя.

Тип запроса:

    • POST

Параметры:

    • id - идентификатор устройства

    • reason - причина отзыва устройства:

      – 0 - none
      – 1 - broken
      – 2 - lost
      – 3 - upgrade
      – 4 - expired
      – 5 - withdraw
      – 6 - user removed
      – 7 - compromised

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

    • нет

Пример вызова:

http://localhost/icmapi/card/revoke?id=id1

Тело запроса:

    • Причина отзыва устройства - например, { reason: 5 }

4. Disable - временно отключить устройство пользователя.

Тип запроса:

    • POST

Параметры:

    • id - идентификатор устройства

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

    • нет

Пример вызова:

http://localhost/icmapi/card/disable?id=id1

5. Enable - включить устройство пользователя.

Тип запроса:

    • POST

Параметры:

    • id - идентификатор устройства

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

    • нет

Пример вызова:

http://localhost/icmapi/card/enable?id=id1

6. Preupdate - отозвать неактуальный сертификат пользователя.

Метод Preupdate необходим при изменении политики использования устройств. Если в новой политике не поддерживается выпущенный сертификат, то он будет удален.

Метод Preupdate нельзя выполнить для выключенного, назначенного, отозванного и ожидающего выпуск или обновление устройства.

Тип запроса:

    • POST

Параметры:

    • id - идентификатор устройства

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

    • нет

Пример вызова:

http://localhost/icmapi/card/preupdate?id=id1


  • No labels