Folder Functions - code cleanup

thycotic-ps · Mar 13, 2021 · b98dc96 · b98dc96
1 parent dc88291
commit b98dc96
Show file tree

Hide file tree

Showing 16 changed files with 56 additions and 232 deletions.
diff --git a/src/classes/folders/TssFolderLookup.class.ps1 b/src/classes/folders/TssFolderLookup.class.ps1
@@ -3,5 +3,5 @@ class TssFolderLookup {
     $Id
 
     [string]
-    $FolderName
+    $Value
 }
diff --git a/src/classes/general/TssDelete.class.ps1 b/src/classes/general/TssDelete.class.ps1
@@ -4,4 +4,8 @@ class TssDelete {
 
     [string]
     $ObjectType
+
+    hidden
+    [string[]]
+    $ResponseCodes
 }
diff --git a/src/functions/folders/Find-Folder.ps1 b/src/functions/folders/Find-Folder.ps1
@@ -22,10 +22,9 @@ function Find-Folder {
     [OutputType('TssFolderLookup')]
     param (
         # TssSession object created by New-TssSession for auth
-        [Parameter(Mandatory,
-            ValueFromPipeline,
-            Position = 0)]
-        [TssSession]$TssSession,
+        [Parameter(Mandatory,ValueFromPipeline,Position = 0)]
+        [TssSession]
+        $TssSession,
 
         # Parent Folder Id
         [Alias("FolderId")]
@@ -98,7 +97,7 @@ function Find-Folder {
                 Write-Warning "No Folder found"
             }
             if ($restResponse.records) {
-                . $TssFolderLookupObject $restResponse.records
+                [TssFolderLookup[]]$restResponse.records
             }
         } else {
             Write-Warning "No valid session found"

diff --git a/src/functions/folders/Get-Folder.ps1 b/src/functions/folders/Get-Folder.ps1
@@ -34,10 +34,9 @@ function Get-Folder {
     [OutputType('TssFolder')]
     param(
         # TssSession object created by New-TssSession for auth
-        [Parameter(Mandatory,
-            ValueFromPipeline,
-            Position = 0)]
-        [TssSession]$TssSession,
+        [Parameter(Mandatory,ValueFromPipeline,Position = 0)]
+        [TssSession]
+        $TssSession,
 
         # Folder ID to retrieve
         [Parameter(Mandatory,ValueFromPipelineByPropertyName)]
@@ -83,7 +82,7 @@ function Get-Folder {
                 }
 
                 if ($restResponse) {
-                    . $TssFolderObject $restResponse
+                    [TssFolder[]]$restResponse
                 }
             }
         } else {

diff --git a/src/functions/folders/Get-FolderAudit.ps1 b/src/functions/folders/Get-FolderAudit.ps1
@@ -22,10 +22,9 @@ function Get-FolderAudit {
     [OutputType('TssFolderAuditSummary')]
     param (
         # TssSession object created by New-TssSession for auth
-        [Parameter(Mandatory,
-            ValueFromPipeline,
-            Position = 0)]
-        [TssSession]$TssSession,
+        [Parameter(Mandatory,ValueFromPipeline,Position = 0)]
+        [TssSession]
+        $TssSession,
 
         # Short description for parameter
         [Parameter(Mandatory,ValueFromPipelineByPropertyName)]
@@ -59,7 +58,7 @@ function Get-FolderAudit {
                 }
 
                 if ($restResponse.records) {
-                    . $TssFolderAuditSummaryObject $restResponse.records
+                    [TssFolderAuditSummary[]]$restResponse.records
                 }
             }
         } else {

diff --git a/src/functions/folders/Get-FolderStub.ps1 b/src/functions/folders/Get-FolderStub.ps1
@@ -22,10 +22,9 @@ function Get-FolderStub {
     [OutputType('TssFolder')]
     param (
         # TssSession object created by New-TssSession for auth
-        [Parameter(Mandatory,
-            ValueFromPipeline,
-            Position = 0)]
-        [TssSession]$TssSession
+        [Parameter(Mandatory,ValueFromPipeline,Position = 0)]
+        [TssSession]
+        $TssSession
     )
     begin {
         $tssParams = $PSBoundParameters
@@ -52,7 +51,7 @@ function Get-FolderStub {
             }
 
             if ($restResponse) {
-                . $TssFolderObject $restResponse
+                [TssFolder]$restResponse
             }
         } else {
             Write-Warning "No valid session found"

diff --git a/src/functions/folders/New-Folder.ps1 b/src/functions/folders/New-Folder.ps1
@@ -9,22 +9,31 @@ function New-Folder {
     .EXAMPLE
     $session = New-TssSession -SecretServer https://alpha -Credential $ssCred
     $folderStub = Get-TssFolderStub -TssSession $session
-    New-TssFolder -TssSession $session -FolderStub $folderStub -FolderName 'tssNewFolder' -ParentFolderId -1
+    $folderStub.FolderName = 'tssNewFolder'
+    $folderStub.ParentFolderId = -1
+    New-TssFolder -TssSession $session -FolderStub $folderStub
 
-    Creates a folder named "tssNewFolder" at the root of Secret Server application
+    Creates a new root folder, named "tssNewFolder"
 
     .EXAMPLE
     $session = New-TssSession -SecretServer https://alpha -Credential $ssCred
     $folderStub = Get-TssFolderStub -TssSession $session
-    New-TssFolder -TssSession $session -FolderStub $folderStub -FolderName 'IT Dept' -ParentFolderId 27 -InheritPermissions:$false
+    $folderStub.FolderName 'IT Dept'
+    $folderStub.ParentFolderId = 27
+    $folderStub.InheritPermissions = $false
+    New-TssFolder -TssSession $session -FolderStub $folderStub
 
-    Creates a folder named "IT Dept" under parent folder 27 with Inherit Permissins disabled (set to No if viewed in the UI)
+    Creates a folder named "IT Dept" under parent folder 27 with Inherit Permissins disabled
 
     .EXAMPLE
     $session = New-TssSession -SecretServer https://alpha -Credential $ssCred
-    Get-TssFolderStub -TssSession $session | New-TssFolder -TssSession $session -FolderName 'Marketing Dept' -ParentFolderId 27 -InheritPermissions -InheritSecretPolicy
+    $folderStub.FolderName 'Marketing Dept'
+    $folderStub.ParentFolderId = 27
+    $folderStub.InheritPermissions = $true
+    $folderStub.InheritSecretPolicy = $true
+    New-TssFolder -TssSession $session -FolderStub $folderStub
 
-    Creates a folder named "Marketing Dept" under parent folder 27 with inheritance enabled for Permissions and Secret Policy
+    Creates a folder named "Marketing Dept" under parent folder 27 with Inheritance enabled for Permissions and Secret Policy
 
     .LINK
     https://thycotic-ps.github.io/thycotic.secretserver/commands/New-TssFolder
@@ -36,39 +45,14 @@ function New-Folder {
     [OutputType('TssFolder')]
     param (
         # TssSession object created by New-TssSession for auth
-        [Parameter(Mandatory,
-            ValueFromPipeline,
-            Position = 0)]
-        [TssSession]$TssSession,
+        [Parameter(Mandatory,ValueFromPipeline,Position = 0)]
+        [TssSession]
+        $TssSession,
 
         # Input object obtained via Get-TssFolderStub
         [Parameter(Mandatory, Position = 1, ValueFromPipeline)]
         [TssFolder]
-        $FolderStub,
-
-        # Folder Name
-        [Parameter(Mandatory)]
-        [string]
-        $FolderName,
-
-        # Parent Folder ID, use -1 to create root folder
-        [Parameter(Mandatory)]
-        [Alias('ParentFolder')]
-        [int]
-        $ParentFolderId,
-
-        # Secret Policy ID
-        [Alias('SecretPolicy')]
-        [int]
-        $SecretPolicyId,
-
-        # Inherit Permissions
-        [switch]
-        $InheritPermissions,
-
-        # Inherit Secret Policy
-        [switch]
-        $InheritSecretPolicy
+        $FolderStub
     )
 
     begin {
@@ -85,19 +69,6 @@ function New-Folder {
             $invokeParams.Uri = $uri
             $invokeParams.Method = 'POST'
 
-            $FolderStub.FolderName = $FolderName
-            $FolderStub.ParentFolderId = $ParentFolderId
-
-            if ($tssParams.ContainsKey('SecretPolicyId')) {
-                $FolderStub.SecretPolicyId = $SecretPolicyId
-            }
-            if ($tssParams.ContainsKey('InheritPermissions')) {
-                $FolderStub.InheritPermissions = $InheritPermissions
-            }
-            if ($tssParams.ContainsKey('InheritSecretPolicy')) {
-                $FolderStub.InheritSecretPolicy = $InheritSecretPolicy
-            }
-
             $invokeParams.Body = ($FolderStub | ConvertTo-Json)
 
             Write-Verbose "$($invokeParams.Method) $uri with:`n $FolderStub"
@@ -110,7 +81,7 @@ function New-Folder {
                 . $ErrorHandling $err
             }
             if ($restResponse) {
-                . $TssFolderObject $restResponse
+                [TssFolder]$restResponse
             }
         } else {
             Write-Warning "No valid session found"

diff --git a/src/functions/folders/Remove-Folder.ps1 b/src/functions/folders/Remove-Folder.ps1
@@ -22,10 +22,9 @@ function Remove-Folder {
     [OutputType('TssDelete')]
     param (
         # TssSession object created by New-TssSession for auth
-        [Parameter(Mandatory,
-            ValueFromPipeline,
-            Position = 0)]
-        [TssSession]$TssSession,
+        [Parameter(Mandatory,ValueFromPipeline,Position = 0)]
+        [TssSession]
+        $TssSession,
 
         # Short description for parameter
         [Parameter(Mandatory,ValueFromPipelineByPropertyName)]
@@ -60,10 +59,7 @@ function Remove-Folder {
                 }
 
                 if ($restResponse) {
-                    [TssDelete]@{
-                        Id         = $restResponse.id
-                        ObjectType = $restResponse.objectType
-                    }
+                    [TssDelete]$restResponse
                 }
             }
         } else {

diff --git a/src/functions/folders/Remove-FolderTemplate.ps1 b/src/functions/folders/Remove-FolderTemplate.ps1
@@ -22,10 +22,9 @@ function Remove-FolderTemplate {
     [OutputType('TssDelete')]
     param (
         # TssSession object created by New-TssSession for auth
-        [Parameter(Mandatory,
-            ValueFromPipeline,
-            Position = 0)]
-        [TssSession]$TssSession,
+        [Parameter(Mandatory,ValueFromPipeline,Position = 0)]
+        [TssSession]
+        $TssSession,
 
         # Short description for parameter
         [Parameter(Mandatory,ValueFromPipelineByPropertyName)]
@@ -65,10 +64,7 @@ function Remove-FolderTemplate {
                 }
 
                 if ($restResponse) {
-                    [TssDelete]@{
-                        Id         = $restResponse.id
-                        ObjectType = $restResponse.objectType
-                    }
+                    [TssDelete]$restResponse
                 }
             }
         } else {

diff --git a/src/functions/folders/Search-Folder.ps1 b/src/functions/folders/Search-Folder.ps1
@@ -22,10 +22,9 @@ function Search-Folder {
     [OutputType('TssFolderSummary')]
     param (
         # TssSession object created by New-TssSession for auth
-        [Parameter(Mandatory,
-            ValueFromPipeline,
-            Position = 0)]
-        [TssSession]$TssSession,
+        [Parameter(Mandatory,ValueFromPipeline,Position = 0)]
+        [TssSession]
+        $TssSession,
 
         # Parent Folder Id
         [Alias("FolderId")]
@@ -77,7 +76,6 @@ function Search-Folder {
             $invokeParams.Uri = $uri
             $invokeParams.Method = 'GET'
 
-
             Write-Verbose "$($invokeParams.Method) $uri with $body"
             try {
                 $restResponse = Invoke-TssRestApi @invokeParams
@@ -91,7 +89,7 @@ function Search-Folder {
                 Write-Warning "No Folder found"
             }
             if ($restResponse.records) {
-                . $TssFolderSummaryObject $restResponse.records
+                [TssFolderSummary[]]$restResponse.records
             }
         } else {
             Write-Warning "No valid session found"

diff --git a/src/functions/folders/Set-Folder.ps1 b/src/functions/folders/Set-Folder.ps1
@@ -21,10 +21,9 @@ function Set-Folder {
     [cmdletbinding(SupportsShouldProcess, DefaultParameterSetName = 'all')]
     param(
         # TssSession object created by New-TssSession for auth
-        [Parameter(Mandatory,
-            ValueFromPipeline,
-            Position = 0)]
-        [TssSession]$TssSession,
+        [Parameter(Mandatory,ValueFromPipeline,Position = 0)]
+        [TssSession]
+        $TssSession,
 
         # Folder Id to modify
         [Parameter(Mandatory,ValueFromPipelineByPropertyName)]

diff --git a/src/parts/TssFolderAuditSummaryObject.ps1 b/src/parts/TssFolderAuditSummaryObject.ps1
diff --git a/src/parts/TssFolderLookupObject.ps1 b/src/parts/TssFolderLookupObject.ps1