From 42da615c0a87096a16b34638044175086cf77bf6 Mon Sep 17 00:00:00 2001 From: Shawn Melton <11204251+wsmelton@users.noreply.github.com> Date: Sun, 4 Apr 2021 00:15:59 -0500 Subject: [PATCH] Get-TssConfiguration - add about files for classes --- ...sconfigurationapplicationsettings.help.txt | 93 +++++++++++++++++++ ...out_tssconfigurationemailsettings.help.txt | 45 +++++++++ .../about_tssconfigurationfolders.help.txt | 39 ++++++++ .../about_tssconfigurationgeneral.help.txt | 48 ++++++++++ ...ssconfigurationlocaluserpasswords.help.txt | 69 ++++++++++++++ ...tssconfigurationpermissionoptions.help.txt | 36 +++++++ ...ut_tssconfigurationuserexperience.help.txt | 57 ++++++++++++ ...out_tssconfigurationuserinterface.help.txt | 36 +++++++ src/en-us/about_tssuserrolesummary.help.txt | 2 +- 9 files changed, 424 insertions(+), 1 deletion(-) create mode 100644 src/en-us/about_tssconfigurationapplicationsettings.help.txt create mode 100644 src/en-us/about_tssconfigurationemailsettings.help.txt create mode 100644 src/en-us/about_tssconfigurationfolders.help.txt create mode 100644 src/en-us/about_tssconfigurationgeneral.help.txt create mode 100644 src/en-us/about_tssconfigurationlocaluserpasswords.help.txt create mode 100644 src/en-us/about_tssconfigurationpermissionoptions.help.txt create mode 100644 src/en-us/about_tssconfigurationuserexperience.help.txt create mode 100644 src/en-us/about_tssconfigurationuserinterface.help.txt diff --git a/src/en-us/about_tssconfigurationapplicationsettings.help.txt b/src/en-us/about_tssconfigurationapplicationsettings.help.txt new file mode 100644 index 00000000..a1062d8a --- /dev/null +++ b/src/en-us/about_tssconfigurationapplicationsettings.help.txt @@ -0,0 +1,93 @@ +TOPIC + This help topic describes the TssConfigurationApplicationSettings class in the Thycotic.SecretServer module + +CLASS + TssConfigurationApplicationSettings + +INHERITANCE + None + +DESCRIPTION + The TssConfigurationApplicationSettings class represents the ConfigurationApplicationSettingsModel returned by Secret Server endpoint GET /configuration/general + +CONSTRUCTORS + new() + +PROPERTIES + AllowSendTelemetry + Send Anonymized System Metrics Information + + AllowSoftwareUpdateChecks + Allow software update checks + + ApiRefreshTokensEnabled + API Refresh Tokens Enabled + + ApiSessionTimeoutDays + API session timeout days + + ApiSessionTimeoutHours + API session timeout hours + + ApiSessionTimeoutMinutes + API session timeout minutes + + ApiSessionTimeoutUnlimited + API session timeout unlimited + + CustomUrl + Outward accessible url to get to application + + EnableCredSsp + Enable Cred SSP for win RM + + EnableSyslogCefLogging + Enable Syslog/CEF Logging + + EnableWebServices + Enable Web services + + MaximumTokenRefreshesAllowed + Maximum Token Refreshes Allowed + + MaxSecretLogLength + Maximum number of entries in secret log + + MobileMaxOfflineDays + The Maximum Time for Offline Access on Mobile Devices setting in Secret Server determines how long to cache secret data on the mobile device + + MobileMaxOfflineHours + The Maximum Time for Offline Access on Mobile Devices setting in Secret Server determines how long to cache secret data on the mobile device + + PreventApplicationFromSleeping + A keep alive thread will run in the background pinging the web URL to make sure IIS does not stop running due to inactivity + + SyslogCefLogSite + This is the site that the CEF/Syslogs will run on + + SyslogCefPort + Syslog/CEF Protocol + + SyslogCefProtocol + Syslog/CEF Protocol to use when sending logs (UPD, TCP, SECURE_TCP) + + SyslogCefServer + Syslog/CEF Server Address + + SyslogCefTimeZone + Time Zone to use when sending Syslog/CEF Protocol log entries (ServerTime, UtcTime) + + TmsInstallationPath + If TMS is installed, the file location + + WinRmEndpointUrl + Win RM endpoint url + + WriteSyslogToEventLog + Enable syslog events to the windows event log + +METHODS + +RELATED LINKS: + TssConfiguration + Get-TssConfiguration \ No newline at end of file diff --git a/src/en-us/about_tssconfigurationemailsettings.help.txt b/src/en-us/about_tssconfigurationemailsettings.help.txt new file mode 100644 index 00000000..c134a5f1 --- /dev/null +++ b/src/en-us/about_tssconfigurationemailsettings.help.txt @@ -0,0 +1,45 @@ +TOPIC + This help topic describes the TssConfigurationEmailSettings class in the Thycotic.SecretServer module + +CLASS + TssConfigurationEmailSettings + +INHERITANCE + None + +DESCRIPTION + The TssConfigurationEmailSettings class represents the ConfigurationEmailModel returned by Secret Server endpoint GET /configuration/general + +CONSTRUCTORS + new() + +PROPERTIES + FromEmailAddress + All emails will be sent from this address + + SmtpDomain + SMTP user domain + + SmtpPassword + SMTP user password + + SmtpPort + Custom port, otherwise the default + + SmtpServer + The resolvable and reachable host name for the outgoing SMTP server + + SmtpUseCredentials + True if credentials are set, false if anonymous + + SmtpUserName + SMTP user name + + smtpUseSSL + Use SSL to connect + +METHODS + +RELATED LINKS: + TssConfiguration + Get-TssConfiguration \ No newline at end of file diff --git a/src/en-us/about_tssconfigurationfolders.help.txt b/src/en-us/about_tssconfigurationfolders.help.txt new file mode 100644 index 00000000..78fe4673 --- /dev/null +++ b/src/en-us/about_tssconfigurationfolders.help.txt @@ -0,0 +1,39 @@ +TOPIC + This help topic describes the TssConfigurationFolders class in the Thycotic.SecretServer module + +CLASS + TssConfigurationFolders + +INHERITANCE + None + +DESCRIPTION + The TssConfigurationFolders class represents the ConfigurationFoldersModel returned by Secret Server endpoint GET /configuration/general + +CONSTRUCTORS + new() + +PROPERTIES + EnablePersonalFolders + Each user will have a personal folder created and assigned to them + + PersonalFolderName + The name of the root personal folder. Each user's personal folder will be named based on the user + + PersonalFolderNameOption + The format for the personal folder name for each user (DisplayName, UsernameAndDomain) + + PersonalFolderWarning + Warning to be shown when creating Secrets if ShowPersonalFolderWarning is true + + RequireViewFolderPermission + Users will only see folders they have View permissions on + + ShowPersonalFolderWarning + When true the PersonalFolderWarning will be shown when creating Secrets + +METHODS + +RELATED LINKS: + TssConfiguration + Get-TssConfiguration \ No newline at end of file diff --git a/src/en-us/about_tssconfigurationgeneral.help.txt b/src/en-us/about_tssconfigurationgeneral.help.txt new file mode 100644 index 00000000..cb2c2a4d --- /dev/null +++ b/src/en-us/about_tssconfigurationgeneral.help.txt @@ -0,0 +1,48 @@ +TOPIC + This help topic describes the TssConfigurationGeneral class in the Thycotic.SecretServer module + +CLASS + TssConfigurationGeneral + +INHERITANCE + None + +DESCRIPTION + The TssConfigurationGeneral class represents the ConfigurationGeneral object returned by Secret Server endpoint GET /configuration/general + +CONSTRUCTORS + new() + +PROPERTIES + ApplicationSettings + General Application Configuration Settings + + Email + Email server configuration + + Folders + Folders Configuration + + LocalUserPasswords + Local User Passwords configuration + + PermissionOptions + Permission Options Configuration + + UserExperience + User Experience Configuration + + UserInterface + User Interface Configuration Settings + +METHODS + +RELATED LINKS: + TssConfigurationApplicationSettings + TssConfigurationEmailSettings + TssConfigurationFolders + TssConfigurationLocalUserPasswords + TssConfigurationPermissionOptions + TssConfigurationUserExperience + TssConfigurationUserInterface + Get-TssConfiguration \ No newline at end of file diff --git a/src/en-us/about_tssconfigurationlocaluserpasswords.help.txt b/src/en-us/about_tssconfigurationlocaluserpasswords.help.txt new file mode 100644 index 00000000..21ce1764 --- /dev/null +++ b/src/en-us/about_tssconfigurationlocaluserpasswords.help.txt @@ -0,0 +1,69 @@ +TOPIC + This help topic describes the TssConfigurationLocalUserPasswords class in the Thycotic.SecretServer module + +CLASS + TssConfigurationLocalUserPasswords + +INHERITANCE + None + +DESCRIPTION + The TssConfigurationLocalUserPasswords class represents the ConfigurationLocalUserPasswords returned by Secret Server endpoint GET /configuration/general + +CONSTRUCTORS + new() + +PROPERTIES + AllowUsersToResetForgottenPasswords + Whether or not the local password can be reset by the user + + EnableLocalUserPasswordExpiration + Indicates whether or not local users must change their password when it is reset or expires. + + EnableMinimumPasswordAge + Local users cannot change their password until it meets this age + + EnablePasswordHistory + Passwords cannot be reused when enabled and still in stored history + + LocalUserPasswordExpirationDays + How many days until the password expires + + LocalUserPasswordExpirationHours + How many hours until the password expires + + LocalUserPasswordExpirationMinutes + How many minutes until the password expires + + MinimumPasswordAgeDays + How many days until password can be changed + + MinimumPasswordAgeHours + How many hours until password can be changed + + MinimumPasswordAgeMinutes + How many minutes until password can be changed + + PasswordHistoryItems + How many passwords should be stored in history. + + PasswordMinimumLength + The minimum length required for local user passwords + + PasswordRequireLowercase + Whether or not the local password must include a lowercase letter + + PasswordRequireNumbers + Whether or not the local password must include a number + + PasswordRequireSymbols + Whether or not the local password must include a symbol + + PasswordRequireUppercase + Whether or not the local password must include an uppercase letter + +METHODS + +RELATED LINKS: + TssConfiguration + Get-TssConfiguration \ No newline at end of file diff --git a/src/en-us/about_tssconfigurationpermissionoptions.help.txt b/src/en-us/about_tssconfigurationpermissionoptions.help.txt new file mode 100644 index 00000000..c12efc03 --- /dev/null +++ b/src/en-us/about_tssconfigurationpermissionoptions.help.txt @@ -0,0 +1,36 @@ +TOPIC + This help topic describes the TssConfigurationPermissionOptions class in the Thycotic.SecretServer module + +CLASS + TssConfigurationPermissionOptions + +INHERITANCE + None + +DESCRIPTION + The TssConfigurationPermissionOptions class represents the ConfigurationPermissionOptionsModel returned by Secret Server endpoint GET /configuration/general + +CONSTRUCTORS + new() + +PROPERTIES + AllowDuplicateSecretNames + Allow Secrets to have the same name in the same folder + + AllowViewUserToRetrieveAutoChangeNextPassword + Users that only have secret view can see the next password + + DefaultSecretPermissions + Default permissions to be applied when a Secret is created (InheritsPermissions, CopyFromFolder, OnlyAllowCreator) + + EnableApprovalFromEmail + Allow approval from email + + ForceSecretApproval + Require approval for secrets (None, RequireApprovalForOwnersAndEditors, RequireApprovalForEditors) + +METHODS + +RELATED LINKS: + TssConfiguration + Get-TssConfiguration \ No newline at end of file diff --git a/src/en-us/about_tssconfigurationuserexperience.help.txt b/src/en-us/about_tssconfigurationuserexperience.help.txt new file mode 100644 index 00000000..c0265d1f --- /dev/null +++ b/src/en-us/about_tssconfigurationuserexperience.help.txt @@ -0,0 +1,57 @@ +TOPIC + This help topic describes the TssConfigurationUserExperience class in the Thycotic.SecretServer module + +CLASS + TssConfigurationUserExperience + +INHERITANCE + None + +DESCRIPTION + The TssConfigurationUserExperience class represents the ConfigurationUserExperienceModel returned by Secret Server endpoint GET /configuration/general + +CONSTRUCTORS + new() + +PROPERTIES + ApplicationLanguage + The default application language for users and the language for non-user specific tasks like logging when applicable + + DefaultDateFormat + The default date format that everyone sees unless they override with a user preference + + DefaultNewUserRoleId + The role that should be assigned when a new user is created + + DefaultTimeFormat + The default time format that everyone sees unless they override with a user preference + + ForceInactivityTimeout + Logout users that are inactive + + ForceInactivityTimeoutMinutes + Logout users that are inactive for this many minutes + + RequireFolderForSecret + Secrets must be created within a folder + + SecretPasswordHistoryRestrictionAll + No duplicate passwords on a Secret + + SecretPasswordHistoryRestrictionCount + How many passwords must be unique on a Secret + + SecretViewIntervalMinutes + How long entering comments to view a Secret last before being required again + + ServerTimeZoneId + The timezone that the server shows by default and when job scheduling runs + + UiInactivitySleepMinutes + How long until the UI will go inactive and stop polling for updates + +METHODS + +RELATED LINKS: + TssConfiguration + Get-TssConfiguration \ No newline at end of file diff --git a/src/en-us/about_tssconfigurationuserinterface.help.txt b/src/en-us/about_tssconfigurationuserinterface.help.txt new file mode 100644 index 00000000..92ba1050 --- /dev/null +++ b/src/en-us/about_tssconfigurationuserinterface.help.txt @@ -0,0 +1,36 @@ +TOPIC + This help topic describes the TssConfigurationUserInterface class in the Thycotic.SecretServer module + +CLASS + TssConfigurationUserInterface + +INHERITANCE + None + +DESCRIPTION + The TssConfigurationUserInterface class represents the ConfigurationUserInterfaceModel returned by Secret Server endpoint GET /configuration/general + +CONSTRUCTORS + new() + +PROPERTIES + AllowUserToSelectTheme + Allow users to pick their theme when in classic mode + + CustomLogoCollapsed + Custom logo when left nav is collapsed + + CustomLogoFullSize + Custom logo full size + + DefaultClassicTheme + Default classic theme + + NewUiDefault + New users will use the new ui by default + +METHODS + +RELATED LINKS: + TssConfiguration + Get-TssConfiguration \ No newline at end of file diff --git a/src/en-us/about_tssuserrolesummary.help.txt b/src/en-us/about_tssuserrolesummary.help.txt index 9f0bdf96..2fcaa53a 100644 --- a/src/en-us/about_tssuserrolesummary.help.txt +++ b/src/en-us/about_tssuserrolesummary.help.txt @@ -2,7 +2,7 @@ TOPIC This help topic describes the TssUserRoleSummary class in the Thycotic.SecretServer module CLASS - TssUserRole + TssUserRoleSummary INHERITANCE None