Logon

Информация

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

isAvailable

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

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

[POST] /api/v5/logon/isAvailable

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

{
  "ApplicationId": "string",
  "UserId": "string",
  "ExcludeWindowsPassword": true
} 

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

• ApplicationId — обязательный параметр. Строковый идентификатор модуля Indeed AM. 
• UserId — обязательный параметр. Идентификатор пользователя в Indeed AM. 
• ExcludeWindowsPassword — опциональный параметр. Значение по умолчанию true. 

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

true\false

authenticate

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

[POST] /api/v5/logon/authenticate

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

{
  "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

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

[POST] /api/v5/logon/getAvailableMethods

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

{
  "ApplicationId": "string",
  "UserId": "string",
  "IncludeModeIds": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "ExcludeModeIds": [
    "00000000-0000-0000-0000-000000000000"
  ]
}

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

• ApplicationId — обязательный параметр. Строковый идентификатор модуля Indeed AM. 
• UserId — обязательный параметр. Идентификатор пользователя в Indeed AM. 
• IncludeModeIds — опциональный параметр. GUID методов аутентификации Indeed, которые будут учитываться при проверке возможности аутентификации.
• ExcludeModeIds — опциональный параметр. GUID методов аутентификации Indeed, которые будут исключаться при проверке возможности аутентификации. 

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

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

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

Нет доступных методов

{
  "ValidPropertiesMask": 1,
  "AutheticationMethods": []
}

Доступен доменный пароль

{
  "ValidPropertiesMask": 1,
  "AutheticationMethods": [
    "cf189af5-01c5-469d-a859-a8f2f41ed153"
  ]
}

authenticateByWindowsToken

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

[POST] /api/v5/logon/authenticateByWindowsToken

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

{
  "ApplicationId": "string",
  "BusinessApplication": "string"
}

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

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

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

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

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

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