Перейти к основному содержимому

API

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

Доступ к API-функциям осуществляется через веб-приложение API.

Приложение API входит в состав сервера Indeed Certificate Manager и доступно по адресу: https://<FQDN сервера Indeed CM>/cm/api.

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

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

Cards​

Получить список устройств, добавленных в Indeed CM.

Тип запроса: GET.

Параметры:

  • без указания параметров;
  • offset – сдвиг на указанное количество устройств;
  • count – количество выводимых устройств;
  • serialNumber –  серийный номер устройства;
  • cardTypeName – тип устройств;
  • userName – имя пользователя устройства в форматах имени входа нижнего уровня (DOMAIN\LogonName) или имени участника-пользователя (UPN);
  • comment – комментарий к устройствам;
  • tags – теги устройств;
  • state – состояние устройств:
    • сlean – пустое;
    • assigned – назначено;
    • pending – в ожидании;
    • issued – выпущено;
    • disabled – выключено;
    • revoked – отозвано;
  • contentExpirationStatus – статус истечения содержимого устройства:
    • None – нет истекающих или истекших сертификатов;
    • ManagedCertificatesExpiring – управляемые сертификаты истекают;
    • ManagedCertificatesExpired – управляемые сертификаты истекли;
    • CommonCertificatesExpiring – общие сертификаты истекают;
    • CommonCertificatesExpired – общие сертификаты истекли;
    • TracedCertificatesExpiring – отслеживаемые сертификаты истекают;
    • TracedCertificatesExpired – отслеживаемые сертификаты истекли.

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

  • id – идентификатор устройства;
  • serialNumber – серийный номер устройства;
  • cardTypeName – тип устройства;
  • cardModelName – модель устройства (доступна только для устройств JaСarta, eToken PRO Java 72K и IDPrimeMD, если в разделе Типы устройств для данных карт добавлено разделение по различным моделям);
  • 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;
  • userId – идентификатор пользователя, на которого назначено устройство;
  • userName – имя пользователя устройства в формате имени входа нижнего уровня (DOMAIN\UserNameLogonName);
  • policyId – идентификатор политики использования устройства;
  • policyName – название политики использования устройства;
  • certificates:
    • type – тип сертификата;
    • serialNumber – серийный номер сертификата;
    • thumbprint – отпечаток сертификата;
    • subject – общее имя (CN) субъекта сертификата;
    • issuer – общее имя (CN) издателя сертификата;
    • validTo – срок действия сертификата в формате ISO 8601.
Пример вызова

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

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 }.

Cards/{id}/Disable​

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

Тип запроса: POST.
Параметры: id – идентификатор устройства.
Возвращаемые значения: нет.

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

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

Cards/{id}/Enable​

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

Тип запроса: POST.
Параметры: id – идентификатор устройства.
Возвращаемые значения: нет.

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

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

Cards/{id}/Preupdate​

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

предупреждение

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

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

Тип запроса: POST.
Параметры: id – идентификатор устройства.
Возвращаемые значения: нет.

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

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