-
Notifications
You must be signed in to change notification settings - Fork 23
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
13 changed files
with
946 additions
and
37 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
43 changes: 43 additions & 0 deletions
43
docs/collections/_abouttopics/about_tssfolderpermission.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |
59 changes: 59 additions & 0 deletions
59
docs/collections/_abouttopics/about_tssfolderpermissionsummary.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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] <TssSession> -Id <Int32[]> [-IncludeInactive] [<CommonParameters>] | ||
``` | ||
|
||
## 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 |
Oops, something went wrong.