module - update TssSession --> Thycotic.PowerShell.Authentication.Ses…

…sion
thycotic-ps · Jul 14, 2021 · f2f869c · f2f869c
1 parent 38535bf
commit f2f869c
Show file tree

Hide file tree

Showing 291 changed files with 498 additions and 502 deletions.
diff --git a/docs/about_topics/authentication/about_tsssession.md b/docs/about_topics/authentication/about_tsssession.md
@@ -1,12 +1,12 @@
 ---
-title: "TssSession"
+title: "Thycotic.PowerShell.Authentication.Session"
 ---
 
 # TOPIC
-    This help topic describes the TssSession class in the Thycotic.SecretServer module.
+    This help topic describes the Session class in the Thycotic.SecretServer module.
 
 # CLASS
-    TssSession
+    Thycotic.PowerShell.Authentication.Session
 
 # INHERITANCE
     None
@@ -25,7 +25,7 @@ title: "TssSession"
     ApiVersion:
         Default value of `api/v1`
 
-    WindowsAuth:
+    WindowsAuth: readonly
         Default to `winauthwebservices`, utilized with IWA
 
     AccessToken:
@@ -63,8 +63,8 @@ title: "TssSession"
         Validates that TimeOfDeath is not greater than current time
         If ExternalToken or WindowsAuth is the TokenType will return true
 
-    [boolean] CheckTokenTtl( [string]Unit, [int]Value )
-        Checks the timespan for the TimeOfDeath and current datetime is within the unit and value. (TimeOfDeath - Now)
+    [boolean] CheckTokenTtl( [int]Value )
+        Checks the timespan for the TimeOfDeath and current datetime TotalMinutes is within the value. (TimeOfDeath - Now)
         If it is the method returns true, if not returns false.
 
     [boolean] SessionExpire()

diff --git a/docs/commands/configurations/Disable-TssUnlimitedAdmin.md b/docs/commands/configurations/Disable-TssUnlimitedAdmin.md
@@ -6,7 +6,7 @@ Disable Unlimited Admin Mode
 ## SYNTAX
 
 ```
-Disable-TssUnlimitedAdmin [-TssSession] <TssSession> [-Note] <String> [-WhatIf] [-Confirm] [<CommonParameters>]
+Disable-TssUnlimitedAdmin [-TssSession] <Session> [-Note] <String> [-WhatIf] [-Confirm] [<CommonParameters>]
 ```
 
 ## DESCRIPTION
@@ -28,7 +28,7 @@ Disables Unlimited Admin Mode providing the required note
 TssSession object created by New-TssSession for auth
 
 ```yaml
-Type: TssSession
+Type: Session
 Parameter Sets: (All)
 Aliases:
 

diff --git a/docs/commands/configurations/Enable-TssUnlimitedAdmin.md b/docs/commands/configurations/Enable-TssUnlimitedAdmin.md
@@ -6,7 +6,7 @@ Enable Unlimited Admin Mode
 ## SYNTAX
 
 ```
-Enable-TssUnlimitedAdmin [-TssSession] <TssSession> [-Note] <String> [-WhatIf] [-Confirm] [<CommonParameters>]
+Enable-TssUnlimitedAdmin [-TssSession] <Session> [-Note] <String> [-WhatIf] [-Confirm] [<CommonParameters>]
 ```
 
 ## DESCRIPTION
@@ -28,7 +28,7 @@ Enables Unlimited Admin Mode providing the required note
 TssSession object created by New-TssSession for auth
 
 ```yaml
-Type: TssSession
+Type: Session
 Parameter Sets: (All)
 Aliases:
 

diff --git a/docs/commands/configurations/Get-TssConfiguration.md b/docs/commands/configurations/Get-TssConfiguration.md
@@ -6,7 +6,7 @@ Get Secret Server configuration section(s)
 ## SYNTAX
 
 ```
-Get-TssConfiguration [-TssSession] <TssSession> [-Type <String>] [<CommonParameters>]
+Get-TssConfiguration [-TssSession] <Session> [-Type <String>] [<CommonParameters>]
 ```
 
 ## DESCRIPTION
@@ -28,7 +28,7 @@ Return all configuration objects
 TssSession object created by New-TssSession for auth
 
 ```yaml
-Type: TssSession
+Type: Session
 Parameter Sets: (All)
 Aliases:
 

diff --git a/docs/commands/directory-services/Search-TssDirectoryServiceDomain.md b/docs/commands/directory-services/Search-TssDirectoryServiceDomain.md
@@ -6,7 +6,7 @@ Search Directory Services domains
 ## SYNTAX
 
 ```
-Search-TssDirectoryServiceDomain [-TssSession] <TssSession> [-DomainName <Int32>] [-IncludeInactive]
+Search-TssDirectoryServiceDomain [-TssSession] <Session> [-DomainName <Int32>] [-IncludeInactive]
  [-SortBy <String>] [<CommonParameters>]
 ```
 
@@ -29,7 +29,7 @@ Return the domain lab.local information
 TssSession object created by New-TssSession for auth
 
 ```yaml
-Type: TssSession
+Type: Session
 Parameter Sets: (All)
 Aliases:
 

diff --git a/docs/commands/discovery/Start-TssDiscovery.md b/docs/commands/discovery/Start-TssDiscovery.md
@@ -6,7 +6,7 @@ Start Discovery processing
 ## SYNTAX
 
 ```
-Start-TssDiscovery [-TssSession] <TssSession> [-Type] <String> [-WhatIf] [-Confirm] [<CommonParameters>]
+Start-TssDiscovery [-TssSession] <Session> [-Type] <String> [-WhatIf] [-Confirm] [<CommonParameters>]
 ```
 
 ## DESCRIPTION
@@ -36,7 +36,7 @@ Run Discovery Scan
 TssSession object created by New-TssSession for auth
 
 ```yaml
-Type: TssSession
+Type: Session
 Parameter Sets: (All)
 Aliases:
 

diff --git a/docs/commands/distributed-engines/Search-TssDistributedEngineSite.md b/docs/commands/distributed-engines/Search-TssDistributedEngineSite.md
@@ -6,7 +6,7 @@ Search Distributed Engine Sites in Secret Server
 ## SYNTAX
 
 ```
-Search-TssDistributedEngineSite [-TssSession] <TssSession> [-SiteId <Int32>] [-SiteName <String>]
+Search-TssDistributedEngineSite [-TssSession] <Session> [-SiteId <Int32>] [-SiteName <String>]
  [-IncludeSiteMetrics] [-IncludeSitesAddNewEngines] [-IncludeInactive] [-SortBy <String>] [<CommonParameters>]
 ```
 
@@ -29,7 +29,7 @@ Add minimum example for each parameter
 TssSession object created by New-TssSession for auth
 
 ```yaml
-Type: TssSession
+Type: Session
 Parameter Sets: (All)
 Aliases:
 

diff --git a/docs/commands/folder-permissions/Get-TssFolderPermission.md b/docs/commands/folder-permissions/Get-TssFolderPermission.md
@@ -6,7 +6,7 @@ Get a folder permission(s)
 ## SYNTAX
 
 ```
-Get-TssFolderPermission [-TssSession] <TssSession> -Id <Int32[]> [-IncludeInactive] [<CommonParameters>]
+Get-TssFolderPermission [-TssSession] <Session> -Id <Int32[]> [-IncludeInactive] [<CommonParameters>]
 ```
 
 ## DESCRIPTION
@@ -28,7 +28,7 @@ Returns Folder Permission(s) for Folder ID
 TssSession object created by New-TssSession for auth
 
 ```yaml
-Type: TssSession
+Type: Session
 Parameter Sets: (All)
 Aliases:
 

diff --git a/docs/commands/folder-permissions/New-TssFolderPermission.md b/docs/commands/folder-permissions/New-TssFolderPermission.md
@@ -6,7 +6,7 @@ Create a new folder permission
 ## SYNTAX
 
 ```
-New-TssFolderPermission [-TssSession] <TssSession> -FolderId <Int32[]> [-GroupId <Int32>] [-UserId <Int32>]
+New-TssFolderPermission [-TssSession] <Session> -FolderId <Int32[]> [-GroupId <Int32>] [-UserId <Int32>]
  -FolderAccessRoleName <String> -SecretAccessRoleName <String> [-Force] [-WhatIf] [-Confirm]
  [<CommonParameters>]
 ```
@@ -38,7 +38,7 @@ Creates a folder permission on Folder ID 46 for Group ID 21, giving Owner for Fo
 TssSession object created by New-TssSession for auth
 
 ```yaml
-Type: TssSession
+Type: Session
 Parameter Sets: (All)
 Aliases:
 

diff --git a/docs/commands/folder-permissions/Remove-TssFolderPermission.md b/docs/commands/folder-permissions/Remove-TssFolderPermission.md
@@ -6,7 +6,7 @@ Delete a folder permissions
 ## SYNTAX
 
 ```
-Remove-TssFolderPermission [-TssSession] <TssSession> -Id <Int32[]> [-BreakInheritance] [-WhatIf] [-Confirm]
+Remove-TssFolderPermission [-TssSession] <Session> -Id <Int32[]> [-BreakInheritance] [-WhatIf] [-Confirm]
  [<CommonParameters>]
 ```
 
@@ -29,7 +29,7 @@ Delete Folder Permission ID 9
 TssSession object created by New-TssSession for auth
 
 ```yaml
-Type: TssSession
+Type: Session
 Parameter Sets: (All)
 Aliases:
 

diff --git a/docs/commands/folder-permissions/Search-TssFolderPermission.md b/docs/commands/folder-permissions/Search-TssFolderPermission.md
@@ -6,7 +6,7 @@ Search folder permissions
 ## SYNTAX
 
 ```
-Search-TssFolderPermission [-TssSession] <TssSession> [-FolderId <Int32>] [-GroupId <Int32>] [-UserId <Int32>]
+Search-TssFolderPermission [-TssSession] <Session> [-FolderId <Int32>] [-GroupId <Int32>] [-UserId <Int32>]
  [-SortBy <String>] [<CommonParameters>]
 ```
 
@@ -29,7 +29,7 @@ Return Folder Permissions for Folder ID 32
 TssSession object created by New-TssSession for auth
 
 ```yaml
-Type: TssSession
+Type: Session
 Parameter Sets: (All)
 Aliases:
 

diff --git a/docs/commands/folder-permissions/Update-TssFolderPermission.md b/docs/commands/folder-permissions/Update-TssFolderPermission.md
@@ -6,7 +6,7 @@ Update properties for a given FolderPermission
 ## SYNTAX
 
 ```
-Update-TssFolderPermission [-TssSession] <TssSession> -Id <Int32[]> -FolderId <Int32>
+Update-TssFolderPermission [-TssSession] <Session> -Id <Int32[]> -FolderId <Int32>
  -FolderAccessRolename <String> [-SecretAccessRoleName <String>] [-BreakInheritance] [-WhatIf] [-Confirm]
  [<CommonParameters>]
 ```
@@ -38,7 +38,7 @@ Update Folder Permission ID 45 on Folder ID 72 to Owner folder permission
 TssSession object created by New-TssSession for auth
 
 ```yaml
-Type: TssSession
+Type: Session
 Parameter Sets: (All)
 Aliases:
 

diff --git a/docs/commands/folders/Add-TssFolderPermission.md b/docs/commands/folders/Add-TssFolderPermission.md
@@ -7,13 +7,13 @@ Add a User or Group permission to a Folder
 
 ### user
 ```
-Add-TssFolderPermission [-TssSession] <TssSession> -FolderId <Int32[]> -Username <String> -FolderRole <String>
+Add-TssFolderPermission [-TssSession] <Session> -FolderId <Int32[]> -Username <String> -FolderRole <String>
  -SecretRole <String> [-Force] [<CommonParameters>]
 ```
 
 ### group
 ```
-Add-TssFolderPermission [-TssSession] <TssSession> -FolderId <Int32[]> -Group <String> -FolderRole <String>
+Add-TssFolderPermission [-TssSession] <Session> -FolderId <Int32[]> -Group <String> -FolderRole <String>
  -SecretRole <String> [-Force] [<CommonParameters>]
 ```
 
@@ -56,7 +56,7 @@ Add "chad" as owner for Folder and Secret on Folders that have "App" in their na
 TssSession object created by New-TssSession for auth
 
 ```yaml
-Type: TssSession
+Type: Session
 Parameter Sets: (All)
 Aliases:
 

diff --git a/docs/commands/folders/Find-TssFolder.md b/docs/commands/folders/Find-TssFolder.md
@@ -6,7 +6,7 @@ Find secret folders
 ## SYNTAX
 
 ```
-Find-TssFolder [-TssSession] <TssSession> [-ParentFolderId <Int32>] [-SearchText <String>]
+Find-TssFolder [-TssSession] <Session> [-ParentFolderId <Int32>] [-SearchText <String>]
  [-PermissionRequired <String>] [-SortBy <String>] [<CommonParameters>]
 ```
 
@@ -29,7 +29,7 @@ Return folders with Parent Folder ID of 56
 TssSession object created by New-TssSession for auth
 
 ```yaml
-Type: TssSession
+Type: Session
 Parameter Sets: (All)
 Aliases:
 

diff --git a/docs/commands/folders/Get-TssFolder.md b/docs/commands/folders/Get-TssFolder.md
@@ -7,17 +7,17 @@ Get a folder from Secret Server
 
 ### id
 ```
-Get-TssFolder [-TssSession] <TssSession> [-Id <Int32[]>] [-GetChildren] [-IncludeTemplate] [<CommonParameters>]
+Get-TssFolder [-TssSession] <Session> [-Id <Int32[]>] [-GetChildren] [-IncludeTemplate] [<CommonParameters>]
 ```
 
 ### filter
 ```
-Get-TssFolder [-TssSession] <TssSession> [-GetChildren] [-IncludeTemplate] [<CommonParameters>]
+Get-TssFolder [-TssSession] <Session> [-GetChildren] [-IncludeTemplate] [<CommonParameters>]
 ```
 
 ### path
 ```
-Get-TssFolder [-TssSession] <TssSession> [-FolderPath <String>] [<CommonParameters>]
+Get-TssFolder [-TssSession] <Session> [-FolderPath <String>] [<CommonParameters>]
 ```
 
 ## DESCRIPTION
@@ -63,7 +63,7 @@ Returns folder that has a path of ABC Company\Security
 TssSession object created by New-TssSession for auth
 
 ```yaml
-Type: TssSession
+Type: Session
 Parameter Sets: (All)
 Aliases:
 

diff --git a/docs/commands/folders/Get-TssFolderAudit.md b/docs/commands/folders/Get-TssFolderAudit.md
@@ -6,7 +6,7 @@ Get a list of audits
 ## SYNTAX
 
 ```
-Get-TssFolderAudit [-TssSession] <TssSession> -Id <Int32[]> [<CommonParameters>]
+Get-TssFolderAudit [-TssSession] <Session> -Id <Int32[]> [<CommonParameters>]
 ```
 
 ## DESCRIPTION
@@ -28,7 +28,7 @@ Gets the audit entries for Folder ID
 TssSession object created by New-TssSession for auth
 
 ```yaml
-Type: TssSession
+Type: Session
 Parameter Sets: (All)
 Aliases:
 

diff --git a/docs/commands/folders/Get-TssFolderState.md b/docs/commands/folders/Get-TssFolderState.md
@@ -6,7 +6,7 @@ Get details on a Folder
 ## SYNTAX
 
 ```
-Get-TssFolderState [-TssSession] <TssSession> -Id <Int32[]> [-NoException] [<CommonParameters>]
+Get-TssFolderState [-TssSession] <Session> -Id <Int32[]> [-NoException] [<CommonParameters>]
 ```
 
 ## DESCRIPTION
@@ -36,7 +36,7 @@ Returns details on Folder ID 482, if no access to folder will return no results
 TssSession object created by New-TssSession for auth
 
 ```yaml
-Type: TssSession
+Type: Session
 Parameter Sets: (All)
 Aliases:
 

diff --git a/docs/commands/folders/New-TssFolder.md b/docs/commands/folders/New-TssFolder.md
@@ -6,9 +6,8 @@ Create a new folder
 ## SYNTAX
 
 ```
-New-TssFolder [-TssSession] <TssSession> -FolderName <String> [-ParentFolderId <Int32>]
- [-SecretPolicyId <Int32>] [-InheritPermissions] [-InheritSecretPolicy] [-WhatIf] [-Confirm]
- [<CommonParameters>]
+New-TssFolder [-TssSession] <Session> -FolderName <String> [-ParentFolderId <Int32>] [-SecretPolicyId <Int32>]
+ [-InheritPermissions] [-InheritSecretPolicy] [-WhatIf] [-Confirm] [<CommonParameters>]
 ```
 
 ## DESCRIPTION
@@ -48,7 +47,7 @@ Creates a folder named "Marketing Dept" under parent folder 27 with inheritance
 TssSession object created by New-TssSession for auth
 
 ```yaml
-Type: TssSession
+Type: Session
 Parameter Sets: (All)
 Aliases:
 

diff --git a/docs/commands/folders/Remove-TssFolder.md b/docs/commands/folders/Remove-TssFolder.md
@@ -6,7 +6,7 @@ Delete secret folder
 ## SYNTAX
 
 ```
-Remove-TssFolder [-TssSession] <TssSession> -Id <Int32[]> [-WhatIf] [-Confirm] [<CommonParameters>]
+Remove-TssFolder [-TssSession] <Session> -Id <Int32[]> [-WhatIf] [-Confirm] [<CommonParameters>]
 ```
 
 ## DESCRIPTION
@@ -28,7 +28,7 @@ Delete Folder ID 28
 TssSession object created by New-TssSession for auth
 
 ```yaml
-Type: TssSession
+Type: Session
 Parameter Sets: (All)
 Aliases:
 

diff --git a/docs/commands/folders/Remove-TssFolderTemplate.md b/docs/commands/folders/Remove-TssFolderTemplate.md
@@ -6,7 +6,7 @@ Remove the associated template on the folder
 ## SYNTAX
 
 ```
-Remove-TssFolderTemplate [-TssSession] <TssSession> -Id <Int32> [-TemplateId <Int32[]>] [-WhatIf] [-Confirm]
+Remove-TssFolderTemplate [-TssSession] <Session> -Id <Int32> [-TemplateId <Int32[]>] [-WhatIf] [-Confirm]
  [<CommonParameters>]
 ```
 
@@ -30,7 +30,7 @@ Removes Template 6001 from Folder ID 23
 TssSession object created by New-TssSession for auth
 
 ```yaml
-Type: TssSession
+Type: Session
 Parameter Sets: (All)
 Aliases: