Find-Group - closes #57

thycotic-ps · May 29, 2021 · 257a8d6 · 257a8d6
1 parent 14ba703
commit 257a8d6
Show file tree

Hide file tree

Showing 10 changed files with 242 additions and 1 deletion.
diff --git a/docs/_data/navigation.yml b/docs/_data/navigation.yml
@@ -71,6 +71,8 @@ commands:
 
   - title: "Groups"
     children:
+      - title: "Find-TssGroup"
+        url: /commands/Find-TssGroup
       - title: "Get-TssGroupMember"
         url: /commands/Get-TssGroupMember
       - title: "Search-TssUserGroup"
@@ -316,8 +318,12 @@ abouttopics:
 
   - title: "Groups"
     children:
+      - title: "TssGroupLookup"
+        url: /abouttopics/about_tssgrouplookup
       - title: "TssGroupSummary"
         url: /abouttopics/about_tssgroupsummary
+      - title: "TssGroupUserSummary"
+        url: /abouttopics/about_tssgroupusersummary
 
   - title: "Reports"
     children:

diff --git a/docs/collections/_abouttopics/about_tssgrouplookup.md b/docs/collections/_abouttopics/about_tssgrouplookup.md
@@ -0,0 +1,28 @@
+---
+category: groups
+title: "TssGroupLookup"
+last_modified_at: 2021-05-26T00:00:00-00:00
+---
+
+# TOPIC
+    This help topic describes the TssGroupLookup class in the Thycotic.SecretServer module
+
+# CLASS
+    TssGroupLookup
+
+# INHERITANCE
+    None
+
+# DESCRIPTION
+    The TssGroupLookup class represents the GroupLookup object returned by Secret Server endpoint GET /groups/lookup
+
+# CONSTRUCTORS
+    new()
+
+# PROPERTIES
+    Documented in the REST API doc for Secret Server, see GroupLookup definition
+
+# METHODS
+
+# RELATED LINKS:
+    Find-TssGroup
diff --git a/docs/collections/_pages/abouttopics.md b/docs/collections/_pages/abouttopics.md
@@ -76,7 +76,9 @@ About topics cover the [PowerShell classes](https://docs.microsoft.com/en-us/pow
 
 **Class** | **Thycotic.SecretServer Command** |
 --------------------------------- | -------------------------------------------------- |
+[TssGroupLookup] | [Find-TssGroup]
 [TssGroupSummary] | [Search-TssGroup]
+[TssGroupUserSummary] | [Get-TssGroupMember]
 
 ## Reports
 
@@ -207,7 +209,11 @@ About topics cover the [PowerShell classes](https://docs.microsoft.com/en-us/pow
 [Get-TssSecretDependency]:/thycotic.secretserver/commands/Get-TssSecretDependency
 [Get-TssSecretDependencyRunStatus]:/thycotic.secretserver/commands/Get-TssSecretDependencyRunStatus
 [Get-TssSecretDependencyTemplate]:/thycotic.secretserver/commands/Get-TssSecretDependencyTemplate
+[Find-TssGroup]:/thycotic.secretserver/commands/Find-TssGroup
+[Get-TssGroupMember]:/thycotic.secretserver/commands/Get-TssGroupMember
 
+[TssGroupUserSummary]:/thycotic.secretserver/abouttopics/about_tssgroupusersummary
+[TssGroupLookup]:/thycotic.secretserver/abouttopics/about_tssgrouplookup
 [TssDependencyTemplate]:/thycotic.secretserver/abouttopics/about_tssdependencytemplate
 [TssSecretDependencyTaskError]:/thycotic.secretserver/abouttopics/about_tsssecretdependencytaskerror
 [TssSecretDependencyTaskProgress]:/thycotic.secretserver/abouttopics/about_tsssecretdependencytaskprogress

diff --git a/docs/collections/_pages/commands.md b/docs/collections/_pages/commands.md
@@ -74,6 +74,7 @@ The table below lists the API endpoints matched up to the function that directly
 
 **Command** | **API Endpoint** |
 ---------------- | --------------------------------- |
+[Find-TssGroup] | GET /groups/lookups
 [Get-TssGroupMember] | GET /groups/{id}/users
 [Search-TssGroup] | GET /groups
 
@@ -271,4 +272,5 @@ The table below lists the API endpoints matched up to the function that directly
 [Remove-TssSecretDependency]:/thycotic.secretserver/commands/Remove-TssSecretDependency
 [Start-TssSecretDependency]:/thycotic.secretserver/commands/Start-TssSecretDependency
 [Get-TssSecretDependencyRunStatus]:/thycotic.secretserver/commands/Get-TssSecretDependencyRunStatus
-[Get-TssSecretDependencyTemplate]:/thycotic.secretserver/commands/Get-TssSecretDependencyTemplate
+[Get-TssSecretDependencyTemplate]:/thycotic.secretserver/commands/Get-TssSecretDependencyTemplate
+[Find-TssGroup]:/thycotic.secretserver/commands/Find-TssGroup
diff --git a/src/Thycotic.SecretServer.Format.ps1xml b/src/Thycotic.SecretServer.Format.ps1xml
@@ -1626,5 +1626,33 @@
       </TableControl>
     </View>
 
+    <!-- Find-TssGroup -->
+    <View>
+      <Name>TssGroupLookup</Name>
+      <ViewSelectedBy>
+        <TypeName>TssGroupLookup</TypeName>
+      </ViewSelectedBy>
+      <TableControl>
+        <TableHeaders>
+          <TableColumnHeader>
+          </TableColumnHeader>
+          <TableColumnHeader>
+          </TableColumnHeader>
+        </TableHeaders>
+        <TableRowEntries>
+          <TableRowEntry>
+            <TableColumnItems>
+              <TableColumnItem>
+                <PropertyName>GroupId</PropertyName>
+              </TableColumnItem>
+              <TableColumnItem>
+                <PropertyName>GroupName</PropertyName>
+              </TableColumnItem>
+            </TableColumnItems>
+          </TableRowEntry>
+        </TableRowEntries>
+      </TableControl>
+    </View>
+
   </ViewDefinitions>
 </Configuration>
diff --git a/src/Thycotic.SecretServer.Types.ps1xml b/src/Thycotic.SecretServer.Types.ps1xml
@@ -211,4 +211,17 @@
             </AliasProperty>
         </Members>
     </Type>
+    <Type>
+        <Name>TssGroupLookup</Name>
+        <Members>
+            <AliasProperty>
+                <Name>GroupId</Name>
+                <ReferencedMemberName>Id</ReferencedMemberName>
+            </AliasProperty>
+            <AliasProperty>
+                <Name>GroupName</Name>
+                <ReferencedMemberName>Value</ReferencedMemberName>
+            </AliasProperty>
+        </Members>
+    </Type>
 </Types>
diff --git a/src/classes/groups/TssGroupLookup.class.ps1 b/src/classes/groups/TssGroupLookup.class.ps1
@@ -0,0 +1,7 @@
+class TssGroupLookup {
+    [int]
+    $Id
+
+    [string]
+    $Value
+}
diff --git a/src/en-us/about_tssgrouplookup.help.txt b/src/en-us/about_tssgrouplookup.help.txt
@@ -0,0 +1,22 @@
+TOPIC
+    This help topic describes the TssGroupLookup class in the Thycotic.SecretServer module
+
+CLASS
+    TssGroupLookup
+
+INHERITANCE
+    None
+
+DESCRIPTION
+    The TssGroupLookup class represents the GroupLookup object returned by Secret Server endpoint GET /groups/lookup
+
+CONSTRUCTORS
+    new()
+
+PROPERTIES
+    Documented in the REST API doc for Secret Server, see GroupLookup definition
+
+METHODS
+
+RELATED LINKS:
+    Find-TssGroup
diff --git a/src/functions/groups/Find-Group.ps1 b/src/functions/groups/Find-Group.ps1
@@ -0,0 +1,104 @@
+function Find-Group {
+    <#
+    .SYNOPSIS
+    Find for a Secret Server Group
+
+    .DESCRIPTION
+    Find for a Secret Server Group (domain or local)
+
+    .LINK
+    https://thycotic-ps.github.io/thycotic.secretserver/commands/Find-TssGroup
+
+    .LINK
+    https://github.com/thycotic-ps/thycotic.secretserver/blob/main/src/functions/groups/Find-Group.ps1
+
+    .EXAMPLE
+    $session = New-TssSession -SecretServer https://alpha -Credential $ssCred
+    Find-TssGroup -TssSession $session -DomainId 1
+
+    Return list of Groups found in Secret Server for Domain Directory 1
+
+    .EXAMPLE
+    $session = New-TssSession -SecretServer https://alpha/SecretServer -Credential $ssCred
+    Find-TssGroup -TssSession $session -SearchText 'IT'
+
+    Return list of Groups found in Secret Server matching the characters IT
+
+    .NOTES
+    Requires TssSession object returned by New-TssSession
+    #>
+    [CmdletBinding()]
+    [OutputType('TssGroupLookup')]
+    param (
+        # TssSession object created by New-TssSession for auth
+        [Parameter(Mandatory, ValueFromPipeline, Position = 0)]
+        [TssSession]
+        $TssSession,
+
+        # Director Services Domain Id
+        [int]
+        $DomainId,
+
+        # Limit to groups the current user can view details
+        [switch]
+        $ViewableGroups,
+
+        # Search text
+        [string]
+        $SearchText,
+
+        # Include inactive Groups
+        [switch]
+        $IncludeInactive,
+
+        # Sort by specific property, default Name
+        [string]
+        $SortBy = 'Name'
+    )
+    begin {
+        $tssParams = $PSBoundParameters
+        $invokeParams = . $GetInvokeTssParams $TssSession
+    }
+    process {
+        Write-Verbose "Provided command parameters: $(. $GetInvocation $PSCmdlet.MyInvocation)"
+        if ($tssParams.ContainsKey('TssSession') -and $TssSession.IsValidSession()) {
+            . $CheckVersion $TssSession '10.9.000000' $PSCmdlet.MyInvocation
+            $restResponse = $null
+            $uri = $TssSession.ApiUrl, 'groups', 'lookup' -join '/'
+            $uri = $uri, "sortBy[0].direction=asc&sortBy[0].name=$SortBy&take=$($TssSession.Take)" -join '?'
+            $invokeParams.Method = 'GET'
+
+            $filters = @()
+            switch ($tssParams.Keys) {
+                'DomainId' { $filters += "filter.domainId=$DomainId" }
+                'IncludeInactive' { $filters += "filter.includeInactive=$([boolean]$IncludeInactive)" }
+                'ViewableGroups' { $filters += "filter.limitToViewableGroups=$([boolean]$ViewableGroups)" }
+                'SearchText' { $filters += "filter.searchText=$SearchText" }
+            }
+            if ($filters) {
+                $uriFilter = $filters -join '&'
+                Write-Verbose "Filters: $uriFilter"
+                $uri = $uri, $uriFilter -join '&'
+            }
+            $invokeParams.Uri = $uri
+
+            Write-Verbose "Performing the operation $($invokeParams.Method) $uri"
+            try {
+                $restResponse = . $InvokeApi @invokeParams
+            } catch {
+                Write-Warning "Issue on find request"
+                $err = $_
+                . $ErrorHandling $err
+            }
+
+            if ($restResponse.records.Count -le 0 -and $restResponse.records.Length -eq 0) {
+                Write-Warning "No Group found"
+            }
+            if ($restResponse.records) {
+                [TssGroupLookup[]]$restResponse.records
+            }
+        } else {
+            Write-Warning "No valid session found"
+        }
+    }
+}
diff --git a/tests/groups/Find-Group.Tests.ps1 b/tests/groups/Find-Group.Tests.ps1
@@ -0,0 +1,25 @@
+BeforeDiscovery {
+    $commandName = Split-Path ($PSCommandPath.Replace('.Tests.ps1','')) -Leaf
+    . ([IO.Path]::Combine([string]$PSScriptRoot, '..', 'constants.ps1'))
+}
+Describe "$commandName verify parameters" {
+    BeforeDiscovery {
+        [object[]]$knownParameters = 'TssSession', 'DomainId', 'IncludeInactive', 'SearchText', 'ViewableGroups'
+        [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 TssGroupLookup" -TestCases $commandDetails {
+            $_.OutputType.Name | Should -Be 'TssGroupLookup'
+        }
+    }
+}