internal/functions/Get-PasswordStateResource.ps1
|
<# .SYNOPSIS A function to simplify the Retrieval of password state resources via the rest API .DESCRIPTION A function to simplify the Retrieval of password state resources via the rest API. .EXAMPLE PS C:\> Get-PasswordStateResource -uri "/api/lists" Sets a password on the password api. .PARAMETER URI The api resource to access such as /api/lists .PARAMETER Method Optional Parameter to override the method from GET. .OUTPUTS Will return the response from the rest API. .PARAMETER ContentType Optional Parameter to override the default content type from application/json. .PARAMETER ExtraParams Optional Parameter to allow extra parameters to be passed to invoke-restmethod. Should be passed as a hashtable. .PARAMETER Sort Optional Parameter to sort the returned output. .NOTES Daryl Newsholme 2018 #> function Get-PasswordStateResource { [CmdletBinding()] param ( [string]$uri, [string]$method = "GET", [string]$ContentType = "application/json", [hashtable]$extraparams = $null, [switch]$Sort ) begin { # Import the environment $passwordstateenvironment = Get-PasswordStateEnvironment # If the apikey is windowsauth then rebuild the uri string to match the windows auth apis, otherwise just build the api headers. Switch ($passwordstateenvironment.AuthType) { WindowsIntegrated { $uri = $uri -Replace "^/api/", "/winapi/" } WindowsCustom { $uri = $uri -Replace "^/api/", "/winapi/" } APIKey { switch -Wildcard ($uri) { /api/generatepassword* { Write-Verbose "[$(Get-Date -format G)] Using generate password api key" $headers = @{"APIKey" = "$($passwordstateenvironment.PasswordGeneratorAPIKey)" } } Default { $headers = @{"APIKey" = "$($passwordstateenvironment.Apikey)" } } } } } } process { $params = @{ "UseBasicParsing" = $true "URI" = "$($passwordstateenvironment.baseuri)$uri" "ContentType" = $ContentType "Method" = $method.ToUpper() } if ($headers -and $null -ne $extraparams.Headers) { Write-Verbose "[$(Get-Date -format G)] Adding API Headers and extra param headers" $headers += $extraparams.headers $params += @{"headers" = $headers } $skipheaders = $true } if ($extraparams -and $null -ne $extraparams.Headers -and $skipheaders -ne $true) { Write-Verbose "[$(Get-Date -format G)] Adding extra parameter $($extraparams.keys) $($extraparams.values)" $params += $extraparams } if ($headers -and $skipheaders -ne $true) { Write-Verbose "[$(Get-Date -format G)] Adding API Headers only" $params += @{"headers" = $headers } } Switch ($passwordstateenvironment.AuthType) { APIKey { # Hit the API with the headers Write-Verbose "using uri $($params.uri)" $result = Invoke-RestMethod @params -TimeoutSec 60 } WindowsCustom { Write-Verbose "using uri $($params.uri)" $result = Invoke-RestMethod @params -Credential $passwordstateenvironment.apikey -TimeoutSec 60 } WindowsIntegrated { # Hit the api with windows auth Write-Verbose "using uri $($params.uri)" $result = Invoke-RestMethod @params -UseDefaultCredentials -TimeoutSec 60 } } if ($sort) { Write-PSFMessage -Level Warning -Message "This feature is not available yet" } } end { if ($result) { return $result } } } |