Open session to login user by login/password pair. Returns session token in XML form, consumer should supply it to other web requests to authenticate.
Also returns platform version in Version header. And miniature auth token in Session header, that can be used to authenticate instead of token with excess info on the session, which is being returned as method result.
[HttpPostAttribute("open")]
[TypedJsonBodyAttribute(ConvertPascalCasing = true)]
[ConsumesAttribute("application/json", new string[] { ... })]
[ProducesAttribute("application/json", new string[] { ... })]
[ProducesResponseTypeAttribute(200)]
public Task<ActionResult<OpenSessionResponse>> PostOpen(
[FromBodyAttribute] OpenSessionRequest request,
[FromQueryAttribute] bool cookies = false,
[FromQueryAttribute] bool browser = false,
[FromQueryAttribute] bool support2fa = false,
CancellationToken cancellationToken = default
)
<HttpPostAttribute("open")>
<TypedJsonBodyAttribute(ConvertPascalCasing := true)>
<ConsumesAttribute("application/json", New String() { ... })>
<ProducesAttribute("application/json", New String() { ... })>
<ProducesResponseTypeAttribute(200)>
Public Function PostOpen (
<FromBodyAttribute> request As OpenSessionRequest,
<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:
[HttpPostAttribute(L"open")]
[TypedJsonBodyAttribute(ConvertPascalCasing = true)]
[ConsumesAttribute(L"application/json", __gc new array<String^>^ { ... })]
[ProducesAttribute(L"application/json", __gc new array<String^>^ { ... })]
[ProducesResponseTypeAttribute(200)]
Task<ActionResult<OpenSessionResponse^>^>^ PostOpen(
[FromBodyAttribute] OpenSessionRequest^ request,
[FromQueryAttribute] bool cookies = false,
[FromQueryAttribute] bool browser = false,
[FromQueryAttribute] bool support2fa = false,
CancellationToken cancellationToken = CancellationToken()
)
[<HttpPostAttribute("open")>]
[<TypedJsonBodyAttribute(ConvertPascalCasing = true)>]
[<ConsumesAttribute("application/json", new string[] { ... })>]
[<ProducesAttribute("application/json", new string[] { ... })>]
[<ProducesResponseTypeAttribute(200)>]
member PostOpen :
[<FromBodyAttribute>] request : OpenSessionRequest *
[<FromQueryAttribute>] ?cookies : bool *
[<FromQueryAttribute>] ?browser : bool *
[<FromQueryAttribute>] ?support2fa : bool *
?cancellationToken : CancellationToken
(* Defaults:
let _cookies = defaultArg cookies false
let _browser = defaultArg browser false
let _support2fa = defaultArg support2fa false
let _cancellationToken = defaultArg cancellationToken new CancellationToken()
*)
-> Task<ActionResult<OpenSessionResponse>>