Назначение

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

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

Доступ к API-функциям осуществляется через веб-приложение API, входящее в состав сервера RutokenKeyBox по адресу: https://<FQDN сервера RutokenKeyBox>/cm/api.
Для взаимодействия с РутокенKeyBox через API в разделе Конфигурация -> Роли консоли управления необходимо создать сервисную роль, включить в нее учетную запись, от имени которой будет производиться обращение по API, и определить для роли привилегии:

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

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

Тип запроса:

• • 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 - отслеживаемые сертификаты истекли

Возвращаемые значения (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 - срок действия устройства в формате ISO 8601
  • timeIssued - время выпуска устройства в формате ISO 8601
  • timeDisabled - время выключения устройства в формате ISO 8601
  • timeUpdated - время обновления устройства в формате ISO 8601
  • timeRevoked - время отзыва устройства в формате ISO 8601

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

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

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

Тип запроса:

• • POST

Параметры:

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

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

    – 0 - None
    – 1 - CardBroken
    – 2 - CardLost
    – 3 - CardUpgrade
    – 4 - CardExpired
    – 5 - CardWithdraw
    – 6 - UserRemoved
    – 7 - CardCompromised

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

• • нет

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

http://localhost/cm/api/cards/1/revoke

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

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

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

Тип запроса:

• • POST

Параметры:

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

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

• • нет

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

http://localhost/cm/api/cards/1/disable

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

Тип запроса:

• • POST

Параметры:

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

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

• • нет

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

http://localhost/cm/api/cards/1/enable

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

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

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

Тип запроса:

• • POST

Параметры:

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

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

• • нет

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

http://localhost/cm/api/cards/1/preupdate