Open session to login user by login/password pair. Returns auth token in XML form, consumer should supply it to other web requests to authenticate.
Also returns platform version in Version header.
[HttpGetAttribute("open")]
[ProducesAttribute("application/json", new string[] { ... })]
[ConsumesAttribute("application/json", new string[] { ... })]
[ProducesResponseTypeAttribute(200)]
public Task<ActionResult<OpenSessionResponse>> GetOpen(
[FromQueryAttribute] string version,
[FromQueryAttribute] Guid? applicationID = null,
[FromQueryAttribute] string? login = null,
[FromQueryAttribute] string? password = null,
[FromQueryAttribute] string? cultureName = null,
[FromQueryAttribute] string? uiCultureName = null,
[FromQueryAttribute] string? deviceType = null,
[FromQueryAttribute] int? utcOffsetMinutes = null,
[FromQueryAttribute] string? osName = null,
[FromQueryAttribute] string? userAgent = null,
[FromQueryAttribute] bool? client64Bit = null,
[FromQueryAttribute] bool? client64BitOS = null,
[FromQueryAttribute] bool cookies = false,
[FromQueryAttribute] bool browser = false,
[FromQueryAttribute] bool support2fa = false,
CancellationToken cancellationToken = default
)
<HttpGetAttribute("open")>
<ProducesAttribute("application/json", New String() { ... })>
<ConsumesAttribute("application/json", New String() { ... })>
<ProducesResponseTypeAttribute(200)>
Public Function GetOpen (
<FromQueryAttribute> version As String,
<FromQueryAttribute> Optional applicationID As Guid? = Nothing,
<FromQueryAttribute> Optional login As String = Nothing,
<FromQueryAttribute> Optional password As String = Nothing,
<FromQueryAttribute> Optional cultureName As String = Nothing,
<FromQueryAttribute> Optional uiCultureName As String = Nothing,
<FromQueryAttribute> Optional deviceType As String = Nothing,
<FromQueryAttribute> Optional utcOffsetMinutes As Integer? = Nothing,
<FromQueryAttribute> Optional osName As String = Nothing,
<FromQueryAttribute> Optional userAgent As String = Nothing,
<FromQueryAttribute> Optional client64Bit As Boolean? = Nothing,
<FromQueryAttribute> Optional client64BitOS As Boolean? = Nothing,
<FromQueryAttribute> Optional cookies As Boolean = false,
<FromQueryAttribute> Optional browser As Boolean = false,
<FromQueryAttribute> Optional support2fa As Boolean = false,
Optional cancellationToken As CancellationToken = Nothing
) As Task(Of ActionResult(Of OpenSessionResponse))
public:
[HttpGetAttribute(L"open")]
[ProducesAttribute(L"application/json", __gc new array<String^>^ { ... })]
[ConsumesAttribute(L"application/json", __gc new array<String^>^ { ... })]
[ProducesResponseTypeAttribute(200)]
Task<ActionResult<OpenSessionResponse^>^>^ GetOpen(
[FromQueryAttribute] String^ version,
[FromQueryAttribute] Nullable<Guid> applicationID = nullptr,
[FromQueryAttribute] String^ login = nullptr,
[FromQueryAttribute] String^ password = nullptr,
[FromQueryAttribute] String^ cultureName = nullptr,
[FromQueryAttribute] String^ uiCultureName = nullptr,
[FromQueryAttribute] String^ deviceType = nullptr,
[FromQueryAttribute] Nullable<int> utcOffsetMinutes = nullptr,
[FromQueryAttribute] String^ osName = nullptr,
[FromQueryAttribute] String^ userAgent = nullptr,
[FromQueryAttribute] Nullable<bool> client64Bit = nullptr,
[FromQueryAttribute] Nullable<bool> client64BitOS = nullptr,
[FromQueryAttribute] bool cookies = false,
[FromQueryAttribute] bool browser = false,
[FromQueryAttribute] bool support2fa = false,
CancellationToken cancellationToken = CancellationToken()
)
[<HttpGetAttribute("open")>]
[<ProducesAttribute("application/json", new string[] { ... })>]
[<ConsumesAttribute("application/json", new string[] { ... })>]
[<ProducesResponseTypeAttribute(200)>]
member GetOpen :
[<FromQueryAttribute>] version : string *
[<FromQueryAttribute>] ?applicationID : Nullable<Guid> *
[<FromQueryAttribute>] ?login : string *
[<FromQueryAttribute>] ?password : string *
[<FromQueryAttribute>] ?cultureName : string *
[<FromQueryAttribute>] ?uiCultureName : string *
[<FromQueryAttribute>] ?deviceType : string *
[<FromQueryAttribute>] ?utcOffsetMinutes : Nullable<int> *
[<FromQueryAttribute>] ?osName : string *
[<FromQueryAttribute>] ?userAgent : string *
[<FromQueryAttribute>] ?client64Bit : Nullable<bool> *
[<FromQueryAttribute>] ?client64BitOS : Nullable<bool> *
[<FromQueryAttribute>] ?cookies : bool *
[<FromQueryAttribute>] ?browser : bool *
[<FromQueryAttribute>] ?support2fa : bool *
?cancellationToken : CancellationToken
(* Defaults:
let _applicationID = defaultArg applicationID null
let _login = defaultArg login null
let _password = defaultArg password null
let _cultureName = defaultArg cultureName null
let _uiCultureName = defaultArg uiCultureName null
let _deviceType = defaultArg deviceType null
let _utcOffsetMinutes = defaultArg utcOffsetMinutes null
let _osName = defaultArg osName null
let _userAgent = defaultArg userAgent null
let _client64Bit = defaultArg client64Bit null
let _client64BitOS = defaultArg client64BitOS null
let _cookies = defaultArg cookies false
let _browser = defaultArg browser false
let _support2fa = defaultArg support2fa false
let _cancellationToken = defaultArg cancellationToken new CancellationToken()
*)
-> Task<ActionResult<OpenSessionResponse>>