Update manifest and docs to 5.5.1

Venafi · May 19, 2023 · 613ce61 · 613ce61
1 parent 0c201a6
commit 613ce61
Show file tree

Hide file tree

Showing 4 changed files with 51 additions and 31 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,8 @@
+## 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`.
+
+
 ## 5.5.0
 - Add `Set-TppAttribute -NoOverwrite` to allow additions to an attribute list.  [#189](https://github.com/Venafi/VenafiPS/issues/189)
 - Add `Get-TppAttribute -NoLookup` for the remote cases where a built-in attribute and custom field have the same name.  The default will be to look for a custom field.  Use `-NoLookup` to override.  [#192](https://github.com/Venafi/VenafiPS/issues/192)
@@ -528,5 +533,6 @@
 
 
 
+
 
 
diff --git a/VenafiPS/VenafiPS.psd1 b/VenafiPS/VenafiPS.psd1
@@ -3,7 +3,7 @@
 #
 # Generated by: Venafi
 #
-# Generated on: 05/05/2023
+# Generated on: 05/19/2023
 #
 
 @{
@@ -12,7 +12,7 @@
 RootModule = 'VenafiPS.psm1'
 
 # Version number of this module.
-ModuleVersion = '5.5.0'
+ModuleVersion = '5.5.1'
 
 # Supported PSEditions
 # CompatiblePSEditions = @()

diff --git a/docs/changelog.md b/docs/changelog.md
@@ -1,3 +1,8 @@
+## 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`.
+
+
 ## 5.5.0
 - Add `Set-TppAttribute -NoOverwrite` to allow additions to an attribute list.  [#189](https://github.com/Venafi/VenafiPS/issues/189)
 - Add `Get-TppAttribute -NoLookup` for the remote cases where a built-in attribute and custom field have the same name.  The default will be to look for a custom field.  Use `-NoLookup` to override.  [#192](https://github.com/Venafi/VenafiPS/issues/192)
@@ -528,5 +533,6 @@
 
 
 
+
 
 
diff --git a/docs/functions/Get-TppPermission.md b/docs/functions/Get-TppPermission.md
@@ -7,20 +7,20 @@ Get permissions for TPP objects
 
 ### ByObject (Default)
 ```
-Get-TppPermission -InputObject <TppObject> [-IdentityId <String[]>] [-Explicit] [-Attribute <String[]>]
- [-VenafiSession <PSObject>] [<CommonParameters>]
+Get-TppPermission -InputObject <TppObject> [-IdentityId <String[]>] [-Explicit] [-VenafiSession <PSObject>]
+ [<CommonParameters>]
 ```
 
 ### ByPath
 ```
-Get-TppPermission -Path <String[]> [-IdentityId <String[]>] [-Explicit] [-Attribute <String[]>]
- [-VenafiSession <PSObject>] [<CommonParameters>]
+Get-TppPermission -Path <String[]> [-IdentityId <String[]>] [-Explicit] [-VenafiSession <PSObject>]
+ [<CommonParameters>]
 ```
 
 ### ByGuid
 ```
-Get-TppPermission -Guid <Guid[]> [-IdentityId <String[]>] [-Explicit] [-Attribute <String[]>]
- [-VenafiSession <PSObject>] [<CommonParameters>]
+Get-TppPermission -Guid <Guid[]> [-IdentityId <String[]>] [-Explicit] [-VenafiSession <PSObject>]
+ [<CommonParameters>]
 ```
 
 ## DESCRIPTION
@@ -32,20 +32,46 @@ You can retrieve all permissions for an object or for a specific user/group.
 
 ### EXAMPLE 1
 ```
-Get-TppObject -Path '\VED\Policy\My folder' | Get-TppPermission
+Get-TppPermission -Path '\VED\Policy\barron'
 ```
 
+Path                 : \ved\policy\barron
+Guid                 : 3ba630d8-acf0-4b52-9824-df549cb33b82
+Name                 : barron
+TypeName             : Policy
+IdentityId           : AD+domain:410aaf10ea816c4d823e9e05b1ad055d
+IdentityPath         : CN=Greg Brownstein,OU=Users,OU=Enterprise Administration,DC=domain,DC=net
+IdentityName         : greg
+EffectivePermissions : TppPermission
+
 Get all assigned effective permissions for users/groups on a specific policy folder
 
 ### EXAMPLE 2
 ```
-Get-TppObject -Path '\VED\Policy\My folder' | Get-TppPermission -Explicit
+Get-TppObject -Path '\VED\Policy\My folder' | Get-TppPermission
 ```
 
-Get explicit and implicit permissions for users/groups on a specific policy folder
+Get all assigned effective permissions for users/groups on a specific policy folder by piping the object
 
 ### EXAMPLE 3
 ```
+Get-TppObject -Path '\VED\Policy\barron' | Get-TppPermission -Explicit
+```
+
+Path                : \ved\policy\barron
+Guid                : 3ba630d8-acf0-4b52-9824-df549cb33b82
+Name                : barron
+TypeName            : Policy
+IdentityId          : AD+domain:410aaf10ea816c4d823e9e05b1ad055d
+IdentityPath        : CN=Greg Brownstein,OU=Users,OU=Enterprise Administration,DC=domain,DC=net
+IdentityName        : greg
+ExplicitPermissions : TppPermission
+ImplicitPermissions : TppPermission
+
+Get explicit and implicit permissions for users/groups on a specific policy folder
+
+### EXAMPLE 4
+```
 Find-TppObject -Path '\VED' -Recursive | Get-TppPermission -IdentityId 'AD+myprov:jasdf87s9dfsdfhkashfg78f7'
 ```
 
@@ -130,23 +156,6 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
-### -Attribute
-Retrieve identity attribute values for the users and groups.
-Attributes include Group Membership, Name, Internet Email Address, Given Name, Surname.
-This parameter will be deprecated in a future release.
-
-```yaml
-Type: String[]
-Parameter Sets: (All)
-Aliases:
-
-Required: False
-Position: Named
-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.
@@ -179,12 +188,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
 ###     Name
 ###     TypeName
 ###     IdentityId
-###     IdentityPath
-###     IdentityName
+###     IdentityPath, may be null if the identity has been deleted
+###     IdentityName, may be null if the identity has been deleted
 ###     EffectivePermissions (if Explicit switch is not used)
 ###     ExplicitPermissions (if Explicit switch is used)
 ###     ImplicitPermissions (if Explicit switch is used)
-###     Attribute (if Attribute parameter provided, to be deprecated)
 ## NOTES
 
 ## RELATED LINKS