Update manifest and docs to 6.3.2

Venafi · May 14, 2024 · 9f1822f · 9f1822f
1 parent ac1ee76
commit 9f1822f
Show file tree

Hide file tree

Showing 6 changed files with 237 additions and 15 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,9 @@
+## 6.3.2
+- Add `Get-VdcCredential -IncludeDetail` to provide additional credential information eg. expiration, path to linked certificate, and more
+- Add discrete parameters to `Set-VdcCredential` to simplify updating credentials; `-Value` will be deprecated. Add support for updating the Expiration and setting a Credential 'link' to an existing certificate in TLSPDC.
+- Update `Invoke-VcWorkflow` API endpoint  [#275](https://github.com/Venafi/VenafiPS/issues/275)
+- Fix `Test-VdcToken -VenafiSession` when the parameter value is null/empty [#274](https://github.com/Venafi/VenafiPS/issues/274)
+
 ## 6.3.1
 - `Get-VdcAttribute` parallel enhancements to support input objects of -Path and not just -All.  [#271](https://github.com/Venafi/VenafiPS/issues/271)
 - Add `Get-VdcAttribute -ThrottleLimit`
@@ -693,5 +699,6 @@ This is a major release.  Although every attempt has been made to be backwards c
 
 
 
+
 
 
diff --git a/VenafiPS/VenafiPS.psd1 b/VenafiPS/VenafiPS.psd1
@@ -3,7 +3,7 @@
 #
 # Generated by: Greg Brownstein
 #
-# Generated on: 03/27/2024
+# Generated on: 05/14/2024
 #
 
 @{
@@ -12,7 +12,7 @@
 RootModule = 'VenafiPS.psm1'
 
 # Version number of this module.
-ModuleVersion = '6.3.1'
+ModuleVersion = '6.3.2'
 
 # Supported PSEditions
 # CompatiblePSEditions = @()

diff --git a/docs/changelog.md b/docs/changelog.md
@@ -1,3 +1,9 @@
+## 6.3.2
+- Add `Get-VdcCredential -IncludeDetail` to provide additional credential information eg. expiration, path to linked certificate, and more
+- Add discrete parameters to `Set-VdcCredential` to simplify updating credentials; `-Value` will be deprecated. Add support for updating the Expiration and setting a Credential 'link' to an existing certificate in TLSPDC.
+- Update `Invoke-VcWorkflow` API endpoint  [#275](https://github.com/Venafi/VenafiPS/issues/275)
+- Fix `Test-VdcToken -VenafiSession` when the parameter value is null/empty [#274](https://github.com/Venafi/VenafiPS/issues/274)
+
 ## 6.3.1
 - `Get-VdcAttribute` parallel enhancements to support input objects of -Path and not just -All.  [#271](https://github.com/Venafi/VenafiPS/issues/271)
 - Add `Get-VdcAttribute -ThrottleLimit`
@@ -693,5 +699,6 @@ This is a major release.  Although every attempt has been made to be backwards c
 
 
 
+
 
 
diff --git a/docs/functions/Get-VdcCredential.md b/docs/functions/Get-VdcCredential.md
@@ -6,8 +6,8 @@ Get credential details
 ## SYNTAX
 
 ```
-Get-VdcCredential [-Path] <String> [[-VenafiSession] <PSObject>] [-ProgressAction <ActionPreference>]
- [<CommonParameters>]
+Get-VdcCredential [-Path] <String> [-IncludeDetail] [[-VenafiSession] <PSObject>]
+ [-ProgressAction <ActionPreference>] [<CommonParameters>]
 ```
 
 ## DESCRIPTION
@@ -39,6 +39,21 @@ Accept pipeline input: True (ByPropertyName, ByValue)
 Accept wildcard characters: False
 ```
 
+### -IncludeDetail
+Include metadata associated with the credential in addition to the credential itself
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: False
+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.
@@ -82,6 +97,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
 
 ### Password/UsernamePassword Credential - PSCredential
 ### Certificate Credential - X509Certificate2
+### with IncludeDetail - PSCustomObject
 ## NOTES
 
 ## RELATED LINKS

diff --git a/docs/functions/Set-VcApplication.md b/docs/functions/Set-VcApplication.md
@@ -7,7 +7,8 @@ Update an existing application
 
 ```
 Set-VcApplication [-Application] <String> [[-Name] <String>] [[-TeamOwner] <String[]>] [-NoOverwrite]
- [-PassThru] [[-VenafiSession] <PSObject>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
+ [-PassThru] [[-VenafiSession] <PSObject>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm]
+ [<CommonParameters>]
 ```
 
 ## DESCRIPTION
@@ -131,6 +132,37 @@ 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
+```
+
 ### -ProgressAction
 {{ Fill ProgressAction Description }}
 

diff --git a/docs/functions/Set-VdcCredential.md b/docs/functions/Set-VdcCredential.md
@@ -5,24 +5,82 @@ Update credential values
 
 ## SYNTAX
 
+### Password (Default)
 ```
-Set-VdcCredential [-Path] <String> [-Value] <Hashtable> [[-VenafiSession] <PSObject>]
+Set-VdcCredential -Path <String> -Password <PSObject> [-Expiration <DateTime>] [-VenafiSession <PSObject>]
+ [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
+```
+
+### CertificatePath
+```
+Set-VdcCredential -Path <String> -Password <PSObject> -CertificatePath <String> [-Expiration <DateTime>]
+ [-VenafiSession <PSObject>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
+```
+
+### Certificate
+```
+Set-VdcCredential -Path <String> -Password <PSObject> -Certificate <X509Certificate2> [-Expiration <DateTime>]
+ [-VenafiSession <PSObject>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
+```
+
+### UsernamePassword
+```
+Set-VdcCredential -Path <String> -Password <PSObject> -Username <String> [-Expiration <DateTime>]
+ [-VenafiSession <PSObject>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
+```
+
+### CertificateLinkPath
+```
+Set-VdcCredential -Path <String> -CertificateLinkPath <String> [-Expiration <DateTime>]
+ [-VenafiSession <PSObject>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
+```
+
+### OldValue
+```
+Set-VdcCredential -Path <String> -Value <Hashtable> [-VenafiSession <PSObject>]
  [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
 ```
 
 ## DESCRIPTION
 Update values for credential objects in TLSPDC.
-The values allowed to be updated are specific to the object type.
-See https://docs.venafi.com/Docs/current/TopNav/Content/SDK/WebSDK/r-SDK-POST-Credentials-FriendlyName.php for details.
 
 ## EXAMPLES
 
 ### EXAMPLE 1
 ```
-Set-VdcCredential -Path '\VED\Policy\Password Credential' -Value @{'Password'='my-new-password'}
-Set a value
+Set-VdcCredential -Path '\VED\Policy\Password Credential' -Password 'my-new-password'
+```
+
+Set a new password for a password credential
+
+### EXAMPLE 2
+```
+Set-VdcCredential -Path '\VED\Policy\UsernamePassword Credential' -Password 'my-new-password' -Username 'greg'
 ```
 
+Set a new password for a username/password credential
+
+### EXAMPLE 3
+```
+Set-VdcCredential -Path '\VED\Policy\Certificate Credential' -Password 'my-pk-password' -Certificate $p12
+```
+
+Set a new certificate for a certificate credential
+
+### EXAMPLE 4
+```
+Set-VdcCredential -Path '\VED\Policy\Password Credential' -Password 'my-new-password' -Expiration (Get-Date).AddDays(30)
+```
+
+Set a new password for a password credential and set the expiration date to 30 days from now
+
+### EXAMPLE 5
+```
+Set-VdcCredential -Path '\VED\Policy\Certificate Credential' -CertificateLinkPath '\VED\Policy\Certificates\newcert.domain.com'
+```
+
+Set an existing TLSPDC certificate object as the certificate for a certificate credential
+
 ## PARAMETERS
 
 ### -Path
@@ -34,22 +92,124 @@ Parameter Sets: (All)
 Aliases:
 
 Required: True
-Position: 1
+Position: Named
 Default value: None
 Accept pipeline input: True (ByPropertyName, ByValue)
 Accept wildcard characters: False
 ```
 
+### -Password
+New password for a password, username/password, or certificate credential. 
+Provide a string, SecureString, or PSCredential.
+
+```yaml
+Type: PSObject
+Parameter Sets: Password, CertificatePath, Certificate, UsernamePassword
+Aliases:
+
+Required: True
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -Username
+New username for a username/password credential.
+A password is also required.
+
+```yaml
+Type: String
+Parameter Sets: UsernamePassword
+Aliases:
+
+Required: True
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -Certificate
+PKCS #12 certificate object for a certificate credential.
+You can provide either a certificate object or CertificatePath to a .p12 or .pfx file.
+A private key password is also required for -Password.
+
+```yaml
+Type: X509Certificate2
+Parameter Sets: Certificate
+Aliases:
+
+Required: True
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -CertificatePath
+Path to a certificate for a certificate credential.
+You can provide either a local path to a .p12 or .pfx file or a certificate object with -Certificate.
+A private key password is also required for -Password.
+
+```yaml
+Type: String
+Parameter Sets: CertificatePath
+Aliases:
+
+Required: True
+Position: Named
+Default value: None
+Accept pipeline input: True (ByPropertyName)
+Accept wildcard characters: False
+```
+
+### -CertificateLinkPath
+Provide a path to an existing TLSPDC certificate object to be used as the certificate for a certificate credential.
+
+```yaml
+Type: String
+Parameter Sets: CertificateLinkPath
+Aliases:
+
+Required: True
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -Expiration
+Expiration date in UTC for the credential. 
+Provide a DateTime object.
+This can be set for username or password credentials.
+
+```yaml
+Type: DateTime
+Parameter Sets: Password, CertificatePath, Certificate, UsernamePassword, CertificateLinkPath
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
 ### -Value
-Hashtable containing the keys/values to be updated
+Hashtable containing the keys/values to be updated.
+This parameter will be deprecated in a future release. 
+Use specific parameters for the credential type.
+The values allowed to be updated are specific to the object type.
+See https://docs.venafi.com/Docs/current/TopNav/Content/SDK/WebSDK/r-SDK-POST-Credentials-FriendlyName.php for details.
 
 ```yaml
 Type: Hashtable
-Parameter Sets: (All)
+Parameter Sets: OldValue
 Aliases:
 
 Required: True
-Position: 2
+Position: Named
 Default value: None
 Accept pipeline input: False
 Accept wildcard characters: False
@@ -67,7 +227,7 @@ Parameter Sets: (All)
 Aliases:
 
 Required: False
-Position: 3
+Position: Named
 Default value: None
 Accept pipeline input: False
 Accept wildcard characters: False