Общая информация
API Indeed AM предназначен для интеграции с приложениями.
В данном разделе описаны основные моменты и общие параметры, которые необходимы для использования API Indeed.
Запрос к API
Для обращения к методу необходимо выполнить запрос POST или, для некоторых методов, запрос
GET по http(s)://<dns_indeedam_server>/am/core/<url_api_method>,
где:
- dns_indeedam_server — полное DNS-имя сервера, где развернут Indeed Core Server;
- url_api_method — адрес соответствующего метода. Адреса указаны в документации к методу либо в Swagger.
Пример для
метода openVerifySession,
где DNS-имя сервера Indeed AM: indeedam.indeed.local:
https://indeedam.indeed.local/am/core/api/v6/templateSession/openVerifySession
При использовании протокола HTTPS загрузите на сервер Indeed AM действующий сертификат.
UserId
Уникальный идентификатор пользователя из системы Indeed.
Идентификатор состоит из строкового ID, указанного в app-settings.json AM в параметре userId, и objectGuid пользователя из Active Directory.
Например, в параметре userId указано значение GUID пользователя 10efa04f-7ba9-47d8-89db-56e166f1679f. UserId пользователя будет UserId\_10efa04f-7ba9-47d8-89db-56e166f1679f.
Для получения userId можно воспользоваться методом [POST]/api/v6/user/searchUserId.
modeId
Уникальный идентификатор способа аутентификации Indeed.
Способы аутентификации:
- Indeed AM Windows Password Provider {CF189AF5-01C5-469D-A859-A8F2F41ED153}
- Indeed AM Passcode Provider {F696F05D-5466-42b4-BF52-21BEE1CB9529}
- Indeed AM Email OTP Provider {093F612B-727E-44E7-9C95-095F07CBB94B}
- Indeed AM Hardware TOTP Provider {CEB3FEAF-86ED-4A5A-BD3F-6A7B6E60CA05}
- Indeed AM HOTP Provider {CEB3FEAF-86ED-4A5A-BD3F-6A7B6E60CA05}
- Indeed AM Storage SMS OTP Provider {3F2C1156-B5AF-4643-BFCB-9816012F3F34}
- Indeed AM SMS OTP Provider {EBB6F3FA-A400-45F4-853A-D517D89AC2A3}
- Indeed AM Software OTP Provider {0FA7FDB4-3652-4B55-B0C0-469A1E9D31F0}
- Indeed Key Provider {DEEF0CB8-AD2F-4B89-964A-B6C7ECA80C68}
- Indeed AM MFA Provider {070719BA-EB57-4EA8-BB4D-D15A33E7363D}
ApplicationId
Внутренний модуль
Для работы с внутренним модулем не требуется лицензия, достаточно иметь права на операции, предоставляемые внутренними модулями.
Функциональность Access Manager разбита на группы, за которые отвечают внутренние модули. Они реализуют внутреннюю бизнес-логику решения. Их строковые идентификаторы используются для обращения к разным частям API Core Server.
Внутренние модули Core Server:
- User Profile Setting Management
- User Access Control Management
- Hardware Devices Management
- License Management
- Authenticator Management
- Authenticator Enrollment
- User Accounts Management
- Policy Management
- User Cache Management
- Business Applications Management
Кроме того, есть еще набор внутренних приложений:
- Enterprise Management Console
- Self Service
- Native Enroller
Модуль интеграции
Для работы с модулями интеграции требуется лицензия для соответствующего модуля.
Это модуль, реализующий взаимосвязь Access Manager и внешних систем, с которыми выполняется интеграция. К ним относятся:
- Windows Logon
- FreeRADIUS Extension
- Identity Provider
- ADFS Extension
- RDP Windows Logon
- Authentication API
Идентификатор политики
Чтобы узнать идентификатор политик:
- Откройте Management Console.
- Перейдите на вкладку Политики.
- Выберите целевую политику.
- Скопируйте идентификатор политики из параметра
policyIdв URL.