Thycotic.SecretServer

0.43.0

functions/secret-policies/Search-SecretPolicy.ps1

function Search-SecretPolicy {
    <#
    .SYNOPSIS
    Search Secret Policies
 
    .DESCRIPTION
    Search Secret Policies
 
    .LINK
    https://thycotic-ps.github.io/thycotic.secretserver/commands/Search-TssSecretPolicy
 
    .LINK
    https://github.com/thycotic-ps/thycotic.secretserver/blob/main/src/functions/secret-policy/Search-SecretPolicy.ps1
 
    .EXAMPLE
    $session = New-TssSession -SecretServer https://alpha -Credential $ssCred
    Search-TssSecretPolicy -TssSession $session -PolicyName 'heartbeat'
 
    Search for Secret Policies with names matching "heartbeat"
 
    .NOTES
    Requires TssSession object returned by New-TssSession
    #>
    [CmdletBinding()]
    [OutputType('TssSecretPolicy')]
    param (
        # TssSession object created by New-TssSession for auth
        [Parameter(Mandatory,ValueFromPipeline,Position = 0)]
        [TssSession]
        $TssSession,

        # Secret Policy names (contains)
        [string]
        $PolicyName,

        # Include inactive policies in search results
        [switch]
        $IncludeInactive,

        # Sort by specific property, default SecretPolicyName
        [string]
        $SortBy = 'SecretPolicyName'
    )
    begin {
        $tssParams = $PSBoundParameters
        $invokeParams = . $GetInvokeTssParams $TssSession
    }
    process {
        Write-Verbose "Provided command parameters: $(. $GetInvocation $PSCmdlet.MyInvocation)"
        if ($tssParams.ContainsKey('TssSession') -and $TssSession.IsValidSession()) {
            . $CheckVersion $TssSession '10.9.000000' $PSCmdlet.MyInvocation
            $restResponse = $null
            $uri = $TssSession.ApiUrl, 'secret-policy', 'search' -join '/'
            $uri = $uri, "sortBy[0].direction=asc&sortBy[0].name=$SortBy&take=$($TssSession.Take)" -join '?'
            $invokeParams.Method = 'GET'

            $filters = @()
            switch ($tssParams.Keys) {
                'PolicyName' { $filters += "filter.secretPolicyName=$PolicyName" }
                'IncludeInactive' { $filters += "filter.includeInactive=$([boolean]$IncludeInactive)" }
            }
            if ($filters) {
                $uriFilter = $filters -join '&'
                Write-Verbose "Filters: $uriFilter"
                $uri = $uri, $uriFilter -join '&'
            }
            $invokeParams.Uri = $uri

            Write-Verbose "Performing the operation $($invokeParams.Method) $uri"
            try {
                $restResponse = . $InvokeApi @invokeParams
            } catch {
                Write-Warning "Issue on search request"
                $err = $_
                . $ErrorHandling $err
            }

            if ($restResponse.records.Count -le 0 -and $restResponse.records.Length -eq 0) {
                Write-Warning "No SecretPolicy found"
            }
            if ($restResponse.records) {
                [TssSecretPolicy[]]$restResponse.records
            }
        } else {
            Write-Warning "No valid session found"
        }
    }
}