LogOnController.ImpersonateAccount Method |
Starts an impersonation session for the specified account.
Namespace:
Dundas.BI.WebApi.Controllers
Assembly:
Dundas.BI.WebApi (in Dundas.BI.WebApi.dll) Version: 2.0.0.0 (25.2.0.1000)
Syntax[HttpPostAttribute("ImpersonateAccount/{id}")]
[ProducesResponseTypeAttribute(403)]
[ProducesResponseTypeAttribute(405)]
[ProducesResponseTypeAttribute(410)]
[ProducesResponseTypeAttribute(440)]
public ActionResult<SessionData> ImpersonateAccount(
Guid id,
[FromQueryAttribute] Guid? tenantId = null,
Guid? sessionId = null
)<HttpPostAttribute("ImpersonateAccount/{id}")>
<ProducesResponseTypeAttribute(403)>
<ProducesResponseTypeAttribute(405)>
<ProducesResponseTypeAttribute(410)>
<ProducesResponseTypeAttribute(440)>
Public Function ImpersonateAccount (
id As Guid,
<FromQueryAttribute> Optional tenantId As Guid? = Nothing,
Optional sessionId As Guid? = Nothing
) As ActionResult(Of SessionData)public:
[HttpPostAttribute(L"ImpersonateAccount/{id}")]
[ProducesResponseTypeAttribute(403)]
[ProducesResponseTypeAttribute(405)]
[ProducesResponseTypeAttribute(410)]
[ProducesResponseTypeAttribute(440)]
ActionResult<SessionData^>^ ImpersonateAccount(
Guid id,
[FromQueryAttribute] Nullable<Guid> tenantId = nullptr,
Nullable<Guid> sessionId = nullptr
)[<HttpPostAttribute("ImpersonateAccount/{id}")>]
[<ProducesResponseTypeAttribute(403)>]
[<ProducesResponseTypeAttribute(405)>]
[<ProducesResponseTypeAttribute(410)>]
[<ProducesResponseTypeAttribute(440)>]
member ImpersonateAccount :
id : Guid *
[<FromQueryAttribute>] ?tenantId : Nullable<Guid> *
?sessionId : Nullable<Guid>
(* Defaults:
let _tenantId = defaultArg tenantId null
let _sessionId = defaultArg sessionId null
*)
-> ActionResult<SessionData>
Parameters
- id
- Type: System.Guid
The ID of the account to impersonate. - tenantId (Optional)
- Type: System.Nullable<Guid>
The ID of the tenant which will be associated with the impersonated session. - sessionId (Optional)
- Type: System.Nullable<Guid>
Current session ID.
Return Value
Type:
ActionResult<SessionData>The operation completed successfully. The payload contains a
SessionData object.
See Also