Общая информация

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

Доступ к этим функциям реализован через веб-приложение icmapi, входящее в состав сервера RutokenKeyBox.

Для взаимодействия с RutokenKeyBox через API необходимо создать сервисную роль и включить в нее учетную запись, от имени которой будет производиться обращение по API, и определить для роли список привилегий:

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

Запросы

Получить список устройств

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

Тип запроса:

GET

Параметры:

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

Возвращаемые значения (список объектов 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/Cards

вывод 50 устройств без сдвига:

http://localhost/icmapi/Cards?offset=0&count=50

Отозвать устройство