Merge pull request #233 from pspete/update-errormessages

Update Error Messages
pspete · Dec 13, 2019 · ab5045f · ab5045f
2 parents 1cd975b + ed3f8b0
commit ab5045f
Show file tree

Hide file tree

Showing 2 changed files with 32 additions and 10 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,7 +4,7 @@
 
 ### Module update to cover CyberArk 11.1 API features
 
-- Additions
+- New Functions
   - `New-PASGroup`
     - Creates CyberArk Groups
     - Requires 11.1
@@ -21,7 +21,7 @@
     - Disable Automatic CPM Management for an Account.
     - Requires 10.4+
 
-- Updates
+- Updated Functions
   - `Set-PASDirectoryMapping`
     - MappingAuthorizations parameter no longer accepts pipeline input
   - `Add-PASDiscoveredAccount`
@@ -37,11 +37,13 @@
     - Added features introduced in version 11.1
     - Expanded options for updating users.
 
-- Fixes
+- Fixes & Other Updates
   - `Get-PASAccountPassword`
     - Fixed incorrectly escaped value for passwords begining with "\"
   - `New-PASRequest`
     - Fixed incorrect parameter name which prevented requests specifying mulitple access as required being created.
+  - Error Reporting
+    - Added more verbose error messages.
 
 ## 3.2.37 (Sept 17th 2019)
 

diff --git a/psPAS/Private/Invoke-PASRestMethod.ps1 b/psPAS/Private/Invoke-PASRestMethod.ps1
@@ -127,7 +127,8 @@
 
 					}
 
-				} else {
+				}
+				else {
 
 					#PWSH
 					if ($SkipCertificateCheck) {
@@ -192,7 +193,8 @@
 			#make web request, splat PSBoundParameters
 			$APIResponse = Invoke-WebRequest @PSBoundParameters -ErrorAction Stop
 
-		} catch [System.UriFormatException] {
+		}
+		catch [System.UriFormatException] {
 
 			#Catch URI Format errors. Likely $Script:BaseURI is not set; New-PASSession should be run.
 			$PSCmdlet.ThrowTerminatingError(
@@ -208,7 +210,8 @@
 
 			)
 
-		} catch {
+		}
+		catch {
 
 			$ErrorID = $null
 			$StatusCode = $($PSItem.Exception.Response).StatusCode.value__
@@ -225,25 +228,41 @@
 
 				throw $PSItem
 
-			} Else {
+			}
+			Else {
 
 				If (-not($StatusCode)) {
 
 					#Generic failure message if no status code/response
 					$ErrorMessage = "Error contacting $($PSItem.TargetObject.RequestUri.AbsoluteUri)"
 
-				} ElseIf ($ErrorDetails) {
+				}
+				ElseIf ($ErrorDetails) {
 
 					try {
 
 						#Convert ErrorDetails JSON to Object
 						$Response = $ErrorDetails | ConvertFrom-Json
+
 						#API Error Message
 						$ErrorMessage = "[$StatusCode] $($Response.ErrorMessage)"
+
 						#API Error Code
 						$ErrorID = $Response.ErrorCode
+
+						#Inner error details are present
+						if ($Response.Details) {
+
+							#Join Inner Error Text to Error Message
+							$ErrorMessage = $ErrorMessage, $(($Response.Details | Select-Object -ExpandProperty ErrorMessage) -join ", ") -join ": "
+
+							#Join Inner Error Codes to ErrorID
+							$ErrorID = $ErrorID, $(($Response.Details | Select-Object -ExpandProperty ErrorCode) -join ",") -join ","
+
+						}
 
-					} catch {
+					}
+					catch {
 
 						#If error converting JSON, return $ErrorDetails
 						#replace any new lines or whitespace with single spaces
@@ -270,7 +289,8 @@
 
 			)
 
-		} finally {
+		}
+		finally {
 
 			#If Session Variable passed as argument
 			If ($PSCmdlet.ParameterSetName -eq "SessionVariable") {