internal/autorest/out/user/Set-DracoonARUserLogout.ps1
|
function Set-DracoonARUserLogout { <# .SYNOPSIS Invalidate authentication token .DESCRIPTION <h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>🚧 Deprecated since v4.12.0</h3> ### Description: Log out a user. ### Precondition: Authenticated user. ### Postcondition: * User is logged out * Authentication token gets invalidated. ### Further Information: None. .PARAMETER Everywhere Invalidate all tokens .PARAMETER XSdsAuthToken Authentication token .PARAMETER Connection Object of Class ARAHConnection, stores the authentication Token and the API Base-URL .EXAMPLE PS C:\> Set-DracoonARUserLogout -Connection $connection <h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>🚧 Deprecated since v4.12.0</h3> ### Description: Log out a user. ### Precondition: Authenticated user. ### Postcondition: * User is logged out * Authentication token gets invalidated. ### Further Information: None. .LINK <unknown> #> [CmdletBinding(DefaultParameterSetName = 'default')] param ( [Parameter(ValueFromPipelineByPropertyName = $true, ParameterSetName = 'default')] [boolean] $Everywhere, [Parameter(ValueFromPipelineByPropertyName = $true, ParameterSetName = 'default')] [string] $XSdsAuthToken, [Parameter(Mandatory = $true, ValueFromPipelineByPropertyName = $true, ParameterSetName = 'default')] [object] $Connection ) process { $__mapping = @{ 'Everywhere' = 'everywhere' 'XSdsAuthToken' = 'X-Sds-Auth-Token' 'Connection' = 'Connection' } $__body = $PSBoundParameters | ConvertTo-DracoonARHashtable -Include @() -Mapping $__mapping $__query = $PSBoundParameters | ConvertTo-DracoonARHashtable -Include @('Everywhere') -Mapping $__mapping $__header = $PSBoundParameters | ConvertTo-DracoonARHashtable -Include @('XSdsAuthToken') -Mapping $__mapping $__path = 'user/logout' Invoke-DracoonAPI -Path $__path -Method post -Body $__body -Query $__query -Header $__header -Connection $Connection } } |