Versions Compared

Old Version 29

changes.mady.by.user Vladislav Fomichev

Saved on

compared with

New Version 30

changes.mady.by.user Vladislav Fomichev

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

isAvailable

[POST] /api/v5/logon/isAvailable

Info

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

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


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

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

Ответ

true\false


authenticate

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

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

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

getAvailableMethods

[POST] /api/v5/logon/getAvailableMethods

Info

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

  • В параметре "ApplicationId" указывается идентификатор приложения.
  • В параметре "UserId" указывается Id целевого пользователя. 
    • Параметр "IncludeModeIds"

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

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

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

    Code Block
    languagejs
    {
  "AutheticationMethods": [
    "00000000-0000-0000-0000-000000000000"
  ]
}

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

    Code Block
    languagejs
    titleНет доступных методов 
    {
  "ValidPropertiesMask": 1,
  "AutheticationMethods": []
}


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



    authenticateByWindowsToken

    [POST] /api/v5/logon/authenticateByWindowsToken

    Info

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

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

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


    Code Block
    languagejs
    {
  "ApplicationId": "string",
  "BusinessApplication": "string"
}

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

    Code Block
    languagejs
    {
  "Token": "string",
  "LogonResult": {
    "Result": "string"
  },
  "UserId": "string"
}

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

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




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


    Table of Contents
    classrightFloat