Page History

Назначение

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

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

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

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

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

Тип запроса:

• • GET

Параметры:

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

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

,

добавленных в систему.

Тип запроса:

• • GET

Параметры:

• • без указания параметров
  • offset - сдвиг на указанное количество устройств
  • count - количество выводимых устройств
  • filter.serialNumber -  серийный номер устройства
  • filter.cardTypeName - тип устройств
  • filter.userName - имя пользователя устройства в формате Логин (sAMAccountName) или Логин (sAMAccountName)
  • 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 - срок действия устройства

3. 2. Cards/{id}/Revoke - отозвать устройство пользователя.

Тип запроса:

• • POST

Параметры:

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

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

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

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

• • нет

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

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

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

Тип запроса:

• • POST

Параметры:

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

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

• • нет

5. 4. Cards/{id}/Enable - включить устройство пользователя.

Тип запроса:

• • POST

Параметры:

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

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

• • нет

6. 5. Cards/{id}/Preupdate - отозвать неактуальный сертификат пользователя.

Тип запроса:

• • POST

Параметры:

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

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

• • нет