LogOnController.TryHypotheticalLogOn Method |
Gets the hypothetical result of a logon by the account with the specified ID (without actually creating a session).
Namespace:
Dundas.BI.WebApi.Controllers
Assembly:
Dundas.BI.WebApi (in Dundas.BI.WebApi.dll) Version: 2.0.0.0 (25.2.0.1000)
Syntax[HttpGetAttribute("TryHypothetical/{id}")]
[ProducesResponseTypeAttribute(403)]
[ProducesResponseTypeAttribute(410)]
[ProducesResponseTypeAttribute(440)]
public ActionResult<LogOnResultData> TryHypotheticalLogOn(
Guid id,
bool deleteOtherSessions,
Guid? sessionId = null
)
<HttpGetAttribute("TryHypothetical/{id}")>
<ProducesResponseTypeAttribute(403)>
<ProducesResponseTypeAttribute(410)>
<ProducesResponseTypeAttribute(440)>
Public Function TryHypotheticalLogOn (
id As Guid,
deleteOtherSessions As Boolean,
Optional sessionId As Guid? = Nothing
) As ActionResult(Of LogOnResultData)
public:
[HttpGetAttribute(L"TryHypothetical/{id}")]
[ProducesResponseTypeAttribute(403)]
[ProducesResponseTypeAttribute(410)]
[ProducesResponseTypeAttribute(440)]
ActionResult<LogOnResultData^>^ TryHypotheticalLogOn(
Guid id,
bool deleteOtherSessions,
Nullable<Guid> sessionId = nullptr
)
[<HttpGetAttribute("TryHypothetical/{id}")>]
[<ProducesResponseTypeAttribute(403)>]
[<ProducesResponseTypeAttribute(410)>]
[<ProducesResponseTypeAttribute(440)>]
member TryHypotheticalLogOn :
id : Guid *
deleteOtherSessions : bool *
?sessionId : Nullable<Guid>
(* Defaults:
let _sessionId = defaultArg sessionId null
*)
-> ActionResult<LogOnResultData>
Parameters
- id
- Type: System.Guid
The ID of the account to try logging on. - deleteOtherSessions
- Type: System.Boolean
A value indicating whether other sessions should be deleted if required for the logon to succeed. - sessionId (Optional)
- Type: System.Nullable<Guid>
Current session ID.
Return Value
Type:
ActionResult<LogOnResultData>The operation completed successfully. The payload contains a
LogOnResultData object.
See Also