From f7b86534584daa37c55e8a66c340fa11ba6fb433 Mon Sep 17 00:00:00 2001 From: Greg Brownstein Date: Thu, 29 Sep 2022 19:28:12 +0000 Subject: [PATCH] Update manifest and docs to 5.1.0 --- CHANGELOG.md | 11 + VenafiPS/VenafiPS.psd1 | 6 +- docs/changelog.md | 11 + docs/functions/Add-TppAdaptableHash.md | 167 +++++++++ docs/functions/Export-VenafiCertificate.md | 2 +- docs/functions/Get-VenafiCertificate.md | 50 ++- docs/functions/Import-VaasCertificate.md | 4 +- docs/functions/New-VaasCertificate.md | 374 +++++++++++++++++++++ docs/functions/Revoke-TppGrant.md | 100 ++++++ docs/functions/Set-TppAttribute.md | 31 +- mkdocs.yml | 3 + 11 files changed, 703 insertions(+), 56 deletions(-) create mode 100644 docs/functions/Add-TppAdaptableHash.md create mode 100644 docs/functions/New-VaasCertificate.md create mode 100644 docs/functions/Revoke-TppGrant.md diff --git a/CHANGELOG.md b/CHANGELOG.md index 31922538..cd9c82ce 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,13 @@ +## 5.1.0 +- Add `Add-TppAdaptableHash` to automate the updating of an adaptable script hash. Thanks [@wilddev65]! +- Add `New-VaasCertificate` to create new certificates with VaaS +- Add `Revoke-TppGrant` to revoke all grants for a specific user +- Update `Import-VaasCertificate` to accept a name for the application (wildcards supported) +- Add `Get-VenafiCertificate -All` for VaaS +- Update `Get-VenafiCertificate` to persist -ExcludeExpired and -ExcludeRevoked when using -All +- Fix parameter error with `Get-VaasIssuingTemplate` when piping multiple values + + ## 5.0.0 - Rewrite Get-TppAttribute - Greatly simplified with far less parameters needed @@ -440,4 +450,5 @@ + diff --git a/VenafiPS/VenafiPS.psd1 b/VenafiPS/VenafiPS.psd1 index 8cd6259a..a05799f9 100644 --- a/VenafiPS/VenafiPS.psd1 +++ b/VenafiPS/VenafiPS.psd1 @@ -3,7 +3,7 @@ # # Generated by: Venafi # -# Generated on: 09/20/2022 +# Generated on: 09/29/2022 # @{ @@ -12,7 +12,7 @@ RootModule = 'VenafiPS.psm1' # Version number of this module. -ModuleVersion = '5.1' +ModuleVersion = '5.1.0' # Supported PSEditions # CompatiblePSEditions = @() @@ -63,7 +63,7 @@ ScriptsToProcess = 'Classes\TppObject.ps1', 'Classes\TppPermission.ps1', 'Enum\TppConfigResult.ps1', 'Enum\TppEventSeverity.ps1', 'Enum\TppIdentityType.ps1', 'Enum\TppManagementType.ps1', 'Enum\TppMetadataResult.ps1', 'Enum\TppSecretStoreResult.ps1', - 'Enum\TppWorkflowResult.ps1' + 'Enum\TppWorkflowResult.ps1' # Type files (.ps1xml) to be loaded when importing this module # TypesToProcess = @() diff --git a/docs/changelog.md b/docs/changelog.md index 9bc91589..c62bbd65 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -1,3 +1,13 @@ +## 5.1.0 +- Add `Add-TppAdaptableHash` to automate the updating of an adaptable script hash. Thanks [@wilddev65]! +- Add `New-VaasCertificate` to create new certificates with VaaS +- Add `Revoke-TppGrant` to revoke all grants for a specific user +- Update `Import-VaasCertificate` to accept a name for the application (wildcards supported) +- Add `Get-VenafiCertificate -All` for VaaS +- Update `Get-VenafiCertificate` to persist -ExcludeExpired and -ExcludeRevoked when using -All +- Fix parameter error with `Get-VaasIssuingTemplate` when piping multiple values + + ## 5.0.0 - Rewrite Get-TppAttribute - Greatly simplified with far less parameters needed @@ -440,4 +450,5 @@ + diff --git a/docs/functions/Add-TppAdaptableHash.md b/docs/functions/Add-TppAdaptableHash.md new file mode 100644 index 00000000..ac8134ef --- /dev/null +++ b/docs/functions/Add-TppAdaptableHash.md @@ -0,0 +1,167 @@ +# Add-TppAdaptableHash + +## SYNOPSIS +Adds or updates the hash value for an adaptable script + +## SYNTAX + +``` +Add-TppAdaptableHash [-Path] [[-Keyname] ] [-FilePath] [[-VenafiSession] ] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +TPP stores a base64 encoded hash of the file contents of an adaptable script in the Secret Store. +This is referenced by +the Attribute 'PowerShell Script Hash Vault Id' on the DN of the adaptable script. +This script retrieves the hash (if +present) from the Secret Store and compares it to the hash of the file in one of the scripts directories. +It then adds +a new or updated hash if required. +When updating an existing hash, it removes the old one from the Secret Store. + +## EXAMPLES + +### EXAMPLE 1 +``` +Add-TppAdaptableHash -Path $Path -FilePath 'C:\Program Files\Venafi\Scripts\AdaptableApp\AppDriver.ps1' +``` + +Update the hash on an adaptable app object. + +Note: For an adaptable app or an onboard discovery, 'Path' must always be a policy folder as this is where +the hash is saved. + +### EXAMPLE 2 +``` +Add-TppAdaptableHash -Path $Path -FilePath 'C:\Program Files\Venafi\Scripts\AdaptableLog\Generic-LogDriver.ps1' +``` + +Update the hash on an adaptable log object. + +## PARAMETERS + +### -Path +Required. +Path to the object to add or update the hash. +Note: For an adaptable app or an onboard discovery, 'Path' must always be a policy folder as this is where +the hash is saved. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: DN + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Keyname +The name of the Secret Encryption Key (SEK) to used when encrypting this item. +Default is "Software:Default" + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: Software:Default +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FilePath +Required. +The full path to the adaptable script file. +This should normally be in a +'\:\Program Files\Venafi\Scripts\\\' directory for TPP to recognize the script. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: File + +Required: True +Position: 3 +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 or VaaS key can also provided. +If providing a TPP token, an environment variable named TPP_SERVER must also be set. + +```yaml +Type: PSObject +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: $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 + +### None +## OUTPUTS + +### None +## NOTES + +## RELATED LINKS + +[http://VenafiPS.readthedocs.io/en/latest/functions/Add-TppAdaptableHash/](http://VenafiPS.readthedocs.io/en/latest/functions/Add-TppAdaptableHash/) + +[https://github.com/Venafi/VenafiPS/blob/main/VenafiPS/Public/Add-TppAdaptableHash.ps1](https://github.com/Venafi/VenafiPS/blob/main/VenafiPS/Public/Add-TppAdaptableHash.ps1) + +[https://docs.venafi.com/Docs/current/TopNav/Content/SDK/WebSDK/r-SDK-POST-Secretstore-add.php](https://docs.venafi.com/Docs/current/TopNav/Content/SDK/WebSDK/r-SDK-POST-Secretstore-add.php) + +[https://docs.venafi.com/Docs/currentSDK/TopNav/Content/SDK/WebSDK/r-SDK-POST-Secretstore-ownerdelete.php](https://docs.venafi.com/Docs/currentSDK/TopNav/Content/SDK/WebSDK/r-SDK-POST-Secretstore-ownerdelete.php) + +[https://docs.venafi.com/Docs/current/TopNav/Content/SDK/WebSDK/r-SDK-POST-Secretstore-retrieve.php](https://docs.venafi.com/Docs/current/TopNav/Content/SDK/WebSDK/r-SDK-POST-Secretstore-retrieve.php) + diff --git a/docs/functions/Export-VenafiCertificate.md b/docs/functions/Export-VenafiCertificate.md index 5e687087..b8c4b38c 100644 --- a/docs/functions/Export-VenafiCertificate.md +++ b/docs/functions/Export-VenafiCertificate.md @@ -75,7 +75,7 @@ Aliases: Path, id Required: True Position: Named Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` diff --git a/docs/functions/Get-VenafiCertificate.md b/docs/functions/Get-VenafiCertificate.md index ba91d0e7..c54a9eb0 100644 --- a/docs/functions/Get-VenafiCertificate.md +++ b/docs/functions/Get-VenafiCertificate.md @@ -10,7 +10,7 @@ Get certificate information Get-VenafiCertificate -CertificateId [-VenafiSession ] [] ``` -### TppOldVersions +### TppId ``` Get-VenafiCertificate -CertificateId [-IncludeTppPreviousVersions] [-ExcludeExpired] [-ExcludeRevoked] [-VenafiSession ] [] @@ -24,12 +24,18 @@ Get-VenafiCertificate -CertificateId [-IncludeVaasOwner] [-VenafiSessio ### TppAll ``` -Get-VenafiCertificate [-IncludeTppPreviousVersions] [-All] [-VenafiSession ] [] +Get-VenafiCertificate [-All] [-IncludeTppPreviousVersions] [-ExcludeExpired] [-ExcludeRevoked] + [-VenafiSession ] [] ``` ### VaasAll ``` -Get-VenafiCertificate [-IncludeVaasOwner] [-All] [-VenafiSession ] [] +Get-VenafiCertificate [-All] [-IncludeVaasOwner] [-VenafiSession ] [] +``` + +### All +``` +Get-VenafiCertificate [-All] [-VenafiSession ] [] ``` ## DESCRIPTION @@ -89,7 +95,7 @@ For TPP, use the path or guid. ```yaml Type: String -Parameter Sets: Id, TppOldVersions, VaasId +Parameter Sets: Id, TppId, VaasId Aliases: Guid, Path Required: True @@ -99,14 +105,13 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -IncludeTppPreviousVersions -Returns details about previous (historical) versions of a certificate (only from TPP). -This option will add a property named PreviousVersions to the returned object. +### -All +Retrieve all certificates ```yaml Type: SwitchParameter -Parameter Sets: TppOldVersions -Aliases: IncludePreviousVersions +Parameter Sets: TppAll, VaasAll, All +Aliases: Required: True Position: Named @@ -115,12 +120,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -IncludeTppPreviousVersions +Returns details about previous (historical) versions of a certificate (only from TPP). +This option will add a property named PreviousVersions to the returned object. + ```yaml Type: SwitchParameter -Parameter Sets: TppAll +Parameter Sets: TppId, TppAll Aliases: IncludePreviousVersions -Required: False +Required: True Position: Named Default value: False Accept pipeline input: False @@ -133,7 +142,7 @@ Can only be used with the IncludePreviousVersions parameter. ```yaml Type: SwitchParameter -Parameter Sets: TppOldVersions +Parameter Sets: TppId, TppAll Aliases: Required: False @@ -149,7 +158,7 @@ Can only be used with the IncludePreviousVersions parameter. ```yaml Type: SwitchParameter -Parameter Sets: TppOldVersions +Parameter Sets: TppId, TppAll Aliases: Required: False @@ -168,21 +177,6 @@ Type: SwitchParameter Parameter Sets: VaasId, VaasAll Aliases: -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -All -Retrieve all certificates - -```yaml -Type: SwitchParameter -Parameter Sets: TppAll, VaasAll -Aliases: - Required: True Position: Named Default value: False diff --git a/docs/functions/Import-VaasCertificate.md b/docs/functions/Import-VaasCertificate.md index 289ee5de..6cbf73b0 100644 --- a/docs/functions/Import-VaasCertificate.md +++ b/docs/functions/Import-VaasCertificate.md @@ -32,7 +32,7 @@ Import a certificate ### EXAMPLE 2 ``` -Import-VaasCertificate -CertificatePath c:\www.VenafiPS.com.cer -Application 'a2f83b26-c712-4f46-be41-2e1fb901f20c' +Import-VaasCertificate -CertificatePath c:\www.VenafiPS.com.cer -Application MyApp ``` Import a certificate and assign an application @@ -95,7 +95,7 @@ Accept wildcard characters: False ``` ### -Application -Application to assign to this certificate +Application name (wildcards supported) or id to associate this certificate. ```yaml Type: String[] diff --git a/docs/functions/New-VaasCertificate.md b/docs/functions/New-VaasCertificate.md new file mode 100644 index 00000000..78780913 --- /dev/null +++ b/docs/functions/New-VaasCertificate.md @@ -0,0 +1,374 @@ +# New-VaasCertificate + +## SYNOPSIS +Create certificate request + +## SYNTAX + +### Ask (Default) +``` +New-VaasCertificate -Application -IssuingTemplate -ServerType -CommonName + [-Organization ] [-OrganizationalUnit ] [-City ] [-State ] + [-Country ] [-SanDns ] [-SanIP ] [-SanUri ] [-SanEmail ] + [-ValidUntil ] [-PassThru] [-VenafiSession ] [-WhatIf] [-Confirm] [] +``` + +### Csr +``` +New-VaasCertificate -Application -IssuingTemplate -ServerType -Csr + [-SanDns ] [-SanIP ] [-SanUri ] [-SanEmail ] [-ValidUntil ] + [-PassThru] [-VenafiSession ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Create certificate request from automated secure keypair details or CSR + +## EXAMPLES + +### EXAMPLE 1 +``` +New-VaasCertificate -Application 'MyApp' -IssuingTemplate 'MSCA - 1 year' -ServerType 'F5' -CommonName 'app.mycert.com' +``` + +Create certificate + +### EXAMPLE 2 +``` +New-VaasCertificate -Application 'MyApp' -IssuingTemplate 'MSCA - 1 year' -ServerType 'F5' -CommonName 'app.mycert.com' -SanIP '1.2.3.4' +``` + +Create certificate with optional SAN data + +### EXAMPLE 3 +``` +New-VaasCertificate -Application 'MyApp' -IssuingTemplate 'MSCA - 1 year' -ServerType 'F5' -CommonName 'app.mycert.com' -ValidUntil (Get-Date).AddMonths(6) +``` + +Create certificate with specific validity + +### EXAMPLE 4 +``` +New-VaasCertificate -Application 'MyApp' -IssuingTemplate 'MSCA - 1 year' -ServerType 'F5' -CommonName 'app.mycert.com' -PassThru +``` + +Create certificate and return the created object + +### EXAMPLE 5 +``` +New-VaasCertificate -Application 'MyApp' -IssuingTemplate 'MSCA - 1 year' -ServerType 'F5' -Csr "-----BEGIN CERTIFICATE REQUEST-----\nMIICYzCCAUsCAQAwHj....BoiNIqtVQxFsfT+\n-----END CERTIFICATE REQUEST-----\n" +``` + +Create certificate with a CSR + +## PARAMETERS + +### -Application +Application name (wildcards supported) or id to associate this certificate. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IssuingTemplate +Issuing template name (wildcards supported) or id to use. +The template must be available with the selected Application. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerType +Server type name (wildcards supported) or id to associate + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Csr +CSR in PKCS#10 format which conforms to the rules of the issuing template + +```yaml +Type: String +Parameter Sets: Csr +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CommonName +Common name (CN) + +```yaml +Type: String +Parameter Sets: Ask +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Organization +The Organization field for the certificate Subject DN + +```yaml +Type: String +Parameter Sets: Ask +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OrganizationalUnit +One or more departments or divisions within the organization that is responsible for maintaining the certificate + +```yaml +Type: String[] +Parameter Sets: Ask +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -City +The City/Locality field for the certificate Subject DN + +```yaml +Type: String +Parameter Sets: Ask +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -State +The State field for the certificate Subject DN + +```yaml +Type: String +Parameter Sets: Ask +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Country +The Country field for the certificate Subject DN + +```yaml +Type: String +Parameter Sets: Ask +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SanDns +One or more subject alternative name dns entries + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SanIP +One or more subject alternative name ip address entries + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SanUri +One or more subject alternative name uri entries + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SanEmail +One or more subject alternative name email entries + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ValidUntil +Date at which the certificate becomes invalid. +Days and hours are supported, not minutes. + +```yaml +Type: DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-Date).AddYears(1) +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Return the certificate request. +If the certificate was successfully issued, it will be returned as the property 'certificate'. + +```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. +A VaaS key can also provided directly. + +```yaml +Type: PSObject +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +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 + +### CommonName +## OUTPUTS + +### pscustomobject, if PassThru is provided +## NOTES + +## RELATED LINKS + +[http://VenafiPS.readthedocs.io/en/latest/functions/New-VaasCertificate/](http://VenafiPS.readthedocs.io/en/latest/functions/New-VaasCertificate/) + +[https://github.com/Venafi/VenafiPS/blob/main/VenafiPS/Public/New-VaasCertificate.ps1](https://github.com/Venafi/VenafiPS/blob/main/VenafiPS/Public/New-VaasCertificate.ps1) + +[https://api.venafi.cloud/webjars/swagger-ui/index.html?urls.primaryName=outagedetection-service#/Certificate%20Request/certificaterequests_create](https://api.venafi.cloud/webjars/swagger-ui/index.html?urls.primaryName=outagedetection-service#/Certificate%20Request/certificaterequests_create) + diff --git a/docs/functions/Revoke-TppGrant.md b/docs/functions/Revoke-TppGrant.md new file mode 100644 index 00000000..0a56349e --- /dev/null +++ b/docs/functions/Revoke-TppGrant.md @@ -0,0 +1,100 @@ +# Revoke-TppGrant + +## SYNOPSIS +Revoke all grants for a specific user + +## SYNTAX + +``` +Revoke-TppGrant [[-ID] ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Revoke all grants for a specific user. +You must either be an administrator or oauth administrator to perform this action. +Also, your token must have the admin:delete scope. + +## EXAMPLES + +### EXAMPLE 1 +``` +Revoke-TppGrant -ID local:{9e9db8d6-234a-409c-8299-e3b81ce2f916} +``` + +Revoke all grants for a user + +### EXAMPLE 2 +``` +Get-VenafiIdentity -ID me@x.com | Revoke-TppGrant +``` + +Revoke all grants getting universal id from other identity functions + +## PARAMETERS + +### -ID +Prefixed universal id for the user. +To search, use Find-TppIdentity. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: PrefixedUniversalID, IdentityID + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +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 + +### ID +## OUTPUTS + +### None +## NOTES + +## RELATED LINKS + +[http://VenafiPS.readthedocs.io/en/latest/functions/Revoke-TppGrant/](http://VenafiPS.readthedocs.io/en/latest/functions/Revoke-TppGrant/) + +[https://github.com/Venafi/VenafiPS/blob/main/VenafiPS/Public/Revoke-TppGrant.ps1](https://github.com/Venafi/VenafiPS/blob/main/VenafiPS/Public/Revoke-TppGrant.ps1) + +[https://doc.venafi.com/Docs/current/TopNav/Content/SDK/WebSDK/r-SDK-POST-oauth-revokegrants.htm](https://doc.venafi.com/Docs/current/TopNav/Content/SDK/WebSDK/r-SDK-POST-oauth-revokegrants.htm) + diff --git a/docs/functions/Set-TppAttribute.md b/docs/functions/Set-TppAttribute.md index a9956d75..6c1ba04f 100644 --- a/docs/functions/Set-TppAttribute.md +++ b/docs/functions/Set-TppAttribute.md @@ -13,8 +13,8 @@ Set-TppAttribute -Path -Attribute [-BypassValidation] [-Ven ### Policy ``` -Set-TppAttribute -Path -Attribute [-BypassValidation] [-Policy] -PolicyClass - [-Lock] [-VenafiSession ] [-WhatIf] [-Confirm] [] +Set-TppAttribute -Path -Attribute [-BypassValidation] -Class [-Lock] + [-VenafiSession ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -54,14 +54,14 @@ Set the value on a custom field bypassing field validation ### EXAMPLE 5 ``` -Set-TppAttribute -Path '\VED\Policy\My Folder' -PolicyClass 'X509 Certificate' -Attribute @{'Notification Disabled'='0'} +Set-TppAttribute -Path '\VED\Policy\My Folder' -Class 'X509 Certificate' -Attribute @{'Notification Disabled'='0'} ``` Set a policy attribute ### EXAMPLE 6 ``` -Set-TppAttribute -Path '\VED\Policy\My Folder' -PolicyClass 'X509 Certificate' -Attribute @{'Notification Disabled'='0'} -Lock +Set-TppAttribute -Path '\VED\Policy\My Folder' -Class 'X509 Certificate' -Attribute @{'Notification Disabled'='0'} -Lock ``` Set a policy attribute and lock the value @@ -116,28 +116,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Policy -Set policies (aka policy attributes) instead of object attributes - -```yaml -Type: SwitchParameter -Parameter Sets: Policy -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PolicyClass -{{ Fill PolicyClass Description }} +### -Class +Required when setting policy attributes. +Provide the class name to set the value for. +If unsure of the class name, add the value through the TPP UI and go to Support-\>Policy Attributes to find it. ```yaml Type: String Parameter Sets: Policy -Aliases: ClassName +Aliases: ClassName, PolicyClass Required: True Position: Named diff --git a/mkdocs.yml b/mkdocs.yml index bbc2d829..b0f52b2c 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -27,6 +27,7 @@ nav: - Home: index.md - Changelog: changelog.md - Functions: + - Add-TppAdaptableHash: functions/Add-TppAdaptableHash.md - Add-TppCertificateAssociation: functions/Add-TppCertificateAssociation.md - Add-TppEngineFolder: functions/Add-TppEngineFolder.md - Add-VenafiTeamMember: functions/Add-VenafiTeamMember.md @@ -80,6 +81,7 @@ nav: - New-TppPolicy: functions/New-TppPolicy.md - New-TppToken: functions/New-TppToken.md - New-VaasApplication: functions/New-VaasApplication.md + - New-VaasCertificate: functions/New-VaasCertificate.md - New-VaasConnector: functions/New-VaasConnector.md - New-VenafiSession: functions/New-VenafiSession.md - New-VenafiTeam: functions/New-VenafiTeam.md @@ -97,6 +99,7 @@ nav: - Remove-VenafiTeamOwner: functions/Remove-VenafiTeamOwner.md - Rename-TppObject: functions/Rename-TppObject.md - Revoke-TppCertificate: functions/Revoke-TppCertificate.md + - Revoke-TppGrant: functions/Revoke-TppGrant.md - Revoke-TppToken: functions/Revoke-TppToken.md - Search-TppHistory: functions/Search-TppHistory.md - Set-TppAttribute: functions/Set-TppAttribute.md