AccountControllerRemoveFromTenants Method |
Removes the account from the specified tenants.
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("RemoveFromTenants/{id}")]
[ProducesResponseTypeAttribute(403)]
[ProducesResponseTypeAttribute(405)]
[ProducesResponseTypeAttribute(410)]
[ProducesResponseTypeAttribute(440)]
public ActionResult<List<KeyValuePairData>> RemoveFromTenants(
[FromRouteAttribute] Guid id,
[FromBodyAttribute] UpdateTenantMembershipOptions options,
[FromQueryAttribute] Guid? sessionId = null
)<HttpPostAttribute("RemoveFromTenants/{id}")>
<ProducesResponseTypeAttribute(403)>
<ProducesResponseTypeAttribute(405)>
<ProducesResponseTypeAttribute(410)>
<ProducesResponseTypeAttribute(440)>
Public Function RemoveFromTenants (
<FromRouteAttribute> id As Guid,
<FromBodyAttribute> options As UpdateTenantMembershipOptions,
<FromQueryAttribute> Optional sessionId As Guid? = Nothing
) As ActionResult(Of List(Of KeyValuePairData))public:
[HttpPostAttribute(L"RemoveFromTenants/{id}")]
[ProducesResponseTypeAttribute(403)]
[ProducesResponseTypeAttribute(405)]
[ProducesResponseTypeAttribute(410)]
[ProducesResponseTypeAttribute(440)]
ActionResult<List<KeyValuePairData^>^>^ RemoveFromTenants(
[FromRouteAttribute] Guid id,
[FromBodyAttribute] UpdateTenantMembershipOptions^ options,
[FromQueryAttribute] Nullable<Guid> sessionId = nullptr
)[<HttpPostAttribute("RemoveFromTenants/{id}")>]
[<ProducesResponseTypeAttribute(403)>]
[<ProducesResponseTypeAttribute(405)>]
[<ProducesResponseTypeAttribute(410)>]
[<ProducesResponseTypeAttribute(440)>]
member RemoveFromTenants :
[<FromRouteAttribute>] id : Guid *
[<FromBodyAttribute>] options : UpdateTenantMembershipOptions *
[<FromQueryAttribute>] ?sessionId : Nullable<Guid>
(* Defaults:
let _sessionId = defaultArg sessionId null
*)
-> ActionResult<List<KeyValuePairData>>
Parameters
- id
- Type: SystemGuid
The ID of the account. - options
- Type: Dundas.BI.WebApi.ModelsUpdateTenantMembershipOptions
The options. - sessionId (Optional)
- Type: SystemNullableGuid
The current session ID.
Return Value
Type:
ActionResultListKeyValuePairData
The operation completed successfully. The payload is a list of key/value pairs; the keys being tenant IDs, and the values being Booleans
indicating whether the account was successfully removed from the corresponding tenant. If the account was not originally a member of the tenant,
the value of the Boolean will be
.
See Also