Skip to content

Commit

Permalink
module - about files added
Browse files Browse the repository at this point in the history
  • Loading branch information
wsmelton committed Mar 20, 2021
1 parent 67e06e3 commit 1b07f60
Show file tree
Hide file tree
Showing 8 changed files with 233 additions and 8 deletions.
36 changes: 36 additions & 0 deletions src/en-us/about_tssonetimepasswordsettings.help.txt
@@ -0,0 +1,36 @@
TOPIC
This help topic describes the TssOneTimePasswordSettings class in the Thycotic.SecretServer module

CLASS
TssOneTimePasswordSettings

INHERITANCE
None

DESCRIPTION
The TssOneTimePasswordSettings class represents the OneTimePasswordSettingsModel object returned by Secret Server endpoint GET /secret/{id}/settings

CONSTRUCTORS
new()

PROPERTIES
BackupCodes
Backup Codes

DateChanged
Date Changed

Enabled
Enabled

EnabledOnTemplate
Enabled On Template

Key
Key

METHODS

RELATED LINKS:
TssSEcretDetilSettings
Get-TssSecretSetting
45 changes: 45 additions & 0 deletions src/en-us/about_tssrdplaunchersettings.help.txt
@@ -0,0 +1,45 @@
TOPIC
This help topic describes the TssRdpLauncherSettings class in the Thycotic.SecretServer module

CLASS
TssRdpLauncherSettings

INHERITANCE
None

DESCRIPTION
The TssRdpLauncherSettings class represents the RdpLauncherSettingsModel object returned by Secret Server endpoint GET /secrets/{id}/settings

CONSTRUCTORS
new()

PROPERTIES
AllowClipboard
Allow Clipboard (No, Yes, UsePreferenceNo, UsePreferenceYes)

AllowDrives
Allow Drives (No, Yes, UsePreferenceNo, UsePreferenceYes)

AllowPrinters
Allow Printers (No, Yes, UsePreferenceNo, UsePreferenceYes)

AllowSmartCards
Allow SmartCards (No, Yes, UsePreferenceNo, UsePreferenceYes)

ConnectToConsole
Connect To Console (No, Yes, UsePreferenceNo, UsePreferenceYes)

LauncherHeight
Launcher Height

LauncherWidth
Launcher Height

UseCustomLauncherResolution
Use Custom Launcher Resolution (No, Yes, UsePreferenceNo, UsePreferenceYes)

METHODS

RELATED LINKS:
TssSecretDetailSettings
Get-TssSecretSetting
9 changes: 3 additions & 6 deletions src/en-us/about_tssreportcategory.help.txt
Expand Up @@ -14,18 +14,15 @@ CONSTRUCTORS
new()

PROPERTIES
ReportCategoryDescription
Description
Report Category description

ReportCategoryId
Id
Report Category ID

ReportCategoryName
Name
Report Category name

SortOrder
Sort Order in which the category should appear

METHODS

RELATED LINKS:
Expand Down
32 changes: 32 additions & 0 deletions src/en-us/about_tssreportcategorydetail.help.txt
@@ -0,0 +1,32 @@
TOPIC
This help topic describes the TssReportCategoryDetail class in the Thycotic.SecretServer module

CLASS
TssReportCategoryDetail

INHERITANCE
None

DESCRIPTION
The TssReportCategoryDetail class represents the ReportCategoryDetail object returned by Secret Server endpoint GET /reports/categories

CONSTRUCTORS
new()

PROPERTIES
ReportCategoryDescription
Report Category description

ReportCategoryId
Report Category ID

ReportCategoryName
Report Category name

SortOrder
Sort Order in which the category should appear

METHODS

RELATED LINKS:
Get-TssReportCategory
53 changes: 53 additions & 0 deletions src/en-us/about_tsssecretdetailsettings.help.txt
@@ -0,0 +1,53 @@
TOPIC
This help topic describes the TssSecretDetailSettings class in the Thycotic.SecretServer module

CLASS
TssSecretDetailSettings

INHERITANCE
None

DESCRIPTION
The TssSecretDetailSettings class represents the SecretDetailSettingsModel object returned by Secret Server endpoint GET /secrets/{id}/settings

CONSTRUCTORS
new()

PROPERTIES
ExpirationDate
Expiration Date

ExpirationDayInterval
Expiration Day Interval

ExpirationTemplateText
Expiration Template Text

ExpirationType
Expiration Type (Template, DayInterval, SpecificDate, Disabled)

OneTimePasswordSettings
One Time Password Settings

RdpLauncherSettings
RDP Launcher Settings

SendEmailWhenChanged
Send Email When Changed

SendEmailWhenHeartbeatFails
Send Email When Heartbeat Fails

SendEmailWhenViewed
Send Email When Viewed

SshLauncherSettings
SSH Launcher Settings

METHODS

RELATED LINKS:
TssOneTimePasswordSettings
TssRdpLauncherSettings
TssSshLauncherSettings
Get-TssSecretSetting
4 changes: 2 additions & 2 deletions src/en-us/about_tsssecretdetailstate.help.txt
Expand Up @@ -2,13 +2,13 @@ TOPIC
This help topic describes the TssSecretDetailState class in the Thycotic.SecretServer module

CLASS
TssSecretDetailActionType
TssSecretDetailState

INHERITANCE
None

DESCRIPTION
The TssSecretDetailActionType class represents the SecretDetao;StateViewModel returned by Secret Server endpoint GET /secrets/{id}/state
The TssSecretDetailState class represents the SecretDetailStateViewModel returned by Secret Server endpoint GET /secrets/{id}/state

CONSTRUCTORS
new()
Expand Down
26 changes: 26 additions & 0 deletions src/en-us/about_tsssecretheartbeatstatus.help.txt
@@ -0,0 +1,26 @@
TOPIC
This help topic describes the TssSecretHeartbeatStatus class in the Thycotic.SecretServer module

CLASS
TssSecretHeartbeatStatus

INHERITANCE
None

DESCRIPTION
The TssSecretHeartbeatStatus class represents the object returned by Secret Server endpoint GET /internals/secret-detail/{id}/heartbeat-status

CONSTRUCTORS
new()

PROPERTIES
Status
Heartbeat Status (Failed, Success, Pending, Disabled, UnableToConnect, UnknownError, IncompatibleHost, AccountLockedOut, DnsMismatch, UnableToValidateServerPublicKey, Processing)

LastHeartbeatCheck
Date and time of last heartbeat check

METHODS

RELATED LINKS:
Get-TssSecretHeartbeatStatus
36 changes: 36 additions & 0 deletions src/en-us/about_tsssshlaunchersettings.help.txt
@@ -0,0 +1,36 @@
TOPIC
This help topic describes the TssSshLauncherSettings class in the Thycotic.SecretServer module

CLASS
TssSshLauncherSettings

INHERITANCE
None

DESCRIPTION
The TssSshLauncherSettings class represents the SshLauncherSettingsModel object returned by Secret Server endpoint GET /secrets/{id}/settings

CONSTRUCTORS
new()

PROPERTIES
CanConnectAsCredentials
Can Connect As Credentials

LauncherType
Launcher Type (ConnectAsSecret, ConnectAsDifferentSecret, UseSshKeyOnSecret)

SecretId
Secret Id

SecretName
Secret Name

SshKeyExtendedTypeId
SSH Key Extended Type Id

METHODS

RELATED LINKS:
TssSecretDetailSettings
Get-TssSecretSetting

0 comments on commit 1b07f60

Please sign in to comment.