XML-RPC/Authentication.ps1
|
#Requires -Version 3.0 <# Authentications #> function Connect-Confluence { <# .SYNOPSIS Authenticate with a Confluence SOAP or REST API. .DESCRIPTION Log in a user. Returns a String authentication token to be passed as authentication to all other remote calls. Must be called before any other method in a remote conversation. From 1.3 onwards, you can supply an empty string as the token to be treated as being the anonymous user. .NOTES AUTHOR : Oliver Lipkau <oliver@lipkau.net> VERSION: 1.0.0 - OL - initial Code .INPUTS string System.Management.Automation.PSCredential .OUTPUTS string Microsoft.PowerShell.Commands.HtmlWebResponseObject .EXAMPLE Invoke-ConfluenceLogin -apiURi "http://example.com" -Credential (Get-Credential) ----------- Description Log in to Confluence .LINK Atlassians's Docs: String login(String username, String password) #> [CmdletBinding()] [OutputType( [string], [Microsoft.PowerShell.Commands.HtmlWebResponseObject] )] param( # The URi of the API interface. [Parameter( Position=0, Mandatory=$true )] [string]$apiURi, # Credentials with which to authentication [Parameter( Position=1, Mandatory=$true )] [System.Management.Automation.PSCredential]$Credential, # API Connection type. Can be SOAP (XML-RPC) or REST. [ValidateSet('rest','xmlrpc')] [Parameter()] [Alias('Type')] $ConnectionType = "xmlrpc", # Authentication Mode. Can be OAuth or Basic. # OAuth will return a WebSession Instance. [ValidateSet('OAuth', "Basic")] [Parameter( Mandatory=$false )] [Alias('Method', 'AuthMethod')] $AuthenticationMethod ) Begin { Write-Verbose "$($MyInvocation.MyCommand.Name):: Function started" $formFields = @(@{user="os_username"},@{password="os_password"}) } Process { switch ($ConnectionType) { "rest" { if ($AuthenticationMethod -eq "OAuth") { $response = Invoke-WebRequest $apiURi -SessionVariable cf $form = $response.Forms | Where-Object {$_.Fields.Keys -contains $formFields.user -and $_.Fields.Keys -contains $formFields.password} $form.Fields[$formFields.user] = $Credential.UserName $form.Fields[$formFields.password] = ($Credential.getnetworkcredential().password) Invoke-WebRequest -Uri ($apiURi + "" + $form.Action) -WebSession $cf -Method POST -Body $form.Fields | Out-Null Set-ConfluenceEndpoint -apiURi $apiURi -WebSession $cf return $cf } elseif ($AuthenticationMethod -eq "Basic") { Set-ConfluenceEndpoint -apiURi $apiURi -Credential $Credential } break } "xmlrpc" { $ConfluenceAuthToken = Invoke-ConfluenceCall -apiURi $apiURi -MethodName "confluence2.login" -Params ([string]($Credential.UserName),[string]($Credential.getnetworkcredential().password)) $PDFExportAuthToken = Invoke-ConfluenceCall -apiURi $apiURi -MethodName "pdfexport.login" -Params ([string]($Credential.UserName),[string]($Credential.getnetworkcredential().password)) Set-ConfluenceEndpoint -apiURi $apiURi -token $ConfluenceAuthToken -Method "confluence2" Set-ConfluenceEndpoint -apiURi $apiURi -token $PDFExportAuthToken -Method "pdfexport" New-Object -TypeName PSObject -Prop @{ confluenceToken = $ConfluenceAuthToken pdfexportToken = $PDFExportAuthToken } } } } End { Write-Verbose "$($MyInvocation.MyCommand.Name):: Function ended" } } function Disconnect-Confluence { <# .SYNOPSIS Log off from Confluence Insatance .DESCRIPTION Remove this token from the list of logged in tokens. Returns true if the user was logged out, false if they were not logged in in the first place. .NOTES AUTHOR : Oliver Lipkau <oliver@lipkau.net> VERSION: 0.0.1 - OL - Initial Code 1.0.0 - OL - Replaced hashtables with Objects .INPUTS string .OUTPUTS bool .EXAMPLE Invoke-ConfluenceLogout -apiURi "http://example.com" -token "000000" ----------- Description Log out of Confluence .LINK Atlassians's Docs: boolean logout(String token) #> [CmdletBinding( )] [OutputType( [bool] )] param( # The URi of the API interface. [Parameter( Position=0, Mandatory=$true )] [string]$apiURi, # Confluence's Authentication Token. [Parameter( Position=1, Mandatory=$true )] [string]$Token ) Begin { Write-Verbose "$($MyInvocation.MyCommand.Name):: Function started" } Process { Write-Verbose "$($MyInvocation.MyCommand.Name):: Logging out" ConvertFrom-Xml (Invoke-ConfluenceCall -Url $apiURi -MethodName "confluence2.logout" -Params ($token)) ConvertFrom-Xml (Invoke-ConfluenceCall -Url $apiURi -MethodName "pdfexport.logout" -Params ($token)) } End { Write-Verbose "$($MyInvocation.MyCommand.Name):: Function ended" } } <# /Authentications #> |