Public/Remove-JiraSession.ps1
|
function Remove-JiraSession { <# .Synopsis Removes a persistent JIRA authenticated session .DESCRIPTION This function removes a persistent JIRA authenticated session and closes the session for JIRA. This can be used to "log out" of JIRA once work is complete. If called with the Session parameter, this function will attempt to close the provided JiraPS.Session object. If called with no parameters, this function will close the saved JIRA session in the module's PrivateData. .EXAMPLE New-JiraSession -Credential (Get-Credential jiraUsername) Get-JiraIssue TEST-01 Remove-JiraSession This example creates a JIRA session for jiraUsername, runs Get-JiraIssue, and closes the JIRA session. .EXAMPLE $s = New-JiraSession -Credential (Get-Credential jiraUsername) Remove-JiraSession $s This example creates a JIRA session and saves it to a variable, then uses the variable reference to close the session. .INPUTS [JiraPS.Session] A Session object to close. .OUTPUTS [JiraPS.Session] An object representing the Jira session #> [CmdletBinding(SupportsShouldProcess = $false)] [System.Diagnostics.CodeAnalysis.SuppressMessage('PSUseShouldProcessForStateChangingFunctions', '')] param( # A Jira session to be closed. If not specified, this function will use a saved session. [Parameter(Mandatory = $false, Position = 0, ValueFromPipeline = $true)] [Object] $Session ) begin { try { Write-Debug "[Remove-JiraSession] Reading Jira server from config file" $server = Get-JiraConfigServer -ConfigFile $ConfigFile -ErrorAction Stop } catch { $err = $_ Write-Debug "[Remove-JiraSession] Encountered an error reading configuration data." throw $err } $uri = "$server/rest/auth/1/session" $headers = @{ 'Content-Type' = 'application/json'; } } process { if ($Session) { Write-Debug "[Remove-JiraSession] Validating Session parameter" if ((Get-Member -InputObject $Session).TypeName -eq 'JiraPS.Session') { Write-Debug "[Remove-JiraSession] Successfully parsed Session parameter as a JiraPS.Session object" } else { Write-Debug "[Remove-JiraSession] Session parameter is not a JiraPS.Session object. Throwing exception" throw "Unable to parse parameter [$Session] as a JiraPS.Session object" } } else { Write-Debug "[Remove-JiraSession] Session parameter was not supplied. Checking for saved session in module PrivateData" $Session = Get-JiraSession } if ($Session) { Write-Debug "[Remove-JiraSession] Preparing for blastoff!" try { $webResponse = Invoke-WebRequest -Uri $uri -Headers $headers -Method Delete -WebSession $Session.WebSession Write-Debug "[Remove-JiraSession] Removing session from module's PrivateData" if ($MyInvocation.MyCommand.Module.PrivateData) { Write-Debug "[Remove-JiraSession] Removing session from existing module PrivateData" $MyInvocation.MyCommand.Module.PrivateData.Session = $null; } else { Write-Debug "[Remove-JiraSession] Creating module PrivateData" $MyInvocation.MyCommand.Module.PrivateData = @{ 'Session' = $null; } } } catch { $err = $_ $webResponse = $err.Exception.Response Write-Debug "[Remove-JiraSession] Encountered an exception from the Jira server: $err" Write-Warning "JIRA returned HTTP error $($webResponse.StatusCode.value__) - $($webResponse.StatusCode)" # Retrieve body of HTTP response - this contains more useful information about exactly why the error # occurred $readStream = New-Object -TypeName System.IO.StreamReader -ArgumentList ($webResponse.GetResponseStream()) $body = $readStream.ReadToEnd() $readStream.Close() Write-Debug "Retrieved body of HTTP response for more information about the error (`$body)" ConvertFrom-Json2 -InputObject $body } } else { Write-Verbose "No Jira session is saved." } } } |