internal/autorest/out/user/Get-DracoonARUserPing.ps1
|
function Get-DracoonARUserPing { <# .SYNOPSIS (authenticated) Ping .DESCRIPTION ### Description: Test connection to DRACOON Server (while authenticated). ### Precondition: Authenticated user. ### Postcondition: `200 OK` with principal information is returned if successful. ### Further Information: None. .PARAMETER Connection Object of Class ARAHConnection, stores the authentication Token and the API Base-URL .PARAMETER XSdsAuthToken Authentication token .EXAMPLE PS C:\> Get-DracoonARUserPing -Connection $connection ### Description: Test connection to DRACOON Server (while authenticated). ### Precondition: Authenticated user. ### Postcondition: `200 OK` with principal information is returned if successful. ### Further Information: None. .LINK <unknown> #> [CmdletBinding(DefaultParameterSetName = 'default')] param ( [Parameter(Mandatory = $true, ValueFromPipelineByPropertyName = $true, ParameterSetName = 'default')] [object] $Connection, [Parameter(ValueFromPipelineByPropertyName = $true, ParameterSetName = 'default')] [string] $XSdsAuthToken ) process { $__mapping = @{ 'Connection' = 'Connection' 'XSdsAuthToken' = 'X-Sds-Auth-Token' } $__body = $PSBoundParameters | ConvertTo-DracoonARHashtable -Include @() -Mapping $__mapping $__query = $PSBoundParameters | ConvertTo-DracoonARHashtable -Include @() -Mapping $__mapping $__header = $PSBoundParameters | ConvertTo-DracoonARHashtable -Include @('XSdsAuthToken') -Mapping $__mapping $__path = 'user/ping' Invoke-DracoonAPI -Path $__path -Method get -Body $__body -Query $__query -Header $__header -Connection $Connection } } |