Update manifest and docs to 5.6.0

CHANGELOG.md

@@ -1,3 +1,10 @@
+## 5.6.0
+- Add specific error messages when a TPP token scope/privilege is not sufficient for the current function.  The message will include both the current and missing scope/privilege, [#175](https://github.com/Venafi/VenafiPS/issues/175).
+- Add `Set-VaasTeam` to update existing VaaS teams. You can update the name, role, and/or user matching rules. User matching rules can be overwritten or appended to.
+- Add `Remove-VaasObject` to remove a VaaS team, application, machine, machine identity, tag, or connector.
+- Remove `TppObject` class. This was causing issues for some who aren't familiar with the Using keyword and differences between it and import-module when it comes to classes.
+- Add `Invoke-VaasWorkflow` to trigger either a Test, Provision, or Discover machine/machine identity workflow. As one example, this is super helpful when looking to automate renewal and provisioning of certificates that may expire soon.
+
 ## 5.5.1
 - Fix error with `Get-TppPermission` when an identity which had been permissioned has had its account deleted.  Explicit permissions will be returned, but the identity path and name will be null as we can no longer look it up from the provider.
 - `Get-TppPermission -Attribute` has been deprecated.  Identity path and name are included in the return object.  For other attributes, use `Get-TppIdentityAttribute`.
@@ -534,5 +541,6 @@
 
 
 
+
 
 

VenafiPS/VenafiPS.psd1

@@ -3,7 +3,7 @@
 #
 # Generated by: Venafi
 #
-# Generated on: 05/19/2023
+# Generated on: 07/12/2023
 #
 
 @{
@@ -12,7 +12,7 @@
 RootModule = 'VenafiPS.psm1'
 
 # Version number of this module.
-ModuleVersion = '5.6'
+ModuleVersion = '5.6.0'
 
 # Supported PSEditions
 # CompatiblePSEditions = @()
@@ -57,13 +57,12 @@ PowerShellVersion = '5.1'
 # RequiredAssemblies = @()
 
 # Script files (.ps1) that are run in the caller's environment prior to importing this module.
-ScriptsToProcess = 'Classes\TppPermission.ps1',
-               'Classes\VenafiSession.ps1', 'Enum\TppCertificateStage.ps1',
-               'Enum\TppCodeSignProjectStatus.ps1', 'Enum\TppCodeSignResult.ps1',
-               'Enum\TppConfigResult.ps1', 'Enum\TppEventSeverity.ps1',
-               'Enum\TppIdentityType.ps1', 'Enum\TppManagementType.ps1',
-               'Enum\TppMetadataResult.ps1', 'Enum\TppSecretStoreResult.ps1',
-               'Enum\TppWorkflowResult.ps1'
+ScriptsToProcess = 'Classes\TppPermission.ps1', 'Classes\VenafiSession.ps1',
+               'Enum\TppCertificateStage.ps1', 'Enum\TppCodeSignProjectStatus.ps1',
+               'Enum\TppCodeSignResult.ps1', 'Enum\TppConfigResult.ps1',
+               'Enum\TppEventSeverity.ps1', 'Enum\TppIdentityType.ps1',
+               'Enum\TppManagementType.ps1', 'Enum\TppMetadataResult.ps1',
+               'Enum\TppSecretStoreResult.ps1', 'Enum\TppWorkflowResult.ps1'
 
 # Type files (.ps1xml) to be loaded when importing this module
 # TypesToProcess = @()
@@ -107,7 +106,8 @@ FunctionsToExport = 'Add-TppCertificateAssociation', 'Convert-TppObject',
                'New-VaasConnector', 'Find-TppEngine', 'Get-TppEngineFolder',
                'Remove-TppEngineFolder', 'Add-TppEngineFolder', 'Revoke-TppGrant',
                'Add-TppAdaptableHash', 'New-VaasCertificate', 'Find-VaasObject',
-               'Remove-TppObject', 'Set-VaasTeam', 'Remove-VaasObject', 'Invoke-VaasWorkflow'
+               'Remove-TppObject', 'Set-VaasTeam', 'Remove-VaasObject',
+               'Invoke-VaasWorkflow'
 
 # 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,10 @@
+## 5.6.0
+- Add specific error messages when a TPP token scope/privilege is not sufficient for the current function.  The message will include both the current and missing scope/privilege, [#175](https://github.com/Venafi/VenafiPS/issues/175).
+- Add `Set-VaasTeam` to update existing VaaS teams. You can update the name, role, and/or user matching rules. User matching rules can be overwritten or appended to.
+- Add `Remove-VaasObject` to remove a VaaS team, application, machine, machine identity, tag, or connector.
+- Remove `TppObject` class. This was causing issues for some who aren't familiar with the Using keyword and differences between it and import-module when it comes to classes.
+- Add `Invoke-VaasWorkflow` to trigger either a Test, Provision, or Discover machine/machine identity workflow. As one example, this is super helpful when looking to automate renewal and provisioning of certificates that may expire soon.
+
 ## 5.5.1
 - Fix error with `Get-TppPermission` when an identity which had been permissioned has had its account deleted.  Explicit permissions will be returned, but the identity path and name will be null as we can no longer look it up from the provider.
 - `Get-TppPermission -Attribute` has been deprecated.  Identity path and name are included in the return object.  For other attributes, use `Get-TppIdentityAttribute`.
@@ -534,5 +541,6 @@
 
 
 
+
 
 

docs/functions/Add-TppAdaptableHash.md

@@ -106,7 +106,7 @@ Aliases:
 
 Required: False
 Position: 4
-Default value: $VenafiSession
+Default value: $script:VenafiSession
 Accept pipeline input: False
 Accept wildcard characters: False
 ```

docs/functions/Add-TppCertificateAssociation.md

@@ -7,7 +7,7 @@ Add certificate association
 
 ### AddByObject
 ```
-Add-TppCertificateAssociation -InputObject <TppObject> [-ApplicationPath <String[]>] [-PushCertificate]
+Add-TppCertificateAssociation -InputObject <PSObject> [-ApplicationPath <String[]>] [-PushCertificate]
  [-VenafiSession <PSObject>] [-WhatIf] [-Confirm] [<CommonParameters>]
 ```
 
@@ -41,7 +41,7 @@ Add the association and push the certificate
 TppObject which represents a certificate
 
 ```yaml
-Type: TppObject
+Type: PSObject
 Parameter Sets: AddByObject
 Aliases:
 

docs/functions/Get-TppObject.md

@@ -94,7 +94,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
 ### Path, Guid
 ## OUTPUTS
 
-### TppObject
+### PSCustomObject
 ## NOTES
 
 ## RELATED LINKS

docs/functions/Get-TppPermission.md

@@ -7,7 +7,7 @@ Get permissions for TPP objects
 
 ### ByObject (Default)
 ```
-Get-TppPermission -InputObject <TppObject> [-IdentityId <String[]>] [-Explicit] [-VenafiSession <PSObject>]
+Get-TppPermission -InputObject <PSObject> [-IdentityId <String[]>] [-Explicit] [-VenafiSession <PSObject>]
  [<CommonParameters>]
 ```
 
@@ -84,7 +84,7 @@ TppObject representing an object in TPP, eg.
 from Find-TppObject or Get-TppObject
 
 ```yaml
-Type: TppObject
+Type: PSObject
 Parameter Sets: ByObject
 Aliases:
 

docs/functions/Get-TppWorkflowTicket.md

@@ -7,7 +7,7 @@ Get workflow ticket
 
 ### ByObject
 ```
-Get-TppWorkflowTicket -InputObject <TppObject> [-VenafiSession <PSObject>] [<CommonParameters>]
+Get-TppWorkflowTicket -InputObject <PSObject> [-VenafiSession <PSObject>] [<CommonParameters>]
 ```
 
 ### ByPath
@@ -43,7 +43,7 @@ Get ticket details for multiple certificates
 TppObject which represents a certificate object
 
 ```yaml
-Type: TppObject
+Type: PSObject
 Parameter Sets: ByObject
 Aliases:
 

docs/functions/Invoke-VaasWorkflow.md

@@ -0,0 +1,119 @@
+# Invoke-VaasWorkflow
+
+## SYNOPSIS
+Start a machine or machine identity workflow
+
+## SYNTAX
+
+```
+Invoke-VaasWorkflow [-ID] <String> [[-WorkflowName] <String>] [[-VenafiSession] <PSObject>]
+ [<CommonParameters>]
+```
+
+## DESCRIPTION
+Start a workflow to either test machine credentials or provision or discover machine identities
+
+## EXAMPLES
+
+### EXAMPLE 1
+```
+Invoke-VaasWorkflow -ID '1345baf1-fc56-49b7-aa03-78e35bfe0a1a' -WorkflowName 'Provision'
+```
+
+ID                                   WorkflowName Success
+--                                   ------------ -------
+89fa4370-2026-11ee-8a18-ff9579bb988e Test         True
+
+Trigger provisioning
+
+### EXAMPLE 2
+```
+Invoke-VaasWorkflow -ID '1345baf1-fc56-49b7-aa03-78e35bfe0a1a' -WorkflowName 'Provision'
+```
+
+ID                                   WorkflowName Success Error
+--                                   ------------ ------- -----
+1345baf1-fc56-49b7-aa03-78e35bfe0a1a Provision    False   Failed for some reason....
+
+Trigger provisioning, but it failed
+
+### EXAMPLE 3
+```
+Find-VaasObject -Type MachineIdentity -Filter @('and', @('certificateValidityEnd', 'lt', (get-date).AddDays(30)), @('certificateValidityEnd', 'gt', (get-date))) | ForEach-Object {
+    $renewResult = $_ | Invoke-VenafiCertificateAction -Renew
+    # optionally add renew validation
+    $_ | Invoke-VaasWorkflow -WorkflowName 'Provision'
+}
+```
+
+ID                                   WorkflowName Success
+--                                   ------------ -------
+89fa4370-2026-11ee-8a18-ff9579bb988e Provision    True
+7598917c-7027-4927-be73-e592bcc4c567 Provision    True
+
+Renew and provision all machine identities with certificates expiring within 30 days
+
+## PARAMETERS
+
+### -ID
+Machine or machine identity id for the workflow to trigger.
+Workflows 'Test' and 'GetConfig' require the machine ID.
+Workflows 'Provision' and 'Discover' require the machine identity ID.
+
+```yaml
+Type: String
+Parameter Sets: (All)
+Aliases: machineID, machineIdentityID
+
+Required: True
+Position: 1
+Default value: None
+Accept pipeline input: True (ByPropertyName, ByValue)
+Accept wildcard characters: False
+```
+
+### -WorkflowName
+The name of the workflow to trigger.
+Valid values are 'Test', 'GetConfig', 'Provision', or 'Discover'.
+
+```yaml
+Type: String
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: 2
+Default value: Test
+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 VaaS key can also provided.
+
+```yaml
+Type: PSObject
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: 3
+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
+
+### ID
+## OUTPUTS
+
+### pscustomobject
+## NOTES
+
+## RELATED LINKS

docs/functions/Remove-TppCertificateAssociation.md

@@ -7,13 +7,13 @@ Remove certificate associations
 
 ### RemoveAllByObject
 ```
-Remove-TppCertificateAssociation -InputObject <TppObject> [-OrphanCleanup] [-All] [-VenafiSession <PSObject>]
+Remove-TppCertificateAssociation -InputObject <PSObject> [-OrphanCleanup] [-All] [-VenafiSession <PSObject>]
  [-WhatIf] [-Confirm] [<CommonParameters>]
 ```
 
 ### RemoveOneByObject
 ```
-Remove-TppCertificateAssociation -InputObject <TppObject> -ApplicationPath <String[]> [-OrphanCleanup]
+Remove-TppCertificateAssociation -InputObject <PSObject> -ApplicationPath <String[]> [-OrphanCleanup]
  [-VenafiSession <PSObject>] [-WhatIf] [-Confirm] [<CommonParameters>]
 ```
 
@@ -59,7 +59,7 @@ Remove all certificate associations
 TppObject which represents a unique object
 
 ```yaml
-Type: TppObject
+Type: PSObject
 Parameter Sets: RemoveAllByObject, RemoveOneByObject
 Aliases: