Get-TssList - new command to get a given List object

docs/commands/lists/Get-TssList.md

@@ -0,0 +1,73 @@
+# Get-TssList
+
+## SYNOPSIS
+Get a List
+
+## SYNTAX
+
+```
+Get-TssList [-TssSession] <Session> -Id <String[]> [<CommonParameters>]
+```
+
+## DESCRIPTION
+Get a List
+
+## EXAMPLES
+
+### EXAMPLE 1
+```
+$session = New-TssSession -SecretServer https://alpha -Credential $ssCred
+Get-TssList -TssSession $session -Id 2d92c585-a3e1-4706-96b8-23ad2edda6b0
+```
+
+Add minimum example for each parameter
+
+## PARAMETERS
+
+### -TssSession
+TssSession object created by New-TssSession for authentication
+
+```yaml
+Type: Session
+Parameter Sets: (All)
+Aliases:
+
+Required: True
+Position: 1
+Default value: None
+Accept pipeline input: True (ByValue)
+Accept wildcard characters: False
+```
+
+### -Id
+Short description for parameter
+
+```yaml
+Type: String[]
+Parameter Sets: (All)
+Aliases: CategorizedListId
+
+Required: True
+Position: Named
+Default value: None
+Accept pipeline input: True (ByPropertyName)
+Accept wildcard characters: False
+```
+
+### CommonParameters
+This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
+
+## INPUTS
+
+## OUTPUTS
+
+### Thycotic.PowerShell.Lists.List
+## NOTES
+Requires TssSession object returned by New-TssSession
+
+## RELATED LINKS
+
+[https://thycotic-ps.github.io/thycotic.secretserver/commands/lists/Get-TssList](https://thycotic-ps.github.io/thycotic.secretserver/commands/lists/Get-TssList)
+
+[https://github.com/thycotic-ps/thycotic.secretserver/blob/main/src/functions/lists/Get-TssList.ps1](https://github.com/thycotic-ps/thycotic.secretserver/blob/main/src/functions/lists/Get-TssList.ps1)
+

src/Thycotic.SecretServer.Format.ps1xml

@@ -4028,5 +4028,43 @@
       </TableControl>
     </View>
 
+    <!-- Thycotic.PowerShell.Lists.List -->
+    <View>
+      <Name>Lists.List</Name>
+      <ViewSelectedBy>
+        <TypeName>Thycotic.PowerShell.Lists.List</TypeName>
+      </ViewSelectedBy>
+      <TableControl>
+        <TableHeaders>
+          <TableColumnHeader />
+          <TableColumnHeader />
+          <TableColumnHeader />
+          <TableColumnHeader />
+          <TableColumnHeader />
+        </TableHeaders>
+        <TableRowEntries>
+          <TableRowEntry>
+            <TableColumnItems>
+              <TableColumnItem>
+                <PropertyName>CategorizedListId</PropertyName>
+              </TableColumnItem>
+              <TableColumnItem>
+                <PropertyName>Name</PropertyName>
+              </TableColumnItem>
+              <TableColumnItem>
+                <PropertyName>Description</PropertyName>
+              </TableColumnItem>
+              <TableColumnItem>
+                <PropertyName>Active</PropertyName>
+              </TableColumnItem>
+              <TableColumnItem>
+                <PropertyName>Items</PropertyName>
+              </TableColumnItem>
+            </TableColumnItems>
+          </TableRowEntry>
+        </TableRowEntries>
+      </TableControl>
+    </View>
+
   </ViewDefinitions>
 </Configuration>

src/Thycotic.SecretServer/classes/lists/Item.cs

@@ -8,7 +8,7 @@ namespace Thycotic.PowerShell.Lists
     public class Item
     {
         public string CategorizedListItemId { get; set; }
-        public string CategorizedListId { get; set; }
+        public Guid CategorizedListId { get; set; }
         public string Category { get; set; }
         public string Value { get; set; }
     }

src/Thycotic.SecretServer/classes/lists/List.cs

@@ -0,0 +1,16 @@
+using System;
+using System.Threading.Tasks;
+using System.Management.Automation;
+using System.Management.Automation.Runspaces;
+
+namespace Thycotic.PowerShell.Lists
+{
+    public class List
+    {
+        public bool Active { get; set; }
+        public Guid CategorizedListId { get; set; }
+        public string Description { get; set; }
+        public Item[] Items { get; set; }
+        public string Name { get; set; }
+    }
+}

src/Thycotic.SecretServer/classes/lists/Summary.cs

@@ -8,7 +8,7 @@ namespace Thycotic.PowerShell.Lists
     public class Summary
     {
         public bool Active { get; set; }
-        public string CategorizedListId { get; set; }
+        public Guid CategorizedListId { get; set; }
         public string Description { get; set; }
         public string Name { get; set; }
         public int NumOptions { get; set; }

src/functions/lists/Get-TssList.ps1

@@ -0,0 +1,69 @@
+function Get-TssList {
+    <#
+    .SYNOPSIS
+    Get a List
+
+    .DESCRIPTION
+    Get a List
+
+    .EXAMPLE
+    $session = New-TssSession -SecretServer https://alpha -Credential $ssCred
+    Get-TssList -TssSession $session -Id 2d92c585-a3e1-4706-96b8-23ad2edda6b0
+
+    Add minimum example for each parameter
+
+    .LINK
+    https://thycotic-ps.github.io/thycotic.secretserver/commands/lists/Get-TssList
+
+    .LINK
+    https://github.com/thycotic-ps/thycotic.secretserver/blob/main/src/functions/lists/Get-TssList.ps1
+
+    .NOTES
+    Requires TssSession object returned by New-TssSession
+    #>
+    [CmdletBinding()]
+    [OutputType('Thycotic.PowerShell.Lists.List')]
+    param (
+        # TssSession object created by New-TssSession for authentication
+        [Parameter(Mandatory,ValueFromPipeline,Position = 0)]
+        [Thycotic.PowerShell.Authentication.Session]
+        $TssSession,
+
+        # Short description for parameter
+        [Parameter(Mandatory,ValueFromPipelineByPropertyName)]
+        [Alias("CategorizedListId")]
+        [string[]]
+        $Id
+    )
+    begin {
+        $tssParams = $PSBoundParameters
+        $invokeParams = . $GetInvokeApiParams $TssSession
+    }
+    process {
+        Get-TssInvocation $PSCmdlet.MyInvocation
+        if ($tssParams.ContainsKey('TssSession') -and $TssSession.IsValidSession()) {
+            Compare-TssVersion $TssSession '11.0.000005' $PSCmdlet.MyInvocation
+            foreach ($list in $Id) {
+                $uri = $TssSession.ApiUrl, 'lists', $list -join '/'
+                $invokeParams.Uri = $uri
+                $invokeParams.Method = 'GET'
+
+                Write-Verbose "Performing the operation $($invokeParams.Method) $($invokeParams.Uri)"
+                try {
+                    $apiResponse = Invoke-TssApi @invokeParams
+                    $restResponse = . $ProcessResponse $apiResponse
+                } catch {
+                    Write-Warning "Issue getting List [$list]"
+                    $err = $_
+                    . $ErrorHandling $err
+                }
+
+                if ($restResponse) {
+                    [Thycotic.PowerShell.Lists.List[]]$restResponse
+                }
+            }
+        } else {
+            Write-Warning "No valid session found"
+        }
+    }
+}

tests/lists/Get-TssList.Tests.ps1

@@ -0,0 +1,24 @@
+BeforeDiscovery {
+    $commandName = Split-Path ($PSCommandPath.Replace('.Tests.ps1','')) -Leaf
+}
+Describe "$commandName verify parameters" {
+    BeforeDiscovery {
+        [object[]]$knownParameters = 'TssSession', 'Id'
+        [object[]]$currentParams = ([Management.Automation.CommandMetaData]$ExecutionContext.SessionState.InvokeCommand.GetCommand($commandName,'Function')).Parameters.Keys
+        [object[]]$commandDetails = [System.Management.Automation.CommandInfo]$ExecutionContext.SessionState.InvokeCommand.GetCommand($commandName,'Function')
+        $unknownParameters = Compare-Object -ReferenceObject $knownParameters -DifferenceObject $currentParams -PassThru
+    }
+    Context "Verify parameters" -Foreach @{currentParams = $currentParams } {
+        It "$commandName should contain <_> parameter" -TestCases $knownParameters {
+            $_ -in $currentParams | Should -Be $true
+        }
+        It "$commandName should not contain parameter: <_>" -TestCases $unknownParameters {
+            $_ | Should -BeNullOrEmpty
+        }
+    }
+    Context "Command specific details" {
+        It "$commandName should set OutputType to Thycotic.PowerShell.Lists.List" -TestCases $commandDetails {
+            $_.OutputType.Name | Should -Be 'Thycotic.PowerShell.Lists.List'
+        }
+    }
+}