Информация

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

isAvailable

[POST] /api/v5/logon/isAvailable

Метод выполняет проверка доступности аутентфиикации пользователя в приложении.

  • В параметре "ApplicationId" указывается идентификатор приложения.
  • В параметре "UserId" указывается Id целевого пользователя. 
  • В параметре "ExcludeWindowsPassword" указывается true\false.
    • Если указано "true", значит из проверки исключается возможность аутентификации по доменному паролю. В таком случае у пользователя должен быть доступен любой другой метод аутентификации, иначе запрос вернет "false".
    • Если указано "false", доменный пароль не исключается из возможных способов аутентификации в сценарии. 


Объект запроса

  • ApplicationId - Обязательный параметр. Строковый идентификатор модуля Indeed AM. 
  • UserId - Обязательный параметр. Идентификатор пользователя в системе Indeed AM. 
  • ExcludeWindowsPassword - Опциональный параметр. Значение по умолчанию "true". 
{
  "ApplicationId": "string",
  "UserId": "string",
  "ExcludeWindowsPassword": true
}

Ответ

true\false


authenticate

[POST] /api/v5/logon/authenticate

Метод выполняет аутентификацию пользователя в приложении "BusinessApplication" по зарегистрированному шаблону "TemplateId". 

Подробнее про процесс аутентификации через API описано в разделе "Сценарии использования"

Объект запроса

{
  "TemplateId": "00000000-0000-0000-0000-000000000000",
  "BusinessApplication": "string"
}

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

{
  "Token": "string",
  "LogonResult": {
    "Result": "string"
  },
  "UserId": "string"
}

Пример успешного объекта ответа

{
  "ValidPropertiesMask": 5,
  "Token": "eyJ0e----.eyJleH----",
  "LogonResult": {
    "ValidPropertiesMask": 0,
    "Result": null
  },
  "UserId": "UserId_b1cfaa29-6368-4c50-9868-06dbbe21fe23"
}

getAvailableMethods

[POST] /api/v5/logon/getAvailableMethods

Метод возвращает массив доступных способов аутентификации для пользователя "UserId" в указанном в "ApplicationId" приложении. 

Объект запроса

  • ApplicationId - Обязательный параметр. Строковый идентификатор модуля Indeed AM. 
  • UserId - Обязательный параметр. Идентификатор пользователя в системе Indeed AM. 
  • IncludeModeIds - Опциональный параметр. GUID методов аутентификации Indeed, которые будут учитываться при проверке возможности аутентификации.
  • ExcludeModeIds - Опциональный параметр. GUID методов аутентификации Indeed, которые будут исключаться при проверке возможности аутентификации. 
{
  "ApplicationId": "string",
  "UserId": "string",
  "IncludeModeIds": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "ExcludeModeIds": [
    "00000000-0000-0000-0000-000000000000"
  ]
}

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

{
  "AutheticationMethods": [
    "00000000-0000-0000-0000-000000000000"
  ]
}

Пример ответов

Нет доступных методов 
{
  "ValidPropertiesMask": 1,
  "AutheticationMethods": []
}
Доступен доменный пароль
{
  "ValidPropertiesMask": 1,
  "AutheticationMethods": [
    "cf189af5-01c5-469d-a859-a8f2f41ed153"
  ]
}


authenticateByWindowsToken

[POST] /api/v5/logon/authenticateByWindowsToken

Аутентификация пользователя с использованием токена сессии Windows. Токен передается в запрос посредством Windows аутентификации и билетов Kerberos. 

Объект запроса

  • ApplicationId - Обязательный параметр. Строковый идентификатор модуля Indeed AM. 
  • BusinessApplication - Опциональный параметр. Имя бизнес приложения Indeed AM. 
{
  "ApplicationId": "string",
  "BusinessApplication": "string"
}

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

{
  "Token": "string",
  "LogonResult": {
    "Result": "string"
  },
  "UserId": "string"
}

Пример успешного объекта ответа

{
  "ValidPropertiesMask": 5,
  "Token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJleHAiOj.......",
  "LogonResult": null,
  "UserId": "UserId_10efa04f-7ba9-47d8-89db-56e166f1679f"
}



  • No labels