...
Назначение
RutokenKeyBox Набор API— это набор -функций , который позволяет управлять устройствами (USB-токенами, смарт-картами) средствами клиентских приложений.
Использование
Доступ к этим API-функциям реализован осуществляется через веб-приложение icmapi API, входящее в состав сервера RutokenKeyBox по адресу: https://<FQDN сервера RutokenKeyBox>/cm/api.
Для взаимодействия с RutokenKeyBox РутокенKeyBox через API в разделе Конфигурация -> Роли консоли управления необходимо создать сервисную роль и , включить в нее учетную запись, от имени которой будет производиться обращение по API, и определить для роли список привилегийпривилегии:
- Поиск пользователей;.
- Просмотр репозитория устройств;Отзыв устройства;.
- Выключение устройства;.
- Включение устройства;.
- Обновление устройства.
Запросы
Получить список устройств
...
- Сброс PIN-кода.
- Блокировка устройства.
- Отзыв устройства.
- Удаление задачи.
1. Cards –
...
получить список устройств, добавленных в систему.
Тип запроса:
- GET
Параметры:
- без указания параметров
...
...
- offset - сдвиг на указанное количество устройств
...
...
- count - количество выводимых устройств
...
- serialNumber - серийный номер устройства
...
- cardTypeName - тип устройств
- userName -
...
- имя пользователя устройства в формате Логин (sAMAccountName) или UPN (userPrincipalName)
...
- comment -
...
- комментарий к устройствам
...
- tags - теги устройств
...
- filter.
...
- state - состояние устройств:
- state - состояние устройств:
...
- – Clean - пустое
– Assigned - назначено
– Pending - в ожидании
– Issued - выпущено
– Disabled - выключено
– Revoked - отозвано
- – Clean - пустое
- contentExpirationStatus - статус истечения содержимого устройства:
- 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
- userId - идентификатор пользователя, на которого назначено устройство
- userName - имя пользователя устройства в формате имени входа нижнего уровня (DOMAIN\LogonName)
- policyId - идентификатор политики использования устройства
- policyName - название политики использования устройства
- certificates:
- type - тип сертификата
- serialNumber - серийный номер сертификата
- thumbprint - отпечаток сертификата
- subject - общее имя (CN) субъекта сертификата
- issuer - общее имя (CN) издателя сертификата
- validTo - срок действия сертификата в формате ISO 8601
Пример вызова
Примеры запросов
...
:
...
...
- вывод 50 всех устройств без сдвига:
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.
– 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 }
Info Пример вызова:
http://localhost/cm/api/Сards/1013/Revoke?reason=CardWithdraw
- Причина отзыва устройства - например { reason: 5 }
3. Cards/{id}/Disable - временно отключить устройство пользователя.
Тип запроса:
- POST
Параметры:
- id - идентификатор устройства
Возвращаемые значения:
- нет
| Info |
|---|
Пример вызова: |
4. Cards/{id}/Enable - включить устройство пользователя.
Тип запроса:
- POST
Параметры:
- id - идентификатор устройства
Возвращаемые значения:
- нет
| Info |
|---|
Пример вызова: |
5. Cards/{id}/Preupdate - отозвать неактуальный сертификат пользователя.
| Warning |
|---|
Метод Preupdate необходим при изменении политики использования устройств. Если выпущенный сертификат не поддерживается в новой политике и включена опция Отзывать сертификат при отзыве/выключении устройства в шаблоне сертификата в старой политике, то он будет отозван. Метод Preupdate нельзя выполнить для выключенного, назначенного, отозванного и ожидающего выпуск или обновление устройства. |
Тип запроса:
- POST
Параметры:
- id - идентификатор устройства
Возвращаемые значения:
- нет
| Info |
|---|
Пример вызова: |
Возвращаемые значения: нет.
...
...
...
...
...