Update manifest and docs to 5.0.0

CHANGELOG.md

@@ -1,3 +1,20 @@
+## 5.0.0
+- Rewrite Get-TppAttribute
+  - Greatly simplified with far less parameters needed
+  - Attributes, which have values, available as properties at the root level in the response.  This is useful for direct value access.
+  - A property named `Attribute` has been added with all attribute names, values, and configuration.  This is useful for looping over the attributes, determining where a policy attribute is set, and more.
+- Add TPP engine management functions `Add-TppEngineFolder`, `Find-TppEngine`, `Get-TppEngineFolder`, and `Remove-TppEngineFolder`.  Thanks [@ccamacho1966](https://github.com/ccamacho1966)!
+- Add VaaS connector management functions `Get-VaasConnector`, `New-VaasConnector`, and `Rmove-VaasConnector`.  Currently limited to webhooks with event type scope.
+- Add VaaS and TPP certificate deletion to `Invoke-VenafiCertificateAction`
+- Add `-IncludeVaasOwner` to `Find-VenafiCertificate` and `Get-VenafiCertificate` to include user/team owner detailed info on VaaS
+- Add 'application' property to `Find-VenafiCertificate` and `Get-VenafiCertificate` with application details on VaaS
+- Add `-All` to `Get-VenafiCertificate` to retrieve all certificates.  This replaces the default behavior of getting all with no parameters.
+- Add prepending '\ved\policy' when a root path isn't provided to many functions
+- Fix `Invoke-VenafiCertificateAction` not triggering some actions on VaaS
+- Fix `Get-VenafiCertificate` returning TppObject instead of detailed certificate info when getting all
+- **Note: please test your code when using the above functions as there are breaking changes in this release**
+
+
 ## 4.6.3
 - Add paging support to `Find-VenafiCertificate` for VaaS
 - Update `Get-VaasApplication -ID` and `Get-VenafiTeam -ID` for VaaS to accept a name in addition to guid
@@ -423,3 +440,4 @@
 
 
 
+

VenafiPS/VenafiPS.psd1

@@ -3,7 +3,7 @@
 #
 # Generated by: Venafi
 #
-# Generated on: 07/23/2022
+# Generated on: 09/20/2022
 #
 
 @{
@@ -12,7 +12,7 @@
 RootModule = 'VenafiPS.psm1'
 
 # Version number of this module.
-ModuleVersion = '5.0'
+ModuleVersion = '5.0.0'
 
 # Supported PSEditions
 # CompatiblePSEditions = @()
@@ -102,8 +102,9 @@ FunctionsToExport = 'Add-TppCertificateAssociation', 'Convert-TppObject',
                'Remove-VenafiTeam', 'Add-VenafiTeamMember', 'Add-VenafiTeamOwner',
                'Remove-VenafiTeamMember', 'Remove-VenafiTeamOwner', 'New-VenafiTeam',
                'Search-TppHistory', 'Get-VaasIssuingTemplate', 'New-VaasApplication',
-               'Import-VaasCertificate', 'Get-VaasConnector', 'Remove-VaasConnector', 'New-VaasConnector',
-               'Find-TppEngine', 'Get-TppEngineFolder', 'Remove-TppEngineFolder', 'Add-TppEngineFolder'
+               'Import-VaasCertificate', 'Get-VaasConnector', 'Remove-VaasConnector',
+               'New-VaasConnector', 'Find-TppEngine', 'Get-TppEngineFolder',
+               'Remove-TppEngineFolder', 'Add-TppEngineFolder'
 
 # Cmdlets to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no cmdlets to export.
 CmdletsToExport = @()

docs/changelog.md

@@ -1,3 +1,20 @@
+## 5.0.0
+- Rewrite Get-TppAttribute
+  - Greatly simplified with far less parameters needed
+  - Attributes, which have values, available as properties at the root level in the response.  This is useful for direct value access.
+  - A property named `Attribute` has been added with all attribute names, values, and configuration.  This is useful for looping over the attributes, determining where a policy attribute is set, and more.
+- Add TPP engine management functions `Add-TppEngineFolder`, `Find-TppEngine`, `Get-TppEngineFolder`, and `Remove-TppEngineFolder`.  Thanks [@ccamacho1966](https://github.com/ccamacho1966)!
+- Add VaaS connector management functions `Get-VaasConnector`, `New-VaasConnector`, and `Rmove-VaasConnector`.  Currently limited to webhooks with event type scope.
+- Add VaaS and TPP certificate deletion to `Invoke-VenafiCertificateAction`
+- Add `-IncludeVaasOwner` to `Find-VenafiCertificate` and `Get-VenafiCertificate` to include user/team owner detailed info on VaaS
+- Add 'application' property to `Find-VenafiCertificate` and `Get-VenafiCertificate` with application details on VaaS
+- Add `-All` to `Get-VenafiCertificate` to retrieve all certificates.  This replaces the default behavior of getting all with no parameters.
+- Add prepending '\ved\policy' when a root path isn't provided to many functions
+- Fix `Invoke-VenafiCertificateAction` not triggering some actions on VaaS
+- Fix `Get-VenafiCertificate` returning TppObject instead of detailed certificate info when getting all
+- **Note: please test your code when using the above functions as there are breaking changes in this release**
+
+
 ## 4.6.3
 - Add paging support to `Find-VenafiCertificate` for VaaS
 - Update `Get-VaasApplication -ID` and `Get-VenafiTeam -ID` for VaaS to accept a name in addition to guid
@@ -423,3 +440,4 @@
 
 
 
+

docs/functions/Add-TppEngineFolder.md

@@ -0,0 +1,134 @@
+# Add-TppEngineFolder
+
+## SYNOPSIS
+Add policy folder assignments to a TPP processing engine
+
+## SYNTAX
+
+```
+Add-TppEngineFolder [-EnginePath] <String> [-FolderPath] <String[]> [[-VenafiSession] <PSObject>] [-WhatIf]
+ [-Confirm] [<CommonParameters>]
+```
+
+## DESCRIPTION
+Add one or more policy folder assignments to a TPP processing engine.
+
+## EXAMPLES
+
+### EXAMPLE 1
+```
+Add-TppEngineFolder -EnginePath '\VED\Engines\MYVENAFI01' -FolderPath '\VED\Policy\Certificates\Web Team'
+Add processing engine MYVENAFI01 to the policy folders '\VED\Policy\Certificates\Web Team'.
+```
+
+### EXAMPLE 2
+```
+Add-TppEngineFolder -EnginePath '\VED\Engines\MYVENAFI01' -FolderPath @('\VED\Policy\Certificates\Web Team','\VED\Policy\Certificates\Database Team')
+Add processing engine MYVENAFI01 to the policy folders '\VED\Policy\Certificates\Web Team' and '\VED\Policy\Certificates\Database Team'.
+```
+
+### EXAMPLE 3
+```
+$EngineObjects | Add-TppEngineFolder -FolderPath @('\VED\Policy\Certificates\Web Team','\VED\Policy\Certificates\Database Team') -Confirm:$false
+Add one or more processing engines via the pipeline to multiple policy folders. Suppress the confirmation prompt.
+```
+
+## PARAMETERS
+
+### -EnginePath
+The full DN path to a TPP processing engine.
+
+```yaml
+Type: String
+Parameter Sets: (All)
+Aliases: EngineDN, Engine, Path
+
+Required: True
+Position: 1
+Default value: None
+Accept pipeline input: True (ByPropertyName)
+Accept wildcard characters: False
+```
+
+### -FolderPath
+The full DN path to one or more policy folders (string array).
+
+```yaml
+Type: String[]
+Parameter Sets: (All)
+Aliases: FolderDN, Folder
+
+Required: True
+Position: 2
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -VenafiSession
+Authentication for the function.
+The value defaults to the script session object $VenafiSession created by New-VenafiSession.
+A TPP token can also provided, but this requires an environment variable TPP_SERVER to be set.
+
+```yaml
+Type: PSObject
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: 3
+Default value: $script:VenafiSession
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -WhatIf
+Shows what would happen if the cmdlet runs.
+The cmdlet is not run.
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: (All)
+Aliases: wi
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -Confirm
+Prompts you for confirmation before running the cmdlet.
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: (All)
+Aliases: cf
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+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
+
+### EnginePath or EngineObject, FolderPath[]
+## OUTPUTS
+
+### None
+## NOTES
+
+## RELATED LINKS
+
+[http://VenafiPS.readthedocs.io/en/latest/functions/Add-TppEngineFolder/](http://VenafiPS.readthedocs.io/en/latest/functions/Add-TppEngineFolder/)
+
+[https://github.com/Venafi/VenafiPS/blob/main/VenafiPS/Public/Add-TppEngineFolder.ps1](https://github.com/Venafi/VenafiPS/blob/main/VenafiPS/Public/Add-TppEngineFolder.ps1)
+
+[https://docs.venafi.com/Docs/current/TopNav/Content/SDK/WebSDK/r-SDK-POST-ProcessingEngines-Engine-eguid.php](https://docs.venafi.com/Docs/current/TopNav/Content/SDK/WebSDK/r-SDK-POST-ProcessingEngines-Engine-eguid.php)
+

docs/functions/Find-TppEngine.md

@@ -0,0 +1,75 @@
+# Find-TppEngine
+
+## SYNOPSIS
+Find TPP engines using an optional pattern
+
+## SYNTAX
+
+```
+Find-TppEngine [-Pattern] <String> [[-VenafiSession] <PSObject>] [<CommonParameters>]
+```
+
+## DESCRIPTION
+Find TPP engines using an optional pattern.
+This function is an engine wrapper for Find-TppObject.
+
+## EXAMPLES
+
+### EXAMPLE 1
+```
+Find-TppEngine -Pattern '*partialname*'
+```
+
+Get engines whose name matches the supplied pattern
+
+## PARAMETERS
+
+### -Pattern
+Filter against engine names using asterisk (*) and/or question mark (?) wildcard characters.
+
+```yaml
+Type: String
+Parameter Sets: (All)
+Aliases:
+
+Required: True
+Position: 1
+Default value: None
+Accept pipeline input: True (ByValue)
+Accept wildcard characters: False
+```
+
+### -VenafiSession
+Authentication for the function.
+The value defaults to the script session object $VenafiSession created by New-VenafiSession.
+A TPP token can also provided, but this requires an environment variable TPP_SERVER to be set.
+
+```yaml
+Type: PSObject
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: 2
+Default value: $script:VenafiSession
+Accept pipeline input: False
+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
+
+### Pattern
+## OUTPUTS
+
+### TppObject
+## NOTES
+
+## RELATED LINKS
+
+[http://VenafiPS.readthedocs.io/en/latest/functions/Find-TppEngine/](http://VenafiPS.readthedocs.io/en/latest/functions/Find-TppEngine/)
+
+[https://github.com/Venafi/VenafiPS/blob/main/VenafiPS/Public/Find-TppEngine.ps1](https://github.com/Venafi/VenafiPS/blob/main/VenafiPS/Public/Find-TppEngine.ps1)
+

docs/functions/Find-VenafiCertificate.md

@@ -29,8 +29,8 @@ Find-VenafiCertificate [-Path <String>] [-Guid <Guid>] [-Recursive] [-Limit <Int
 
 ### VaaS
 ```
-Find-VenafiCertificate [-Filter <ArrayList>] [-Order <PSObject[]>] [-VenafiSession <PSObject>]
- [-IncludeTotalCount] [-Skip <UInt64>] [-First <UInt64>] [<CommonParameters>]
+Find-VenafiCertificate [-Filter <ArrayList>] [-Order <PSObject[]>] [-IncludeVaasOwner]
+ [-VenafiSession <PSObject>] [-IncludeTotalCount] [-Skip <UInt64>] [-First <UInt64>] [<CommonParameters>]
 ```
 
 ## DESCRIPTION
@@ -133,6 +133,14 @@ Find-VenafiCertificate -Filter ('and', @('validityEnd','GTE',(get-date)), @('val
 Find VaaS certificates matching multiple values. 
 In this case, find all certificates expiring in the next 30 days.
 
+### EXAMPLE 14
+```
+Find-VenafiCertificate -IncludeVaasOwner
+```
+
+When finding VaaS certificates, include user/team owner information.
+This will make additional api calls and will increase the response time.
+
 ## PARAMETERS
 
 ### -Path
@@ -852,6 +860,22 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
+### -IncludeVaasOwner
+Retrieve detailed user/team owner info, only for VaaS.
+This will cause additional api calls to be made and take longer.
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: VaaS
+Aliases:
+
+Required: False
+Position: Named
+Default value: False
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
 ### -CountOnly
 Return the count of certificates found from the query as opposed to the certificates themselves