Skip to main content

TemplateSession

Информация

Пример функций на PowerShell: ссылка

createTemplate​

Создает шаблон для аутентфиикации по идентификатору открытой сессии.

[POST] /api/v5/templateSession/createTemplate
Объект запроса
{
 "SessionId": "00000000-0000-0000-0000-000000000000"
}

в объекте запроса:

  • SessionId — обязательный параметр. Указывается GUID открытой сессии, полученный из метода openVerifySession. 
Объект ответа
"00000000-0000-0000-0000-000000000000"

openEnrollSession​

[POST] /api/v5/templateSession/openEnrollSession

openVerifySession​

Открывает сессию для аутентификации пользователя, указанного в UserSearchParams в приложении ApplicationId, с использованием способа аутентфикации ModeId.

[POST] /api/v5/templateSession/openVerifySession
Объект запроса
{
  "UserSearchParams": {
    "Id": "string",
    "Email": "string",
    "Phone": "string",
    "NameFormat": 0,
    "Name": "string",
    "ApplicationId": "string"
  },
  "ModeId": "00000000-0000-0000-0000-000000000000",
  "ApplicationId": "string"
}

в объекте запроса:

  • UserSearchParams — массив параметров для поиска пользователя;
    • Id — внутренний идентификатор пользователя в Indeed AM;
    • Email — еmail пользователя из каталога Active Directory;
    • Phone — номер телефона пользователя из каталога Active Directory;
    • NameFormat — числовое значение формата имени, которое будет указано в Name. Поддерживаются следующие форматы: 
      • 0 — Undefined;
      • 1 — CanonicalName;
      • 2 — PrincipalName: name@domain.name;
      • 3 — SamCompatibleName: domain\logon-name;
      • 4 — DistinguishedName;
      • 5 — Sid;
  • ModeId — обязательный параметр. Строковый идентификатор используемого способа аутентификации.  
  • ApplicationId — обязательный параметр. Строковый идентификатор модуля Indeed AM. 
Объект ответа
GUID открытой сессии

"00000000-0000-0000-0000-000000000000"

openIdentifySession​

[POST] /api/v5/templateSession/openIdentifySession

prepareTemplateData​

Добавляет информацию о шаблоне пользователя. 

[POST] /api/v5/templateSession/prepareTemplateData
Объект запроса
{
  "Data": {},
  "SessionId": "00000000-0000-0000-0000-000000000000"
}

в объекте запроса:

  • Data — аутентификационные данные пользователя (одноразовый код или пароль или другие данные в зависимости от используемого способа аутентификации);
  • SessionId — идентификатор открытой сессии, полученный в openVerifySession.
Объект ответа
{
  "EnoughData": true,
  "BinaryData": "string",
  "StringData": "string"
}

в объекте ответа:

  • EnoughData — признак того, что данных от клиента для формирования шаблона достаточно.
Пример объекта ответа
{
  "ValidPropertiesMask": 1,
  "EnoughData": true,
  "BinaryData": null,
  "StringData": null
}