From 9df035a8a78cf168117715ed942404458888a131 Mon Sep 17 00:00:00 2001 From: Shawn Melton <11204251+wsmelton@users.noreply.github.com> Date: Sun, 28 Feb 2021 02:44:01 -0600 Subject: [PATCH] 0.32.0 release --- .vscode/settings.json | 9 +- CHANGELOG.md | 22 ++- docs/_data/navigation.yml | 42 +++-- .../_abouttopics/about_tssfolderpermission.md | 43 +++++ .../about_tssfolderpermissionsummary.md | 59 ++++++ .../_commands/Get-TssFolderPermission.md | 92 ++++++++++ .../_commands/New-TssFolderPermission.md | 171 ++++++++++++++++++ .../_commands/Remove-TssFolderPermission.md | 124 +++++++++++++ .../_commands/Search-TssFolderPermission.md | 123 +++++++++++++ .../_commands/Set-TssFolderPermission.md | 169 +++++++++++++++++ docs/collections/_commands/Set-TssSecret.md | 111 ++++++++++-- docs/collections/_pages/commands.md | 16 +- src/Thycotic.SecretServer.psd1 | 2 +- 13 files changed, 946 insertions(+), 37 deletions(-) create mode 100644 docs/collections/_abouttopics/about_tssfolderpermission.md create mode 100644 docs/collections/_abouttopics/about_tssfolderpermissionsummary.md create mode 100644 docs/collections/_commands/Get-TssFolderPermission.md create mode 100644 docs/collections/_commands/New-TssFolderPermission.md create mode 100644 docs/collections/_commands/Remove-TssFolderPermission.md create mode 100644 docs/collections/_commands/Search-TssFolderPermission.md create mode 100644 docs/collections/_commands/Set-TssFolderPermission.md diff --git a/.vscode/settings.json b/.vscode/settings.json index 5965cae3..c9d91132 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -21,7 +21,6 @@ "powershell.codeFormatting.addWhitespaceAroundPipe": true, // GitHub PR extension "githubIssues.queries": [ - { "label": "Assigned Issues", "query": "default" @@ -57,10 +56,10 @@ { "label": "Feature Request", "query": "author:${user} state:open repo:${owner}/${repository} label:\"feature request\"" + }, + { + "label": "Created Issues", + "query": "state:open repo:${owner}/${repository} sort:created-desc" } - // { - // "label": "Created Issues", - // "query": "author:${user} state:open repo:${owner}/${repository} sort:created-desc" - // } ] } \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index 5779a74a..85c5301c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -13,7 +13,27 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Changed -* `Initialize-TssSdkClient` fixed issue with onboarding key being used [#84](https://github.com/thycotic-ps/thycotic.secretserver/issues/84) +* None + +## [0.32.0] -- 2021-02-28 + +### Added + +* `Set-TssSecret` additional parameters: `CheckIn', 'ForceCheckIn', 'TicketNumber', TicketSystemId' [73c96b9](https://github.com/thycotic-ps/thycotic.secretserver/commit/73c96b9e668e3a3697c4b944d90979542961779e) +* `Get-TssFolderPermission` [#88](https://github.com/thycotic-ps/thycotic.secretserver/issues/88) [db137c2](https://github.com/thycotic-ps/thycotic.secretserver/commit/db137c29c687a7bf9f8dfe31935a0481e13ba5c5) +* `Search-TssFolderPermission` [#89](https://github.com/thycotic-ps/thycotic.secretserver/issues/89) [a128a5d](https://github.com/thycotic-ps/thycotic.secretserver/commit/a128a5d9c43600707e6f7b8b5c2b3777ee43359e) +* `Remove-TssFolderPermission` [#85](https://github.com/thycotic-ps/thycotic.secretserver/issues/85) [be7b661](https://github.com/thycotic-ps/thycotic.secretserver/commit/be7b66104879d33010be56ef7788a4499968e8b3) +* `Set-TssFolderPermission` [#87](https://github.com/thycotic-ps/thycotic.secretserver/issues/87) [93ba04f](https://github.com/thycotic-ps/thycotic.secretserver/commit/93ba04f7295244cbe8070da1d197954c0c395a24) +* `New-TssFolderPermission` [#86](https://github.com/thycotic-ps/thycotic.secretserver/issues/86) [528d24d](https://github.com/thycotic-ps/thycotic.secretserver/commit/528d24d34c82eb5277329f4fffebc12219d5fc13) + +### Changed + +* `Initialize-TssSdkClient` fixed issue with onboarding key being used [#84](https://github.com/thycotic-ps/thycotic.secretserver/issues/84) [c39f797](https://github.com/thycotic-ps/thycotic.secretserver/commit/c39f7972043ca5c81d9d7902cc69afa10f60696b) +* `Set-TssSecret` adjusting logic and workflow based on test failures [ad1cbd0](https://github.com/thycotic-ps/thycotic.secretserver/commit/ad1cbd0c6450dbcd33e91f081c7872224e8b7167) +* `Set-TssSecret` fixed [#90](https://github.com/thycotic-ps/thycotic.secretserver/issues/90) [2cf1016](https://github.com/thycotic-ps/thycotic.secretserver/commit/2cf101654bbdc53d035ac673b18372739c79e40b) +* `Get-TssFolderPermission` added part script [94de6e8](https://github.com/thycotic-ps/thycotic.secretserver/commit/94de6e85b5be3b89dd1c9ca88f707a886037c572) +* `Get-TssFolderPermissionStub` moved to use part script [24b17ae](https://github.com/thycotic-ps/thycotic.secretserver/commit/24b17ae082534f6ee4818baad5e380f9fb7fecd7) +* `Get-TssSecret` fixed [#91](https://github.com/thycotic-ps/thycotic.secretserver/issues/91) [dc9a811](https://github.com/thycotic-ps/thycotic.secretserver/commit/dc9a8111b335576c0ff89f2b7d6a186d86c27533) ## [0.31.2] -- 2021-02-18 diff --git a/docs/_data/navigation.yml b/docs/_data/navigation.yml index 19de56cb..8928743d 100644 --- a/docs/_data/navigation.yml +++ b/docs/_data/navigation.yml @@ -22,18 +22,22 @@ commands: - title: "Secrets" children: + - title: "Search-TssSecret" + url: /commands/Search-TssSecret + - title: "Find-TssSecret" + url: /commands/Find-TssSecret - title: "Get-TssSecret" url: /commands/Get-TssSecret - title: "Get-TssSecretField" url: /commands/Get-TssSecretField - - title: "Search-TssSecret" - url: /commands/Search-TssSecret - title: "Set-TssSecret" url: /commands/Set-TssSecret + - title: "Get-TssSecretStub" + url: /commands/Get-TssSecretStub + - title: "New-TssSecret" + url: /commands/New-TssSecret - title: "Remove-TssSecret" url: /commands/Remove-TssSecret - - title: "Find-TssSecret" - url: /commands/Find-TssSecret - title: "Stop-TssSecretPasswordChange" url: /commands/Stop-TssSecretPasswordChange @@ -44,42 +48,52 @@ commands: - title: "Folders" children: - - title: "Get-TssFolder" - url: /commands/Get-TssFolder - title: "Search-TssFolder" url: /commands/Search-TssFolder - title: "Find-TssFolder" url: /commands/Find-TssFolder + - title: "Get-TssFolder" + url: /commands/Get-TssFolder + - title: "Get-TssFolderAudit" + url: /commands/Get-TssFolderAudit + - title: "Set-TssFolder" + url: /commands/Set-TssFolder - title: "Get-TssFolderStub" url: /commands/Get-TssFolderStub - title: "New-TssFolder" url: /commands/New-TssFolder - title: "Remove-TssFolder" url: /commands/Remove-TssFolder - - title: "Get-TssFolderAudit" - url: /commands/Get-TssFolderAudit - title: "Remove-TssFolderTemplate" url: /commands/Remove-TssFolderTemplate - - title: "Set-TssFolder" - url: /commands/Set-TssFolder - title: "Folder Permissions" children: + - title: "Search-TssFolderPermission" + url: /commands/Search-TssFolderpermission + - title: "Get-TssFolderPermission" + url: /commands/Get-TssFolderpermission + - title: "Set-TssFolderPermission" + url: /commands/Set-TssFolderpermission - title: "Get-TssFolderPermissionsStub" url: /commands/Get-TssFolderpermissionsStub + - title: "New-TssFolderPermission" + url: /commands/New-TssFolderpermission + - title: "Remove-TssFolderPermission" + url: /commands/Remove-TssFolderpermission - title: "Reports" children: - title: "Get-TssReport" url: /commands/Get-TssReport - - title: "New-TssReport" - url: /commands/New-TssReport - title: "Get-TssReportCategory" url: /commands/Get-TssReportCategory - - title: "Remove-TssReportCategory" - url: /commands/Remove-TssReportCategory - title: "Search-TssReportSchedule" url: /commands/Search-TssReportSchedule + - title: "New-TssReport" + url: /commands/New-TssReport + - title: "Remove-TssReportCategory" + url: /commands/Remove-TssReportCategory - title: "Groups" children: diff --git a/docs/collections/_abouttopics/about_tssfolderpermission.md b/docs/collections/_abouttopics/about_tssfolderpermission.md new file mode 100644 index 00000000..cbf05a4c --- /dev/null +++ b/docs/collections/_abouttopics/about_tssfolderpermission.md @@ -0,0 +1,43 @@ +--- +category: folder-permissions +title: "TssFolderPermission" +last_modified_at: 2021-02-24T00:00:00-00:00 +--- + +# TOPIC + This help topic describes the TssFolderPermission class in the Thycotic.SecretServer module + +# CLASS + TssFolderPermission + +# INHERITANCE + None + +# DESCRIPTION + The TssFolderPermission class represents the FolderPermissionModel object returned by Secret Server endpoint GET /folder-permissions/{id} + +# CONSTRUCTORS + new() + +# PROPERTIES + FolderAccessRoleId + Folder Access Role Id + + FolderAccessRoleName + Permission on the folder + + GroupId + Group Id + + SecretAccessRoleId + Secret Access Role Id + + SecretAccessRoleName + Permission on the secrets in the folder + +# METHODS + +# RELATED LINKS: + Get-TssFolderPermission + Get-TssFolderPermissionStub + New-TssFolderPermission \ No newline at end of file diff --git a/docs/collections/_abouttopics/about_tssfolderpermissionsummary.md b/docs/collections/_abouttopics/about_tssfolderpermissionsummary.md new file mode 100644 index 00000000..db06f722 --- /dev/null +++ b/docs/collections/_abouttopics/about_tssfolderpermissionsummary.md @@ -0,0 +1,59 @@ +--- +category: folder-permissions +title: "TssFolderPermissionSummary" +last_modified_at: 2021-02-24T00:00:00-00:00 +--- + +# TOPIC + This help topic describes the TssFolderPermissionSummary class in the Thycotic.SecretServer module + +# CLASS + TssFolderPermissionSummary + +# INHERITANCE + None + +# DESCRIPTION + The TssFolderPermissionSummary class represents the FolderPermissionSummary object returned by Secret Server endpoint GET /folder-permissions + +# CONSTRUCTORS + new() + +# PROPERTIES + FolderAccessRoleId + Role ID granted on the folder + + FolderAccessRoleName + Role name granted on the folder + + FolderId + Folder ID + + GroupId + Group ID having permissions on the folder + + GroupName + Group name having permissions on the folder + + Id + Folder permission ID + + KnownAs + KnownAs + + SecretAccessRoleId + Role ID granted on secrets in the folder + + SecretAccessRoleName + Role name granted on secrets in the folder + + UserId + User ID having permissions on the folder + + UserName + User name having permissions on the folder + +# METHODS + +# RELATED LINKS: + Search-TssFolderPermission \ No newline at end of file diff --git a/docs/collections/_commands/Get-TssFolderPermission.md b/docs/collections/_commands/Get-TssFolderPermission.md new file mode 100644 index 00000000..837d550b --- /dev/null +++ b/docs/collections/_commands/Get-TssFolderPermission.md @@ -0,0 +1,92 @@ +--- +category: folders +external help file: Thycotic.SecretServer-help.xml +Module Name: Thycotic.SecretServer +online version: +schema: 2.0.0 +title: Get-TssFolderPermission +--- + +# Get-TssFolderPermission + +## SYNOPSIS +Get a folder permission(s) + +## SYNTAX + +``` +Get-TssFolderPermission [-TssSession] -Id [-IncludeInactive] [] +``` + +## DESCRIPTION +Get a folder permission(s) + +## EXAMPLES + +### EXAMPLE 1 +``` +$session = New-TssSession -SecretServer https://alpha -Credential $ssCred +PS> Get-TssFolderPermission -TssSession $session -Id 36 +``` + +Returns Folder Permission(s) for Folder ID + +## PARAMETERS + +### -TssSession +TssSession object created by New-TssSession for auth + +```yaml +Type: TssSession +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Id +Folder Permission ID + +```yaml +Type: Int32[] +Parameter Sets: (All) +Aliases: FolderPermissionId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -IncludeInactive +Include inactive Folder Permissions in results + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +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 + +## OUTPUTS + +### TssFolderPermission +## NOTES +Requires TssSession object returned by New-TssSession + +## RELATED LINKS diff --git a/docs/collections/_commands/New-TssFolderPermission.md b/docs/collections/_commands/New-TssFolderPermission.md new file mode 100644 index 00000000..177d6c06 --- /dev/null +++ b/docs/collections/_commands/New-TssFolderPermission.md @@ -0,0 +1,171 @@ +--- +category: folders +external help file: Thycotic.SecretServer-help.xml +Module Name: Thycotic.SecretServer +online version: https://thycotic-ps.github.io/thycotic.secretserver/commands/New-TssFolderPermission +schema: 2.0.0 +title: New-TssFolderPermission +--- + +# New-TssFolderPermission + +## SYNOPSIS +Create a new folder permission + +## SYNTAX + +``` +New-TssFolderPermission [-TssSession] -FolderId [-GroupId ] [-UserId ] + -FolderAccessRoleName -SecretAccessRoleName [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Create a new folder permission + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -TssSession +TssSession object created by New-TssSession for auth + +```yaml +Type: TssSession +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -FolderId +Folder ID + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: 0 +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -GroupId +Group Id + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: 0 +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -UserId +User ID + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: 0 +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -FolderAccessRoleName +Folder Access Role Name + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -SecretAccessRoleName +Secret Access Role Name + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +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 + +## OUTPUTS + +### TssFolderPermission +## NOTES +Requires TssSession object returned by New-TssSession + +## RELATED LINKS + +[https://thycotic-ps.github.io/thycotic.secretserver/commands/New-TssFolderPermission](https://thycotic-ps.github.io/thycotic.secretserver/commands/New-TssFolderPermission) + diff --git a/docs/collections/_commands/Remove-TssFolderPermission.md b/docs/collections/_commands/Remove-TssFolderPermission.md new file mode 100644 index 00000000..ebc39e22 --- /dev/null +++ b/docs/collections/_commands/Remove-TssFolderPermission.md @@ -0,0 +1,124 @@ +--- +category: folders +external help file: Thycotic.SecretServer-help.xml +Module Name: Thycotic.SecretServer +online version: +schema: 2.0.0 +title: Remove-TssFolderPermission +--- + +# Remove-TssFolderPermission + +## SYNOPSIS +Delete a folder permissions + +## SYNTAX + +``` +Remove-TssFolderPermission [-TssSession] -Id [-BreakInheritance] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +Delete a folder permissions + +## EXAMPLES + +### EXAMPLE 1 +``` +$session = New-TssSession -SecretServer https://alpha -Credential $ssCred +PS> Remove-TssFolderPermission -TssSession $session -Id 9 +``` + +Delete Folder Permission ID 9 + +## PARAMETERS + +### -TssSession +TssSession object created by New-TssSession for auth + +```yaml +Type: TssSession +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Id +Folder Permission ID + +```yaml +Type: Int32[] +Parameter Sets: (All) +Aliases: FolderPermissionId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -BreakInheritance +Include to remove permission inheritance + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +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 + +## OUTPUTS + +### TssDelete +## NOTES +Requires TssSession object returned by New-TssSession + +## RELATED LINKS diff --git a/docs/collections/_commands/Search-TssFolderPermission.md b/docs/collections/_commands/Search-TssFolderPermission.md new file mode 100644 index 00000000..c195ba98 --- /dev/null +++ b/docs/collections/_commands/Search-TssFolderPermission.md @@ -0,0 +1,123 @@ +--- +category: folders +external help file: Thycotic.SecretServer-help.xml +Module Name: Thycotic.SecretServer +online version: +schema: 2.0.0 +title: Search-TssFolderPermission +--- + +# Search-TssFolderPermission + +## SYNOPSIS +Search folder permissions + +## SYNTAX + +``` +Search-TssFolderPermission [-TssSession] [-FolderId ] [-GroupId ] [-UserId ] + [-SortBy ] [] +``` + +## DESCRIPTION +Search folder permissions + +## EXAMPLES + +### EXAMPLE 1 +``` +$session = New-TssSession -SecretServer https://alpha -Credential $ssCred +PS> Search-TssFolderPermission -TssSession $session -FolderId 32 +``` + +Return Folder Permissions for Folder ID 32 + +## PARAMETERS + +### -TssSession +TssSession object created by New-TssSession for auth + +```yaml +Type: TssSession +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -FolderId +Folder ID + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupId +Group ID + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserId +User ID + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SortBy +Sort by specific property, default Folder Permission ID + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Id +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 + +## OUTPUTS + +### TssFolderPermissionSummary +## NOTES +Requires TssSession object returned by New-TssSession + +## RELATED LINKS diff --git a/docs/collections/_commands/Set-TssFolderPermission.md b/docs/collections/_commands/Set-TssFolderPermission.md new file mode 100644 index 00000000..05a7c941 --- /dev/null +++ b/docs/collections/_commands/Set-TssFolderPermission.md @@ -0,0 +1,169 @@ +--- +category: folders +external help file: Thycotic.SecretServer-help.xml +Module Name: Thycotic.SecretServer +online version: +schema: 2.0.0 +title: Set-TssFolderPermission +--- + +# Set-TssFolderPermission + +## SYNOPSIS +Set various properties for a given FolderPermission + +## SYNTAX + +``` +Set-TssFolderPermission [-TssSession] -Id -FolderId + -FolderAccessRolename [-SecretAccessRoleName ] [-BreakInheritance] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +Set various properties for a given FolderPermission + +## EXAMPLES + +### EXAMPLE 1 +``` +$session = New-TssSession -SecretServer https://alpha -Credential $ssCred +PS> Set-TssFolderPermission -TssSession $session -Id 34 -FolderId 5 -FolderAccessRoleName Edit -SecretAccessRoleName View +``` + +Set Folder Permission ID 34 on Folder ID 5 to Edit folder permission and View secret permission + +## PARAMETERS + +### -TssSession +TssSession object created by New-TssSession for auth + +```yaml +Type: TssSession +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Id +Folder Permission Id to modify + +```yaml +Type: Int32[] +Parameter Sets: (All) +Aliases: FolderPermissionId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -FolderId +Folder ID + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: 0 +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -FolderAccessRolename +Role to grant on the folder: View, Edit, Add Secret, Owner + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SecretAccessRoleName +Role to grant on the secret: View, Edit, List, Owner + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BreakInheritance +Allow updating of inherited permissions + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +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 + +## OUTPUTS + +## NOTES +Requires TssSession object returned by New-TssSession + +## RELATED LINKS diff --git a/docs/collections/_commands/Set-TssSecret.md b/docs/collections/_commands/Set-TssSecret.md index 1474b67f..54b1e4ca 100644 --- a/docs/collections/_commands/Set-TssSecret.md +++ b/docs/collections/_commands/Set-TssSecret.md @@ -16,43 +16,56 @@ Set various settings or fields for a given secret ### all (Default) ``` -Set-TssSecret [-TssSession] -Id [-Comment ] [-Field ] [-Value ] - [-Clear] [-EmailWhenChanged] [-EmailWhenViewed] [-EmailWhenHeartbeatFails] [-Active] [-AutoChangeEnabled] +Set-TssSecret [-TssSession] -Id [-Comment ] [-ForceCheckIn] + [-TicketNumber ] [-TicketSystemId ] [-Field ] [-Value ] [-Clear] + [-EmailWhenChanged] [-EmailWhenViewed] [-EmailWhenHeartbeatFails] [-Active] [-AutoChangeEnabled] [-AutoChangeNextPassword ] [-EnableInheritPermission] [-EnableInheritSecretPolicy] [-Folder ] [-GenerateSshKeys] [-HeartbeatEnabled] [-IsOutOfSync] [-SecretName ] - [-SecretPolicy ] [-Site ] [-Template ] [-WhatIf] [-Confirm] [] + [-SecretPolicy ] [-Site ] [-Template ] [-CheckIn] [-WhatIf] [-Confirm] + [] +``` + +### restricted +``` +Set-TssSecret [-TssSession] -Id [-Comment ] [-ForceCheckIn] + [-TicketNumber ] [-TicketSystemId ] [-WhatIf] [-Confirm] [] +``` + +### checkIn +``` +Set-TssSecret [-TssSession] -Id [-ForceCheckIn] [-CheckIn] [-WhatIf] [-Confirm] + [] ``` ### field ``` -Set-TssSecret [-TssSession] -Id [-Comment ] -Field [-Value ] - [-Clear] [-WhatIf] [-Confirm] [] +Set-TssSecret [-TssSession] -Id -Field [-Value ] [-Clear] [-WhatIf] + [-Confirm] [] ``` ### email ``` -Set-TssSecret [-TssSession] -Id [-Comment ] [-EmailWhenChanged] - [-EmailWhenViewed] [-EmailWhenHeartbeatFails] [-WhatIf] [-Confirm] [] +Set-TssSecret [-TssSession] -Id [-EmailWhenChanged] [-EmailWhenViewed] + [-EmailWhenHeartbeatFails] [-WhatIf] [-Confirm] [] ``` ### general ``` -Set-TssSecret [-TssSession] -Id [-Comment ] [-Active] - [-EnableInheritSecretPolicy] [-Folder ] [-GenerateSshKeys] [-HeartbeatEnabled] [-IsOutOfSync] - [-SecretName ] [-SecretPolicy ] [-Site ] [-Template ] [-WhatIf] [-Confirm] - [] +Set-TssSecret [-TssSession] -Id [-Active] [-EnableInheritSecretPolicy] [-Folder ] + [-GenerateSshKeys] [-HeartbeatEnabled] [-IsOutOfSync] [-SecretName ] [-SecretPolicy ] + [-Site ] [-Template ] [-WhatIf] [-Confirm] [] ``` ### password ``` -Set-TssSecret [-TssSession] -Id [-Comment ] [-AutoChangeEnabled] +Set-TssSecret [-TssSession] -Id [-AutoChangeEnabled] [-AutoChangeNextPassword ] [-WhatIf] [-Confirm] [] ``` ### folder ``` -Set-TssSecret [-TssSession] -Id [-Comment ] [-EnableInheritPermission] [-WhatIf] - [-Confirm] [] +Set-TssSecret [-TssSession] -Id [-EnableInheritPermission] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -100,6 +113,14 @@ Set-TssSecret -TssSession $session -Id 113 -EmailWhenChanged:$false Sets secret 1455 disables emailing when changed +### EXAMPLE 6 +``` +$session = New-TssSession -SecretServer https://alpha -Credential $ssCred +Set-TssSecret -TssSession $session -Id 113 -ForceCheckIn +``` + +Sets secret 1455 disables emailing when changed + ## PARAMETERS ### -TssSession @@ -137,7 +158,7 @@ Comment to provide for restricted secret (Require Comment is enabled) ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: all, restricted Aliases: Required: False @@ -147,6 +168,51 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ForceCheckIn +Force check-in of the Secret + +```yaml +Type: SwitchParameter +Parameter Sets: all, restricted, checkIn +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TicketNumber +Associated Ticket Number + +```yaml +Type: Int32 +Parameter Sets: all, restricted +Aliases: + +Required: False +Position: Named +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TicketSystemId +Associated Ticket System ID + +```yaml +Type: Int32 +Parameter Sets: all, restricted +Aliases: + +Required: False +Position: Named +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Field Field name (slug) of the secret @@ -444,6 +510,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -CheckIn +Check-In a Secret, can be combined with ForceCheckIn to forcibly check the Secret in + +```yaml +Type: SwitchParameter +Parameter Sets: all, checkIn +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -WhatIf Shows what would happen if the cmdlet runs. The cmdlet is not run. diff --git a/docs/collections/_pages/commands.md b/docs/collections/_pages/commands.md index 13ff708f..28df40ba 100644 --- a/docs/collections/_pages/commands.md +++ b/docs/collections/_pages/commands.md @@ -69,6 +69,11 @@ A Thycotic.SecretServer command may not appear in the below list due to it not b **API Endpoint** | **Thycotic.SecretServer Command** | ---------------- | --------------------------------- | [GET /folder-permissions/stub][GET /folder-permissions/stub] | [Get-TssFolderPermissionsStub][Get-TssFolderPermissionsStub] +[GET /folder-permissions][GET /folder-permissions] | [Search-TssFolderPermission][Search-TssFolderPermission] +[GET /folder-permissions/{id}][GET /folder-permissions{id}] | [Get-TssFolderPermission][Get-TssFolderPermission] +[PUT /folder-permissions/{id}][PUT /folder-permissions{id}] | [Set-TssFolderPermission][Set-TssFolderPermission] +[POST /folder-permissions/{id}][POST /folder-permissions{id}] | [New-TssFolderPermission][New-TssFolderPermission] +[DELETE /folder-permissions/{id}][DELETE /folder-permissions{id}] | [Remove-TssFolderPermission][Remove-TssFolderPermission] ## Reports @@ -123,7 +128,16 @@ A Thycotic.SecretServer command may not appear in the below list due to it not b [Remove-TssFolderTemplate]:/thycotic.secretserver/commands/Remove-TssFolderTemplate [Get-TssFolderPermissionsStub]:/thycotic.secretserver/commands/Get-TssFolderPermissionsStub [Get-TssFolderAuditSummary]:/thycotic.secretserver/commands/Get-TssFolderAuditSummary - +[Get-TssFolderPermission]:/thycotic.secretserver/commands/Get-TssFolderPermission +[Search-TssFolderPermission]:/thycotic.secretserver/commands/Search-TssFolderPermission +[Set-TssFolderPermission]:/thycotic.secretserver/commands/Set-TssFolderPermission +[Remove-TssFolderPermission]:/thycotic.secretserver/commands/Remove-TssFolderPermission +[New-TssFolderPermission]:/thycotic.secretserver/commands/New-TssFolderPermission + +[POST /folder-permissions/{id}]:https://updates.thycotic.net/secretserver/restapiguide/10.9.33/TokenAuth/#operation--folder-permissions-post +[DELETE /folder-permissions/{id}]:https://updates.thycotic.net/secretserver/restapiguide/10.9.33/TokenAuth/#operation--folder-permissions--id--delete +[GET /folder-permissions/{id}]:https://updates.thycotic.net/secretserver/restapiguide/10.9.33/TokenAuth/#operation--folder-permissions--id--get +[GET /folder-permissions/]:https://updates.thycotic.net/secretserver/restapiguide/10.9.33/TokenAuth/#operation--folder-permissions-get [GET /folder-permissions/stub]:https://updates.thycotic.net/secretserver/restapiguide/10.9.33/TokenAuth/#operation--folder-permissions-stub-get [DELETE /folders/{id}/templates/{templateId}]:https://updates.thycotic.net/secretserver/restapiguide/10.9.33/TokenAuth/#operation--folders--id--templates--templateId--delete [GET /folders/{id}/audit]:https://updates.thycotic.net/secretserver/restapiguide/10.9.33/TokenAuth/#operation--folders--id--audit-get diff --git a/src/Thycotic.SecretServer.psd1 b/src/Thycotic.SecretServer.psd1 index 7006ee08..a674e43d 100644 --- a/src/Thycotic.SecretServer.psd1 +++ b/src/Thycotic.SecretServer.psd1 @@ -1,5 +1,5 @@ @{ - ModuleVersion = '0.31.2' + ModuleVersion = '0.32.0' CompatiblePSEditions = 'Desktop', 'Core' FormatsToProcess = 'Thycotic.SecretServer.Format.ps1xml' TypesToProcess = 'Thycotic.SecretServer.Types.ps1xml'