Public/Connect-AutotaskWebAPI.ps1
|
<# .COPYRIGHT Copyright (c) Office Center Hønefoss AS. All rights reserved. Licensed under the MIT license. See https://github.com/officecenter/Autotask/blob/master/LICENSE.md for license information. #> Function Connect-AutotaskWebAPI { <# .SYNOPSIS This function connects to the Autotask Web Services API, authenticates a user and creates a SOAP webservices proxy object. The connection object is cached on a per Prefix basis. .DESCRIPTION The function takes a credential object and uses it to authenticate and connect to the Autotask Web Services API. This is done by creating a webservices proxy. The proxy object imports the SOAP WSDL definition file, creates all entity classes in PowerShell and exposes the basic methods (query(), create(), update(), remove(), GetEntityInfo(), GetFieldInfo() and a few more). Using private functions this module continues to import information about entities and which fields each entity has. It uses this information to create and import a dynamic module pr Prefix. Each module contains a complete set of PowerShell functions pr enntity. All entities gets a Get-PrefixEntity function. Any updateable entities gets a Set-PrefixEntity function. All creatable entities gets a New-PrefixEntity function and all deletable objects gets a Remove-PrefixEntity function. The per Prefix structure is important. It allows you to connect to Autotask with two or more different user accounts from two or more different Autotask tenants. This will allow you to automate between tenants. You can import and export data between tenants, transfer tickets, updates tickets in tenant2 from tickets in tenant1 and so on. .INPUTS A PSCredential object. Required. It will prompt for credentials if the object is not provided. .OUTPUTS A webserviceproxy object is created. .EXAMPLE Connect-AutotaskWebAPI Prompts for a username and password and authenticates to Autotask .EXAMPLE Connect-AutotaskWebAPI .NOTES NAME: Connect-AutotaskWebAPI .LINK Get-AtwsData #> [cmdletbinding()] Param ( [ValidateNotNullOrEmpty()] [pscredential] $Credential = $(Get-Credential -Message 'Autotask Web Services API login'), [String] $ApiTrackingIdentifier, [Switch] $NoDynamicModule = $False, [ValidatePattern('[a-zA-Z0-9]')] [ValidateLength(1, 8)] [String] $Prefix = 'Atws', [Switch] $NoDiskCache, [Switch] $RefreshCache, [Switch] $Silent = $false ) Begin { Write-Verbose ('{0}: Begin of function' -F $MyInvocation.MyCommand.Name) # API version 1.6 REQUIRES an API tracking identifier. If you provide it we connect to 1.6 If ($ApiTrackingIdentifier) { $APIversion = '1.6' } Else { $APIversion = '1.5' } $DefaultUri = 'https://webservices.Autotask.net/atservices/{0}/atws.wsdl' -F $APIversion If (-not($global:AtwsConnection)) { $global:AtwsConnection = @{} } # Unless warning level is specified explicitly - Show warnings! If (-not ($WarningAction)) { $Global:WarningPreference = 'Continue' } # Setting Modulename here, we need to check if it is already loaded $ModuleName = 'Autotask.{0}' -F $Prefix # Load support for TLS 1.2 if the Service Point Manager haven't loaded it yet # This is now a REQUIREMENT to talk to the API endpoints $Protocol = [System.Net.ServicePointManager]::SecurityProtocol If ($Protocol.ToString() -notlike '*Tls12*') { [System.Net.ServicePointManager]::SecurityProtocol += 'tls12' } } Process { # Preparing for a progressbar $ProgressActivity = 'Connecting to Autotask Web Services API' $ProgressID = 1 # Make sure Windows does not try to add a domain to username # Prefix username with a backslash if nobody has added one yet # And make sure we stick to the local scope - important when debugging... If ($($local:Credential.UserName).Substring(0, 1) -ne '\') { $local:Credential = New-Object System.Management.Automation.PSCredential("\$($local:Credential.UserName)", $($local:Credential.Password)) } Write-Verbose ('{0}: Getting ZoneInfo for user {1} by calling default URI {2}' -F $MyInvocation.MyCommand.Name, $local:Credential.UserName, $DefaultUri) Write-Progress -Id $ProgressID -Activity $ProgressActivity -Status 'Creating connection' -PercentComplete 1 -CurrentOperation 'Locating correct datacenter' $RootService = New-WebServiceProxy -URI $DefaultUri $ZoneInfo = $RootService.getZoneInfo($local:Credential.UserName) If ($ZoneInfo.ErrorCode -ne 0) { Write-Progress -Id $ProgressID -Activity $ProgressActivity -Status 'Creating connection' -PercentComplete 100 -CurrentOperation 'Operation failed' Write-Error ('Invalid username "{0}". Try again.' -f $local:Credential.UserName) Return } Write-Verbose ('{0}: Customer tenant ID: {1}, Web URL: {2}, SOAP endpoint: {3}' -F $MyInvocation.MyCommand.Name, $ZoneInfo.CI, $ZoneInfo.WebUrl, $ZoneInfo.Url) Write-Verbose ('{0}: Checking cached connections for Connection {1}' -F $MyInvocation.MyCommand.Name, $Prefix) Write-Progress -Id $ProgressID -Activity $ProgressActivity -Status 'Datacenter located' -PercentComplete 20 -CurrentOperation 'Checking for cached connections' If ($global:AtwsConnection.ContainsKey($Prefix) -and -not $RefreshCache.IsPresent) { Write-Verbose ('{0}: Cached connection {1} found. Checking credentials' -F $MyInvocation.MyCommand.Name, $Prefix) $SameUser = (('\{0}' -F $global:AtwsConnection[$Prefix].Credentials.Username) -eq $local:Credential.Username) $ModuleLoaded = Get-Module -Name $ModuleName If ($SameUser -and ($global:AtwsConnection[$Prefix].Credentials.Password -ne $local:Credential.GetNetworkCredential().Password)) { Write-Verbose ('{0}: Password for connection {1} updated. Re-authenticating.' -F $MyInvocation.MyCommand.Name, $Prefix) $global:AtwsConnection.Remove($Prefix) } ElseIf ($SameUser -and -not $NoDynamicModule -and -not ($ModuleLoaded)) { Write-Verbose ('{0}: Credentials for connection {1} validated, but no dynamic module loaded. Loading module.' -F $MyInvocation.MyCommand.Name, $Prefix) } ElseIf ($SameUser) { Write-Verbose ('{0}: Credentials for connection {1} cached. Using cached connection.' -F $MyInvocation.MyCommand.Name, $Prefix) Write-Progress -Id $ProgressID -Activity $ProgressActivity -Status 'Cached connection found' -PercentComplete 100 -CurrentOperation 'Using cached connection' Return } Else { Write-Verbose ('{0}: New credentials for connection {1} speficied. Creating new connection.' -F $MyInvocation.MyCommand.Name, $Prefix) $global:AtwsConnection.Remove($Prefix) } } Write-Progress -Id $ProgressID -Activity $ProgressActivity -Status 'No re-usable, cached connection' -PercentComplete 40 -CurrentOperation 'Authenticating to web service' $Uri = $ZoneInfo.URL -replace 'atws.asmx', 'atws.wsdl' # Make sure a failure to create this object truly fails the script Write-Verbose ('{0}: Creating New-WebServiceProxy against URI: {1}' -F $MyInvocation.MyCommand.Name, $Uri) Try { # Create a new webservice proxy or die trying... $WebServiceProxy = New-WebServiceProxy -URI $Uri -Credential $local:Credential -Namespace 'Autotask' -Class 'AutotaskAPI' -ErrorAction Stop # Make sure the webserviceproxy authenticates every time (saves a webconnection and a few milliseconds) $WebServiceProxy.PreAuthenticate = $True # Add API Integrations Value # A dedicated object type has been created to store integration values $AutotaskIntegrationsValue = New-Object Autotask.AutotaskIntegrations # Set the integrationcode property to the API tracking identifier provided by the user $AutotaskIntegrationsValue.IntegrationCode = $ApiTrackingIdentifier # Add the integrations value to the Web Service Proxy $WebServiceProxy.AutotaskIntegrationsValue = $AutotaskIntegrationsValue } Catch { Throw [ApplicationException] 'Could not connect to Autotask WebAPI. Verify your credentials. If you are sure you have the rights - maybe you typed your password wrong?' } Write-Verbose ('{0}: Testing Credential object of WebServiceProxy against a .NET bug that will reuse earlier connection attempts.' -F $MyInvocation.MyCommand.Name) # This is a bug that sometimes crop up if you have made a connection attempt using wrong or misspelled passwords. # Make sure the right (newest) password is used when calling the Web Service Proxy. If ($WebServiceProxy.Credentials.Password -ne $local:Credential.GetNetworkCredential().Password) { Write-Verbose ('{0}: Overwriting WebServiceProxy password "manually".' -F $MyInvocation.MyCommand.Name) $WebServiceProxy.Credentials = $local:Credential } Write-Verbose ('{0}: Running query Get-AtwsData -Entity Resource -Filter "username -eq $UserName"' -F $MyInvocation.MyCommand.Name) Write-Progress -Id $ProgressID -Activity $ProgressActivity -Status 'Connected' -PercentComplete 60 -CurrentOperation 'Testing connection' $global:AtwsConnection[$Prefix] = $WebServiceProxy # Get username part of credential $UserName = $Credential.UserName.Split('@')[0].Trim('\') $Result = Get-AtwsData -Connection $Prefix -Entity Resource -Filter "username -eq $UserName" If ($Result) { If (-not $NoDynamicModule.IsPresent) { Write-Progress -Id $ProgressID -Activity $ProgressActivity -Status 'Connection OK' -PercentComplete 80 -CurrentOperation 'Importing dynamic module' Import-AtwsCmdLet -ModuleName $ModuleName -Prefix $Prefix -NoDiskCache:$NoDiskCache.IsPresent -RefreshCache:$RefreshCache.IsPresent } # Check date and time formats and warn if the are different. This will affect how dates as text will be converted to datetime objects $CultureInfo = ([CultureInfo]::CurrentCulture).DateTimeFormat If ($Result.DateFormat -ne $CultureInfo.ShortDatePattern -and $Result.TimeFormat -ne $CultureInfo.ShortTimePattern) { Write-Verbose 'WARNING: DATE and TIME format of the current Autotask user should be updated to match local computer. Otherwise you risk that the API interprets your date and time entries wrong.' Write-Verbose ('Log on to Autotask and edit resource {0}. Change Date format to "{1}" and Time format to "{2}"' -F $username, $CultureInfo.ShortDatePattern, $CultureInfo.ShortTimePattern) } ElseIf ($Result.DateFormat -ne $CultureInfo.ShortDatePattern) { Write-Verbose 'WARNING: DATE format of the current Autotask user should be updated to match local computer. Otherwise you risk that the API interprets your date entries wrong.' Write-Verbose ('Log on to Autotask and edit resource {0}. Change Date format to "{1}"' -F $username, $CultureInfo.ShortDatePattern) } ElseIf ($Result.TimeFormat -ne $CultureInfo.ShortTimePattern) { Write-Verbose 'WARNING: TIME format of the current Autotask user should be updated to match local computer. Otherwise you risk that the API interprets your time entries wrong.' Write-Verbose ('Log on to Autotask and edit resource {0}. Change Time format to "{1}"' -F $username, $CultureInfo.ShortTimePattern) } } Else { $global:AtwsConnection.Remove($Prefix) Throw [ApplicationException] 'Could not complete a query to Autotask WebAPI. Verify your credentials. You seem to have been logged in, but do you have the necessary rights?' } } End { Write-Verbose ('{0}: End of function' -F $MyInvocation.MyCommand.Name) Write-Progress -Id $ProgressID -Activity $ProgressActivity -Status 'Completed' -PercentComplete 100 -CurrentOperation 'Done' Write-Progress -Id $ProgressID -Activity $ProgressActivity -Status 'Completed' -PercentComplete 100 -CurrentOperation 'Done' -Completed } } |