Devolutions.Server

2022.3.2.0

Public/Pam/Checkout/Get-DSPamCheckout.ps1

function Get-DSPamCheckout {
    <#
        .SYNOPSIS
        Returns the current checkout state of the provided PAM credential.
        .EXAMPLE
        Please check the sample script provided with the module.
    #>
    [CmdletBinding()]
    PARAM (
        [guid]$PamCheckoutId
    )
    
    BEGIN {
        Write-Verbose '[Get-DSPamCheckout] Beginning...'

        if ([string]::IsNullOrWhiteSpace($Global:DSSessionToken)) {
            throw 'Session does not seem authenticated, call New-DSSession.'
        }
    }
    
    PROCESS {
        $RequestParams = @{
            URI    = "$Script:DSBaseURI/api/pam/checkouts/$PamCheckoutId"
            Method = 'GET' 
        }
        
        try {
            $res = Invoke-DS @RequestParams
            return $res
        }
        catch { throw $_.ErrorDetails }
    }
    
    END {
        $res.isSuccess ? (Write-Verbose '[Get-DSPamCheckout] Completed successfully!') : (Write-Verbose '[Get-DSPamCheckout] Ended with errors...')
    }
}