openapi: 3.0.0 info: title: Secret Server Rest Activations SecretServerSettings API description: REST API documentation for Secret Server. This document describes how to use the REST API. All requests require an authentication token; please see the authentication document for more information. The Swagger specification for this API is also available. termsOfService: https://delinea.com/eula contact: name: Support url: https://delinea.com version: 11.7.2 servers: - url: /SecretServer/api security: - BearerToken: [] tags: - name: SecretServerSettings description: Secret Server Settings paths: /v1/secretserversettings/export/stub: get: tags: - SecretServerSettings summary: Stub an empty Secret Server Settings export description: Returns an empty Secret Server Settings export to be filled out. operationId: SecretServerSettingsService_GetExportStub responses: '200': description: An empty Secret Server Settings export content: application/json: schema: $ref: '#/components/schemas/SecretServerSettingsModel' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false /v1/secretserversettings/export: post: tags: - SecretServerSettings summary: Get Secret Server Settings description: Get Secret Server Settings operationId: SecretServerSettingsService_GetExport requestBody: content: application/json: schema: $ref: '#/components/schemas/ExportSecretSettingsArgs' description: args responses: '200': description: Secret Server Settings content: application/json: schema: $ref: '#/components/schemas/SecretServerSettingsExportResultModel' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false /v1/secretserversettings/capabilities: post: tags: - SecretServerSettings summary: Get Import/Export Capabilities description: Returns model indicating what the user can import and export. operationId: SecretServerSettingsService_GetExportImportCapabilities requestBody: content: application/json: schema: $ref: '#/components/schemas/SecretServerSettingsImportCapabilitiesArgs' description: args responses: '200': description: Capability model content: application/json: schema: $ref: '#/components/schemas/SecretServerSettingsImportCapabilityModel' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false /v1/secretserversettings/import: post: tags: - SecretServerSettings summary: Import Secret Server Settings description: Apply a set of Secret Server Settings via a JSON upload. operationId: SecretServerSettingsService_ImportSetting requestBody: content: application/json: schema: $ref: '#/components/schemas/SecretServerSettingsImportArgs' description: args responses: '200': description: The now active configuration. content: application/json: schema: $ref: '#/components/schemas/SecretServerSettingsImportResultModel' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false components: schemas: ViewFieldValueOfConfigurationLocalUserPasswordsModel: description: Local User Password configuration properties: additionalLinks: description: AdditionalLinks items: $ref: '#/components/schemas/ViewFieldLink' type: array description: description: Description type: string fieldInputType: description: FieldInputType type: string nullable: true hasHistory: description: HasHistory type: boolean nullable: true helpLink: description: HelpLink type: string helpLinkText: description: HelpLinkText type: string hidden: description: Hidden type: boolean nullable: true hideOnView: description: HideOnView type: boolean nullable: true isRequired: description: IsRequired type: boolean nullable: true label: description: Label type: string maxLength: description: MaxLength type: integer format: int32 nullable: true name: description: Name type: string placeholder: description: Placeholder type: string readOnly: description: ReadOnly type: boolean nullable: true readOnlyReason: description: ReadOnlyReason type: string sortOrder: description: SortOrder type: integer format: int32 nullable: true value: $ref: '#/components/schemas/ConfigurationLocalUserPasswordsModel' type: object ConfigurationLocalPasswordPatchModel: description: Update settings for local user password configuration properties: allowUsersToResetForgottenPasswords: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' enableLocalUserPasswordExpiration: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' enableMinimumPasswordAge: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' enablePasswordHistory: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' localUserPasswordExpirationDays: $ref: '#/components/schemas/UpdateFieldValueOfInt32' localUserPasswordExpirationHours: $ref: '#/components/schemas/UpdateFieldValueOfInt32' localUserPasswordExpirationMinutes: $ref: '#/components/schemas/UpdateFieldValueOfInt32' minimumPasswordAgeDays: $ref: '#/components/schemas/UpdateFieldValueOfInt32' minimumPasswordAgeHours: $ref: '#/components/schemas/UpdateFieldValueOfInt32' minimumPasswordAgeMinutes: $ref: '#/components/schemas/UpdateFieldValueOfInt32' passwordHistoryItems: $ref: '#/components/schemas/UpdateFieldValueOfInt32' passwordHistoryItemsAll: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' passwordMinimumLength: $ref: '#/components/schemas/UpdateFieldValueOfOptionalInt32' passwordRequireLowercase: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' passwordRequireNumbers: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' passwordRequireSymbols: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' passwordRequireUppercase: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' type: object ConfigurationSshCommandMenuModel: description: SshCommandMenus properties: active: description: Active type: boolean description: description: Description type: string name: description: Name type: string sshCommandMenuGuid: description: SshCommandMenuGuid type: string format: uuid sshCommandMenuId: description: SshCommandMenuId type: integer format: int32 type: object ConfigurationLoginPatchModel: description: Login Configuration properties: allowAutoComplete: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' allowRememberMe: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' cacheADCredentials: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' defaultLoginDomain: $ref: '#/components/schemas/UpdateFieldValueOfString' enableDomainSelector: $ref: '#/components/schemas/UpdateFieldValueOfInt32' enableLoginFailureCAPTCHA: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' maxConcurrentLoginsPerUser: $ref: '#/components/schemas/UpdateFieldValueOfInt32' maximumLoginFailures: $ref: '#/components/schemas/UpdateFieldValueOfInt32' maxLoginFailuresBeforeCAPTCHA: $ref: '#/components/schemas/UpdateFieldValueOfInt32' rememberMeTimeOutMinutes: $ref: '#/components/schemas/UpdateFieldValueOfInt32' sshKeyIntegration: $ref: '#/components/schemas/ConfigurationLoginSshKeyIntegrationPatchModel' twoFactor: $ref: '#/components/schemas/ConfigurationLoginTwoFactorPatchModel' userLockoutTimeMinutes: $ref: '#/components/schemas/UpdateFieldValueOfOptionalInt32' visualEncryptedKeyboardEnabled: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' visualEncryptedKeyboardRequired: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' type: object OptionalDateTimeOffset: description: CreationDate properties: date: description: Date type: string format: date-time dateTime: description: DateTime type: string format: date-time day: description: Day type: integer format: int32 dayOfWeek: $ref: '#/components/schemas/DayOfWeek' dayOfYear: description: DayOfYear type: integer format: int32 hour: description: Hour type: integer format: int32 localDateTime: description: LocalDateTime type: string format: date-time millisecond: description: Millisecond type: integer format: int32 minute: description: Minute type: integer format: int32 month: description: Month type: integer format: int32 offset: description: Offset type: string format: time-span second: description: Second type: integer format: int32 ticks: description: Ticks type: integer format: int64 timeOfDay: description: TimeOfDay type: string format: time-span utcDateTime: description: UtcDateTime type: string format: date-time utcTicks: description: UtcTicks type: integer format: int64 year: description: Year type: integer format: int32 type: object TicketSystemTypes: description: Value properties: {} type: string enum: - TicketNumberValidation - BmcRemedyIncidentManagement - BmcRemedyChangeManagement - PowerShell - ServiceNowChangeManagement - ServiceNowIncidentManagement ViewFieldValueOfConfigurationLauncherSettingsModel: description: Launcher Settings configuration properties: additionalLinks: description: AdditionalLinks items: $ref: '#/components/schemas/ViewFieldLink' type: array description: description: Description type: string fieldInputType: description: FieldInputType type: string nullable: true hasHistory: description: HasHistory type: boolean nullable: true helpLink: description: HelpLink type: string helpLinkText: description: HelpLinkText type: string hidden: description: Hidden type: boolean nullable: true hideOnView: description: HideOnView type: boolean nullable: true isRequired: description: IsRequired type: boolean nullable: true label: description: Label type: string maxLength: description: MaxLength type: integer format: int32 nullable: true name: description: Name type: string placeholder: description: Placeholder type: string readOnly: description: ReadOnly type: boolean nullable: true readOnlyReason: description: ReadOnlyReason type: string sortOrder: description: SortOrder type: integer format: int32 nullable: true value: $ref: '#/components/schemas/ConfigurationLauncherSettingsModel' type: object ConfigurationAdvancedUpdateArgs: description: ConfigurationAdvancedUpdateArgs required: - advancedSettingId properties: advancedSettingId: description: Setting Id type: integer format: int32 value: description: Setting Value type: string type: object UpdateFieldValueOfOptionalInt32: description: The minimum length required for local user passwords properties: dirty: description: Dirty type: boolean value: description: Value type: integer format: int32 nullable: true type: object ConfigurationLoginTwoFactorModel: description: Two Factor Login Configuration properties: allowTwoFactorRememberMe: description: When this option is checked, the user will only have to provide their two factor authentication information once in that browser for set time. This is done by setting an encrypted cookie on the browser. The cookie will no longer be valid when the Two Factor Remember Me Duration has expired type: boolean duo: $ref: '#/components/schemas/ConfigurationLoginTwoFactorDuoModel' openIdConnect: $ref: '#/components/schemas/ConfigurationLoginTwoFactorOpenIdConnectModel' radius: $ref: '#/components/schemas/ConfigurationLoginTwoFactorRadiusModel' requireTwoFactorForWebLogin: description: Require Two Factor For Web Login type: boolean requireTwoFactorForWebServices: description: Require Two Factor For Web Services type: boolean twoFactorRememberMeTimeOutDays: description: The number of days that you will not be reprompted for 2FA type: integer format: int32 type: object ConfigurationLoginTwoFactorOpenIdConnectPatchModel: description: OpenID Connect Two Factor Login Configuration properties: addNewUsersToThycoticOne: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' clientId: $ref: '#/components/schemas/UpdateFieldValueOfString' clientSecret: $ref: '#/components/schemas/UpdateFieldValueOfString' enable: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' logoutUrl: $ref: '#/components/schemas/UpdateFieldValueOfString' serverUrl: $ref: '#/components/schemas/UpdateFieldValueOfString' useThycoticOneAuthAsDefault: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' type: object ConfigurationLoginTwoFactorDuoPatchModel: description: Duo Two Factor Login Configuration properties: apiHostname: $ref: '#/components/schemas/UpdateFieldValueOfString' enable: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' integrationKey: $ref: '#/components/schemas/UpdateFieldValueOfString' secretKey: $ref: '#/components/schemas/UpdateFieldValueOfString' useRadiusUsername: $ref: '#/components/schemas/UpdateFieldValueOfOptionalBoolean' type: object ForceRequireTicketSystemOptions: description: Value properties: {} type: string enum: - ReasonOnlyRequired - BothRequired - TicketNumberOrReasonRequired - TicketNumberOnlyRequired ViewFieldLink: description: AdditionalLinks properties: isExternal: description: IsExternal type: boolean linkText: description: LinkText type: string url: description: Url type: string type: object ConfigurationEmailPatchModel: description: Update email server configuration properties: fromEmailAddress: $ref: '#/components/schemas/UpdateFieldValueOfString' fromEmailName: $ref: '#/components/schemas/UpdateFieldValueOfString' sendLegacyEmails: $ref: '#/components/schemas/UpdateFieldValueOfOptionalBoolean' smtpCheckCertificateRevocation: $ref: '#/components/schemas/UpdateFieldValueOfOptionalBoolean' smtpDomain: $ref: '#/components/schemas/UpdateFieldValueOfString' smtpPassword: $ref: '#/components/schemas/UpdateFieldValueOfString' smtpPort: $ref: '#/components/schemas/UpdateFieldValueOfOptionalInt32' smtpServer: $ref: '#/components/schemas/UpdateFieldValueOfString' smtpUseCredentials: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' smtpUseImplicitSSL: $ref: '#/components/schemas/UpdateFieldValueOfOptionalBoolean' smtpUserName: $ref: '#/components/schemas/UpdateFieldValueOfString' smtpUseSSL: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' type: object ConfigurationLoginSshKeyIntegrationModel: description: Ssh Key Integration Configuration properties: authenticationMethod: description: Require password only, public key only, password or public key, password and public key type: integer format: int32 enable: description: When activated, SSH key pairs can be used for authentication in SSH Terminal type: boolean expirationInHours: description: The number of days and hours the key will stay active type: integer format: int32 isPublicSshPassphraseRequired: description: When generating client keys for a user this indicates if the user is required to enter a passphrase. type: boolean keyExpires: description: When activated, SSH keys will expire after a specified amount of time type: boolean twoFactorBypass: description: When activated, providing a valid SSH key (and password, if required by Unix Authentication Method) will bypass any required 2FA validation type: boolean type: object ConfigurationSamlModel: description: SAML configuration properties: enabled: description: Enable SAML authentication type: boolean enableLegacySLO: description: Enable legacy SingleLogout type: boolean identityProviders: description: List of Identity Providers items: $ref: '#/components/schemas/ConfigurationSamlIdentityProviderModel' type: array legacyUsernameAttribute: description: Optional AttributeName to use for matching a Secret Server user. type: string serviceProviderCertificate: description: The Service Provider Certificate. Base64 encoded type: string serviceProviderCertificateExpirationDateString: description: The expiration date of the Service Provider Certificate type: string serviceProviderCertificateFriendlyName: description: The friendly name of the Service Provider Certificate type: string serviceProviderCertificatePassword: description: The password for the Service Provider Certificate type: string serviceProviderCertificateSubject: description: The subject of the Service Provider Certificate type: string serviceProviderCertificateThumbprint: description: The thumbprint of the Service Provider Certificate type: string serviceProviderName: description: The name of the Service Provider type: string useLegacy: description: Use Legacy SAML type: boolean type: object ConfigurationLoginModel: description: Login Configuration properties: allowAutoComplete: description: 'Deprecated: AutoComplete is a feature provided by most web browsers to automatically remember and prefill forms for you. This can be a great security concern since they typically do not save the data in a secure manner. You can enable or disable web browser prefill on the Login screen by using this option. Will always return true.' type: boolean allowRememberMe: description: This option enables the "Remember Me" checkbox on the login screen. When a user chooses to use "Remember Me", an encrypted cookie will be set in their browser. This will enable the user to revisit Secret Server without the need to log in. This cookie will no longer be valid when the "Remember Me" period has expired and they will have to log in again type: boolean cacheADCredentials: description: Allows cached credentials to be used when Distributed Engine is unable to connect to Active Directory type: boolean nullable: true defaultLoginDomain: description: Default Login Domain type: string enableDomainSelector: description: Display the domain selector at login type: integer format: int32 enableLoginFailureCAPTCHA: description: When this option is checked, the user will only have to complete a CAPTCHA if their login credentials are entered incorrectly a certain number of times type: boolean maxConcurrentLoginsPerUser: description: Maximum concurrent logins per user type: integer format: int32 maximumLoginFailures: description: Set the number of login attempts allowed before a user is locked out of their account. Once locked out, they will need a Secret Server administrator to reset their password and enable their account type: integer format: int32 maxLoginFailuresBeforeCAPTCHA: description: Maximum Login Failures Before CAPTCHA type: integer format: int32 rememberMeTimeOutMinutes: description: The number of minutes that you will be remembered type: integer format: int32 sshKeyIntegration: $ref: '#/components/schemas/ConfigurationLoginSshKeyIntegrationModel' twoFactor: $ref: '#/components/schemas/ConfigurationLoginTwoFactorModel' userLockoutTimeMinutes: description: Number of minutes a User will be locked out for type: integer format: int32 nullable: true visualEncryptedKeyboardEnabled: description: Enable the Visual Keyboard for logins type: boolean visualEncryptedKeyboardRequired: description: Require the Visual Keyboard for logins type: boolean type: object DefaultSecretPermissionsType: description: Default permissions to be applied when a Secret is created properties: {} type: string enum: - InheritsPermissions - CopyFromFolder - OnlyAllowCreator LauncherDeploymentType: description: Value properties: {} type: string enum: - ClickOnce - ProtocolHandler SecretServerSettingsImportCapabilityModel: description: SecretServerSettingsImportCapabilityModel properties: advancedSettings: $ref: '#/components/schemas/ViewFieldValueOfConfigurationAdvancedModelArray' applicationSettings: $ref: '#/components/schemas/ViewFieldValueOfConfigurationApplicationSettingsModel' configurationVersion: description: Export Configuration Version type: string email: $ref: '#/components/schemas/ViewFieldValueOfConfigurationEmailModel' externalInstanceId: description: ID for specific instance type: string format: uuid folderSettings: $ref: '#/components/schemas/ViewFieldValueOfConfigurationFoldersModel' launcherSettings: $ref: '#/components/schemas/ViewFieldValueOfConfigurationLauncherSettingsModel' licenses: $ref: '#/components/schemas/ViewFieldValueOfLicenseModelArray' localUserPasswords: $ref: '#/components/schemas/ViewFieldValueOfConfigurationLocalUserPasswordsModel' login: $ref: '#/components/schemas/ViewFieldValueOfConfigurationLoginModel' permissionOptions: $ref: '#/components/schemas/ViewFieldValueOfConfigurationPermissionOptionsModel' protocolHandlerSettings: $ref: '#/components/schemas/ViewFieldValueOfConfigurationProtocolHandlerSettingsModel' saml: $ref: '#/components/schemas/ViewFieldValueOfConfigurationSamlModel' security: $ref: '#/components/schemas/ViewFieldValueOfConfigurationSecurityModel' sessionRecording: $ref: '#/components/schemas/ViewFieldValueOfConfigurationSessionRecordingModel' sshCommands: $ref: '#/components/schemas/ViewFieldValueOfConfigurationSshCommandExportModel' ticketSystem: $ref: '#/components/schemas/ViewFieldValueOfConfigurationTicketSystemModel' userExperience: $ref: '#/components/schemas/ViewFieldValueOfConfigurationUserExperienceModel' userInterface: $ref: '#/components/schemas/ViewFieldValueOfConfigurationUserInterfaceModel' type: object UpdateFieldValueOfTicketSystemTypes: description: Ticket System Type properties: dirty: description: Dirty type: boolean value: $ref: '#/components/schemas/TicketSystemTypes' type: object ConfigurationApplicationSettingsPatchModel: description: Update application settings configuration properties: allowSendTelemetry: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' allowSoftwareUpdateChecks: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' apiRefreshTokensEnabled: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' apiSessionTimeoutDays: $ref: '#/components/schemas/UpdateFieldValueOfInt32' apiSessionTimeoutHours: $ref: '#/components/schemas/UpdateFieldValueOfInt32' apiSessionTimeoutMinutes: $ref: '#/components/schemas/UpdateFieldValueOfInt32' apiSessionTimeoutUnlimited: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' configurationEarlyAdopterEnabled: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' customUrl: $ref: '#/components/schemas/UpdateFieldValueOfString' displayDowntimeMessageToAdminsOnly: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' enableCredSsp: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' enableSyslogCefLogging: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' enableWebServices: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' externalInstanceId: description: ExternalInstanceId type: boolean maximumTokenRefreshesAllowed: $ref: '#/components/schemas/UpdateFieldValueOfInt32' maxSecretLogLength: $ref: '#/components/schemas/UpdateFieldValueOfInt32' mobileMaxOfflineDays: $ref: '#/components/schemas/UpdateFieldValueOfInt32' mobileMaxOfflineHours: $ref: '#/components/schemas/UpdateFieldValueOfInt32' obfuscatePersonallyIdentifiableInformation: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' piiObfuscationLevel: $ref: '#/components/schemas/UpdateFieldValueOfString' preventApplicationFromSleeping: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' preventDirectApiAuthentication: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' syslogCefDateTimeFormat: $ref: '#/components/schemas/UpdateFieldValueOfSyslogCefDateTimeFormatType' syslogCefLogSite: $ref: '#/components/schemas/UpdateFieldValueOfInt32' syslogCefPort: $ref: '#/components/schemas/UpdateFieldValueOfInt32' syslogCefProtocol: $ref: '#/components/schemas/UpdateFieldValueOfSyslogCefProtocolType' syslogCefServer: $ref: '#/components/schemas/UpdateFieldValueOfString' syslogCefTimeZone: $ref: '#/components/schemas/UpdateFieldValueOfSyslogCefTimeZoneType' tmsInstallationPath: $ref: '#/components/schemas/UpdateFieldValueOfString' winRmEndpointUrl: $ref: '#/components/schemas/UpdateFieldValueOfString' writeSyslogToEventLog: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' type: object SecretServerSettingsModel: description: SecretServerSettingsModel properties: advancedSettings: description: Advanced Configuration Settings items: $ref: '#/components/schemas/ConfigurationAdvancedModel' type: array applicationSettings: $ref: '#/components/schemas/ConfigurationApplicationSettingsModel' configurationVersion: description: Export Configuration Version type: string email: $ref: '#/components/schemas/ConfigurationEmailModel' externalInstanceId: description: ID for specific instance type: string format: uuid folderSettings: $ref: '#/components/schemas/ConfigurationFoldersModel' launcherSettings: $ref: '#/components/schemas/ConfigurationLauncherSettingsModel' licenses: description: License Keys items: $ref: '#/components/schemas/LicenseModel' type: array localUserPasswords: $ref: '#/components/schemas/ConfigurationLocalUserPasswordsModel' login: $ref: '#/components/schemas/ConfigurationLoginModel' permissionOptions: $ref: '#/components/schemas/ConfigurationPermissionOptionsModel' protocolHandlerSettings: $ref: '#/components/schemas/ConfigurationProtocolHandlerSettingsModel' saml: $ref: '#/components/schemas/ConfigurationSamlModel' security: $ref: '#/components/schemas/ConfigurationSecurityModel' sessionRecording: $ref: '#/components/schemas/ConfigurationSessionRecordingModel' sshCommands: $ref: '#/components/schemas/ConfigurationSshCommandExportModel' ticketSystem: $ref: '#/components/schemas/ConfigurationTicketSystemModel' userExperience: $ref: '#/components/schemas/ConfigurationUserExperienceModel' userInterface: $ref: '#/components/schemas/ConfigurationUserInterfaceModel' type: object ViewFieldValueOfConfigurationUserExperienceModel: description: User Experience configuration properties: additionalLinks: description: AdditionalLinks items: $ref: '#/components/schemas/ViewFieldLink' type: array description: description: Description type: string fieldInputType: description: FieldInputType type: string nullable: true hasHistory: description: HasHistory type: boolean nullable: true helpLink: description: HelpLink type: string helpLinkText: description: HelpLinkText type: string hidden: description: Hidden type: boolean nullable: true hideOnView: description: HideOnView type: boolean nullable: true isRequired: description: IsRequired type: boolean nullable: true label: description: Label type: string maxLength: description: MaxLength type: integer format: int32 nullable: true name: description: Name type: string placeholder: description: Placeholder type: string readOnly: description: ReadOnly type: boolean nullable: true readOnlyReason: description: ReadOnlyReason type: string sortOrder: description: SortOrder type: integer format: int32 nullable: true value: $ref: '#/components/schemas/ConfigurationUserExperienceModel' type: object UpdateFieldValueOfLauncherDeploymentType: description: Launcher Deployment Type properties: dirty: description: Dirty type: boolean value: $ref: '#/components/schemas/LauncherDeploymentType' type: object ConfigurationUserExperiencePatchModel: description: Update user experience configuration properties: applicationLanguage: $ref: '#/components/schemas/UpdateFieldValueOfInt32' checkoutNotificationThreshold: $ref: '#/components/schemas/UpdateFieldValueOfInt32' defaultDateFormat: $ref: '#/components/schemas/UpdateFieldValueOfInt32' defaultNewUserRoleId: $ref: '#/components/schemas/UpdateFieldValueOfOptionalInt32' defaultTimeFormat: $ref: '#/components/schemas/UpdateFieldValueOfInt32' enableSecretCheckOutExtension: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' forceInactivityTimeout: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' forceInactivityTimeoutMinutes: $ref: '#/components/schemas/UpdateFieldValueOfInt32' maxCheckOutExtensionInMinutes: $ref: '#/components/schemas/UpdateFieldValueOfOptionalInt32' requireFolderForSecret: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' searchDelayMs: $ref: '#/components/schemas/UpdateFieldValueOfInt32' secretPasswordHistoryRestrictionAll: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' secretPasswordHistoryRestrictionCount: $ref: '#/components/schemas/UpdateFieldValueOfOptionalInt32' secretViewIntervalMinutes: $ref: '#/components/schemas/UpdateFieldValueOfInt32' serverTimeZoneId: $ref: '#/components/schemas/UpdateFieldValueOfString' uiInactivitySleepMinutes: $ref: '#/components/schemas/UpdateFieldValueOfInt32' type: object ConfigurationFoldersModel: description: Folder Configuration properties: enablePersonalFolders: description: Each user will have a personal folder created and assigned to them type: boolean personalFolderName: description: The name of the root personal folder. Each user's personal folder will be named based on the user type: string personalFolderNameOption: $ref: '#/components/schemas/PersonalFolderNameOptionType' personalFolderWarning: description: Warning to be shown when creating Secrets if ShowPersonalFolderWarning is true type: string requireViewFolderPermission: description: Users will only see folders they have View permissions on type: boolean showPersonalFolderWarning: description: When true the PersonalFolderWarning will be shown when creating Secrets type: boolean type: object UpdateFieldValueOfOptionalForceSecretApprovalType: description: Force approval type on Secrets that have approval properties: dirty: description: Dirty type: boolean value: description: Value type: string nullable: true type: object UpdateFieldValueOfBoolean: description: Active properties: dirty: description: Dirty type: boolean value: description: Value type: boolean type: object UpdateFieldValueOfOptionalBmcChangeManagementCommentWorkType: description: BMC Remedy Change Management integration only. Select work type for comments added. properties: dirty: description: Dirty type: boolean value: description: Value type: string nullable: true type: object ViewFieldValueOfConfigurationLoginModel: description: Login configuration properties: additionalLinks: description: AdditionalLinks items: $ref: '#/components/schemas/ViewFieldLink' type: array description: description: Description type: string fieldInputType: description: FieldInputType type: string nullable: true hasHistory: description: HasHistory type: boolean nullable: true helpLink: description: HelpLink type: string helpLinkText: description: HelpLinkText type: string hidden: description: Hidden type: boolean nullable: true hideOnView: description: HideOnView type: boolean nullable: true isRequired: description: IsRequired type: boolean nullable: true label: description: Label type: string maxLength: description: MaxLength type: integer format: int32 nullable: true name: description: Name type: string placeholder: description: Placeholder type: string readOnly: description: ReadOnly type: boolean nullable: true readOnlyReason: description: ReadOnlyReason type: string sortOrder: description: SortOrder type: integer format: int32 nullable: true value: $ref: '#/components/schemas/ConfigurationLoginModel' type: object ViewFieldValueOfConfigurationSecurityModel: description: Security configuration properties: additionalLinks: description: AdditionalLinks items: $ref: '#/components/schemas/ViewFieldLink' type: array description: description: Description type: string fieldInputType: description: FieldInputType type: string nullable: true hasHistory: description: HasHistory type: boolean nullable: true helpLink: description: HelpLink type: string helpLinkText: description: HelpLinkText type: string hidden: description: Hidden type: boolean nullable: true hideOnView: description: HideOnView type: boolean nullable: true isRequired: description: IsRequired type: boolean nullable: true label: description: Label type: string maxLength: description: MaxLength type: integer format: int32 nullable: true name: description: Name type: string placeholder: description: Placeholder type: string readOnly: description: ReadOnly type: boolean nullable: true readOnlyReason: description: ReadOnlyReason type: string sortOrder: description: SortOrder type: integer format: int32 nullable: true value: $ref: '#/components/schemas/ConfigurationSecurityModel' type: object ConfigurationSessionRecordingSiteArchiveSummary: description: The session recording archive locations that are mapped to specific sites properties: path: description: Path type: string siteId: description: SiteId type: integer format: int32 siteName: description: SiteName type: string type: object ConfigurationAdvancedModel: description: ConfigurationAdvancedModel properties: advancedSettingId: description: AdvancedSettingId type: integer format: int32 settingName: description: SettingName type: string value: description: Value type: string type: object ViewFieldValueOfConfigurationAdvancedModelArray: description: Advanced Settings configuration properties: additionalLinks: description: AdditionalLinks items: $ref: '#/components/schemas/ViewFieldLink' type: array description: description: Description type: string fieldInputType: description: FieldInputType type: string nullable: true hasHistory: description: HasHistory type: boolean nullable: true helpLink: description: HelpLink type: string helpLinkText: description: HelpLinkText type: string hidden: description: Hidden type: boolean nullable: true hideOnView: description: HideOnView type: boolean nullable: true isRequired: description: IsRequired type: boolean nullable: true label: description: Label type: string maxLength: description: MaxLength type: integer format: int32 nullable: true name: description: Name type: string placeholder: description: Placeholder type: string readOnly: description: ReadOnly type: boolean nullable: true readOnlyReason: description: ReadOnlyReason type: string sortOrder: description: SortOrder type: integer format: int32 nullable: true value: description: Value items: $ref: '#/components/schemas/ConfigurationAdvancedModel' type: array type: object ConfigurationLoginTwoFactorRadiusModel: description: RADIUS Two Factor Login Configuration properties: attemptSilentAnswer: description: "If setup, Secret Server will automatically try to authenticate to RADIUS using a static value.\r\nIf RADIUS authentication fails, the user will be prompted for the correct RADIUS password.Please note that this is not supported when Integrated Windows\r\nAuthentication is enabled" type: boolean nullable: true attemptUserPassword: description: "If setup, Secret Server will automatically try to authenticate to RADIUS using the user's local password after it is entered during login.\r\nIf RADIUS authentication fails, the user will be prompted for the correct RADIUS password.Please note that this is not supported when Integrated Windows\r\nAuthentication is enabled" type: boolean nullable: true clientPortRange: description: RADIUS Client Port Range type: string defaultUsername: description: RADIUS Default Username type: string disableNasIpAddressAttribute: description: Disable Radius NAS-IP-Address Attribute type: boolean nullable: true enable: description: Enabling RADIUS integration will allow another form of two factor authentication for users type: boolean nullable: true enableFailoverServer: description: Enabling a Failover RADIUS server will allow another server to fail over to type: boolean nullable: true enableRadiusNasId: description: Configure the NAS-Identifier that will be sent with the RADIUS Access-Request type: boolean nullable: true failoverServerIP: description: The IP address of your Failover RADIUS server type: string failoverServerPort: description: Failover RADIUS Server Port type: integer format: int32 nullable: true failoverSharedSecret: description: Failover RADIUS Shared Secret type: string failoverTimeoutSeconds: description: Failover Time Out (seconds) type: integer format: int32 nullable: true loginExplanation: description: RADIUS Login Explanation type: string nasId: description: The NAS-Identifier attribute value that will be sent with the RADIUS Access-Request type: string protocol: description: Authentication Protocol type: integer format: int32 nullable: true serverIP: description: The IP address of your RADIUS server type: string serverPort: description: RADIUS Server Port type: integer format: int32 nullable: true sharedSecret: description: RADIUS Shared Secret for All Users type: string sharedSecretSameForAllUsers: description: Use Same RADIUS Shared Secret for All Users type: boolean nullable: true silentAnswerValue: description: A static string to send as the password to radius if AttemptSilentAuth is set to Static Value type: string timeoutSeconds: description: Time Out (seconds) type: integer format: int32 nullable: true type: object ConfigurationProtocolHandlerSettingsModel: description: Configuration Protocol Handler Settings properties: protocolHandlerInstallTimeAllowedDomains: description: Allowed Domains/IP Addresses (comma-separated) type: string protocolHandlerInstallTimeDisableAutoUpdate: description: Disable Auto Update type: boolean protocolHandlerInstallTimeSettingsEnabled: description: Enable Protocol Handler Install Time Settings type: boolean type: object ConfigurationLoginTwoFactorOpenIdConnectModel: description: OpenID Connect Two Factor Login Configuration properties: addNewUsersToThycoticOne: description: When activated, new Secret Server users will be added automatically to Thycotic One type: boolean nullable: true clientId: description: Client Id type: string clientSecret: description: Client Secret, will only be populated for export, otherwise null type: string clientSecretExists: description: Indicates if a Client Secret exists, since the Client Secret will only be populated for export type: boolean enable: description: Enable OpenID Connect Integration type: boolean nullable: true logoutUrl: description: The URL users must visit to log out of their OpenID Connect account. (Optional) type: string serverUrl: description: OpenID Connect Server URL type: string useThycoticOneAuthAsDefault: description: When activated, passwords will be checked against Thycotic One instead of Secret Server. This affects the REST API, DoubleLock, and export functionality type: boolean nullable: true type: object ViewFieldValueOfConfigurationPermissionOptionsModel: description: Permission Options configuration properties: additionalLinks: description: AdditionalLinks items: $ref: '#/components/schemas/ViewFieldLink' type: array description: description: Description type: string fieldInputType: description: FieldInputType type: string nullable: true hasHistory: description: HasHistory type: boolean nullable: true helpLink: description: HelpLink type: string helpLinkText: description: HelpLinkText type: string hidden: description: Hidden type: boolean nullable: true hideOnView: description: HideOnView type: boolean nullable: true isRequired: description: IsRequired type: boolean nullable: true label: description: Label type: string maxLength: description: MaxLength type: integer format: int32 nullable: true name: description: Name type: string placeholder: description: Placeholder type: string readOnly: description: ReadOnly type: boolean nullable: true readOnlyReason: description: ReadOnlyReason type: string sortOrder: description: SortOrder type: integer format: int32 nullable: true value: $ref: '#/components/schemas/ConfigurationPermissionOptionsModel' type: object BadRequestResponse: description: Response object for invalid requests required: - message properties: message: description: Error message type: string messageDetail: description: Error message detail type: string errorCode: description: Error message code type: string modelState: description: An object describing validation errors type: object type: object PersonalFolderNameOptionType: description: The format for the personal folder name for each user properties: {} type: string enum: - DisplayName - UsernameAndDomain ConfigurationLauncherSettingsPatchModel: description: Update launcher settings configuration properties: checkInSecretOnLastLauncherClose: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' closeLauncherOnCheckInSecret: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' enableDomainDownload: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' enableDomainUpload: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' enableLauncher: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' enableLauncherAutoUpdate: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' enableWebParsing: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' launcherDeploymentType: $ref: '#/components/schemas/UpdateFieldValueOfLauncherDeploymentType' sendSecretUrlToLauncher: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' type: object SyslogCefProtocolType: description: Value properties: {} type: string enum: - UDP - TCP - SECURE_TCP ConfigurationSessionRecordingSiteArchiveUpdateModel: description: Value properties: path: description: Path type: string siteId: description: SiteId type: integer format: int32 type: object UpdateFieldValueOfSyslogCefDateTimeFormatType: description: 'DateTime Format for Syslog/CEF Protocol log timestamps. Syslog: Jun 23 2022 11:22:33; ISO 8601: 2022-06-23T11:22:33.000' properties: dirty: description: Dirty type: boolean value: $ref: '#/components/schemas/SyslogCefDateTimeFormatType' type: object UpdateFieldValueOfSyslogCefProtocolType: description: Syslog/CEF Protocol to use when sending logs properties: dirty: description: Dirty type: boolean value: $ref: '#/components/schemas/SyslogCefProtocolType' type: object UpdateFieldValueOfConfigurationSessionRecordingSiteArchiveUpdateModelArray: description: A list of archive paths mapped to sites, used when ArchiveLocationBySite is true properties: dirty: description: Dirty type: boolean value: description: Value items: $ref: '#/components/schemas/ConfigurationSessionRecordingSiteArchiveUpdateModel' type: array type: object ConfigurationPermissionOptionsModel: description: Configuration Permission Options properties: allowDuplicateSecretNames: description: Allow Secrets to have the same name in the same folder type: boolean allowViewUserToRetrieveAutoChangeNextPassword: description: Users that only have secret view can see the next password type: boolean nullable: true defaultSecretPermissions: $ref: '#/components/schemas/DefaultSecretPermissionsType' enableApprovalFromEmail: description: Allow approval from email type: boolean nullable: true forceSecretApproval: description: Require approval for secrets type: string nullable: true type: object ConfigurationSecurityPatchModel: description: Update security configuration properties: allowFilesWithoutExtension: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' allowQuantumSafeEncryption: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' allowWebServiceHttpGet: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' auditTlsErrors: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' auditTlsErrorsDebug: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' certificateChainPolicyOptions: $ref: '#/components/schemas/UpdateFieldValueOfString' clientCertificateIds: $ref: '#/components/schemas/UpdateFieldValueOfString' databaseIntegrityMonitoringSymmetricKey: $ref: '#/components/schemas/UpdateFieldValueOfString' enableApplicationHardening: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' enableDatabaseIntegrityMonitoring: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' enableFileRestrictions: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' enableFrameBlocking: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' enableHSTS: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' enableSecretErase: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' fileExtensionRestrictions: $ref: '#/components/schemas/UpdateFieldValueOfString' fipsEnabled: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' forceHttps: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' hideVersionNumber: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' hstsMaxAge: $ref: '#/components/schemas/UpdateFieldValueOfInt32' ignoreCertificateRevocationFailures: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' maximumFileSizeBytes: $ref: '#/components/schemas/UpdateFieldValueOfString' maximumFileSizeSupported: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' multifactorAuthenticationProfile: $ref: '#/components/schemas/UpdateFieldValueOfGuid' secretEraseWorkflow: $ref: '#/components/schemas/UpdateFieldValueOfOptionalInt32' webPasswordFillerRequiresFullDomainMatch: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' type: object ConfigurationProtocolHandlerSettingsPatchModel: description: Update protocol handler settings configuration properties: protocolHandlerInstallTimeAllowedDomains: $ref: '#/components/schemas/UpdateFieldValueOfString' protocolHandlerInstallTimeDisableAutoUpdate: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' protocolHandlerInstallTimeSettingsEnabled: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' type: object SecretServerSettingsImportArgs: description: SecretServerSettingsImportArgs properties: data: $ref: '#/components/schemas/SecretServerSettingsPatchModel' filter: $ref: '#/components/schemas/SecretServerSettingsQuery' type: object DayOfWeek: description: DayOfWeek properties: {} type: string enum: - Sunday - Monday - Tuesday - Wednesday - Thursday - Friday - Saturday SecretServerSettingsPatchModel: description: Data properties: advancedSettings: description: Advanced Configuration Settings items: $ref: '#/components/schemas/ConfigurationAdvancedUpdateArgs' type: array applicationSettings: $ref: '#/components/schemas/ConfigurationApplicationSettingsPatchModel' configurationVersion: description: Export Configuration Version type: string email: $ref: '#/components/schemas/ConfigurationEmailPatchModel' externalInstanceId: description: ID for specific instance type: string format: uuid folderSettings: $ref: '#/components/schemas/ConfigurationFoldersPatchModel' launcherSettings: $ref: '#/components/schemas/ConfigurationLauncherSettingsPatchModel' licenses: description: Licenses (on-perm only) items: $ref: '#/components/schemas/LicenseModel' type: array localUserPasswords: $ref: '#/components/schemas/ConfigurationLocalPasswordPatchModel' login: $ref: '#/components/schemas/ConfigurationLoginPatchModel' permissionOptions: $ref: '#/components/schemas/ConfigurationPermissionOptionsPatchModel' protocolHandlerSettings: $ref: '#/components/schemas/ConfigurationProtocolHandlerSettingsPatchModel' saml: $ref: '#/components/schemas/ConfigurationSamlPatchModel' security: $ref: '#/components/schemas/ConfigurationSecurityPatchModel' sessionRecording: $ref: '#/components/schemas/ConfigurationSessionRecordingPatchModel' sshCommands: $ref: '#/components/schemas/ConfigurationSshCommandImportModel' ticketSystem: $ref: '#/components/schemas/ConfigurationTicketSystemListCreateOrPatchModel' userExperience: $ref: '#/components/schemas/ConfigurationUserExperiencePatchModel' userInterface: $ref: '#/components/schemas/ConfigurationUserInterfacePatchModel' type: object ExportSecretSettingsModel: description: Data properties: doubleLockPassword: description: DoubleLockPassword type: string loadAdvancedSettings: description: LoadAdvancedSettings type: boolean loadAll: description: LoadAll type: boolean loadApplicationSettings: description: LoadApplicationSettings type: boolean loadEmail: description: LoadEmail type: boolean loadFolderSettings: description: LoadFolderSettings type: boolean loadLauncherSettings: description: LoadLauncherSettings type: boolean loadLicenses: description: LoadLicenses type: boolean loadLocalUserPasswords: description: LoadLocalUserPasswords type: boolean loadLogin: description: LoadLogin type: boolean loadPermissionOptions: description: LoadPermissionOptions type: boolean loadProtocolHandlerSettings: description: LoadProtocolHandlerSettings type: boolean loadSaml: description: LoadSaml type: boolean loadSecurity: description: LoadSecurity type: boolean loadSessionRecording: description: LoadSessionRecording type: boolean loadSshCommands: description: LoadSshCommands type: boolean loadTicketSystem: description: LoadTicketSystem type: boolean loadUserExperience: description: LoadUserExperience type: boolean loadUserInterface: description: LoadUserInterface type: boolean password: description: Password type: string type: object AuthenticationFailedResponse: description: Response object for authentication failures required: - message properties: message: description: Error message type: string type: object ViewFieldValueOfConfigurationProtocolHandlerSettingsModel: description: Protocol Handler Settings configuration properties: additionalLinks: description: AdditionalLinks items: $ref: '#/components/schemas/ViewFieldLink' type: array description: description: Description type: string fieldInputType: description: FieldInputType type: string nullable: true hasHistory: description: HasHistory type: boolean nullable: true helpLink: description: HelpLink type: string helpLinkText: description: HelpLinkText type: string hidden: description: Hidden type: boolean nullable: true hideOnView: description: HideOnView type: boolean nullable: true isRequired: description: IsRequired type: boolean nullable: true label: description: Label type: string maxLength: description: MaxLength type: integer format: int32 nullable: true name: description: Name type: string placeholder: description: Placeholder type: string readOnly: description: ReadOnly type: boolean nullable: true readOnlyReason: description: ReadOnlyReason type: string sortOrder: description: SortOrder type: integer format: int32 nullable: true value: $ref: '#/components/schemas/ConfigurationProtocolHandlerSettingsModel' type: object UpdateFieldValueOfOptionalBmcIncidentManagementCommentWorkType: description: BMC Remedy Incident Management integration only. Select work type for comments added. properties: dirty: description: Dirty type: boolean value: description: Value type: string nullable: true type: object ConfigurationSamlPatchModel: description: SAML configuration properties: enabled: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' enableLegacySLO: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' identityProviders: description: List of Identity Providers items: $ref: '#/components/schemas/ConfigurationSamlIdentityProviderPatchModel' type: array legacyUsernameAttribute: $ref: '#/components/schemas/UpdateFieldValueOfString' serviceProviderCertificate: $ref: '#/components/schemas/UpdateFieldValueOfString' serviceProviderCertificatePassword: $ref: '#/components/schemas/UpdateFieldValueOfString' serviceProviderName: $ref: '#/components/schemas/UpdateFieldValueOfString' useLegacy: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' type: object ConfigurationLocalUserPasswordsModel: description: Configuration Section for Local User Passwords properties: allowUsersToResetForgottenPasswords: description: Whether or not the local password can be reset by the user type: boolean enableLocalUserPasswordExpiration: description: Indicates whether or not local users must change their password when it is reset or expires. type: boolean nullable: true enableMinimumPasswordAge: description: Local users cannot change their password until it meets this age type: boolean nullable: true enablePasswordHistory: description: Passwords cannot be reused when enabled and still in stored history type: boolean nullable: true localUserPasswordExpirationDays: description: How many days until the password expires type: integer format: int32 nullable: true localUserPasswordExpirationHours: description: How many hours until the password expires type: integer format: int32 nullable: true localUserPasswordExpirationMinutes: description: How many minutes until the password expires type: integer format: int32 nullable: true minimumPasswordAgeDays: description: How many days until password can be changed type: integer format: int32 nullable: true minimumPasswordAgeHours: description: How many hours until password can be changed type: integer format: int32 nullable: true minimumPasswordAgeMinutes: description: How many minutes until password can be changed type: integer format: int32 nullable: true passwordHistoryItems: description: How many passwords should be stored in history. type: integer format: int32 nullable: true passwordHistoryItemsAll: description: Keep all password history items. type: boolean passwordMinimumLength: description: The minimum length required for local user passwords type: integer format: int32 nullable: true passwordRequireLowercase: description: Whether or not the local password must include a lowercase letter type: boolean passwordRequireNumbers: description: Whether or not the local password must include a number type: boolean passwordRequireSymbols: description: Whether or not the local password must include a symbol type: boolean passwordRequireUppercase: description: Whether or not the local password must include an uppercase letter type: boolean type: object ConfigurationPermissionOptionsPatchModel: description: Update permission options configuration properties: allowDuplicateSecretNames: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' allowViewUserToRetrieveAutoChangeNextPassword: $ref: '#/components/schemas/UpdateFieldValueOfOptionalBoolean' defaultSecretPermissions: $ref: '#/components/schemas/UpdateFieldValueOfDefaultSecretPermissionsType' enableApprovalFromEmail: $ref: '#/components/schemas/UpdateFieldValueOfOptionalBoolean' forceSecretApproval: $ref: '#/components/schemas/UpdateFieldValueOfOptionalForceSecretApprovalType' type: object SyslogCefTimeZoneType: description: Value properties: {} type: string enum: - ServerTime - UtcTime DictionaryOfStringAndString: description: SshProxyExplanation properties: {} type: object UpdateFieldValueOfString: description: Description properties: dirty: description: Dirty type: boolean value: description: Value type: string type: object ViewFieldValueOfConfigurationUserInterfaceModel: description: User Interface configuration properties: additionalLinks: description: AdditionalLinks items: $ref: '#/components/schemas/ViewFieldLink' type: array description: description: Description type: string fieldInputType: description: FieldInputType type: string nullable: true hasHistory: description: HasHistory type: boolean nullable: true helpLink: description: HelpLink type: string helpLinkText: description: HelpLinkText type: string hidden: description: Hidden type: boolean nullable: true hideOnView: description: HideOnView type: boolean nullable: true isRequired: description: IsRequired type: boolean nullable: true label: description: Label type: string maxLength: description: MaxLength type: integer format: int32 nullable: true name: description: Name type: string placeholder: description: Placeholder type: string readOnly: description: ReadOnly type: boolean nullable: true readOnlyReason: description: ReadOnlyReason type: string sortOrder: description: SortOrder type: integer format: int32 nullable: true value: $ref: '#/components/schemas/ConfigurationUserInterfaceModel' type: object ViewFieldValueOfLicenseModelArray: description: Licenses (on-perm only) properties: additionalLinks: description: AdditionalLinks items: $ref: '#/components/schemas/ViewFieldLink' type: array description: description: Description type: string fieldInputType: description: FieldInputType type: string nullable: true hasHistory: description: HasHistory type: boolean nullable: true helpLink: description: HelpLink type: string helpLinkText: description: HelpLinkText type: string hidden: description: Hidden type: boolean nullable: true hideOnView: description: HideOnView type: boolean nullable: true isRequired: description: IsRequired type: boolean nullable: true label: description: Label type: string maxLength: description: MaxLength type: integer format: int32 nullable: true name: description: Name type: string placeholder: description: Placeholder type: string readOnly: description: ReadOnly type: boolean nullable: true readOnlyReason: description: ReadOnlyReason type: string sortOrder: description: SortOrder type: integer format: int32 nullable: true value: description: Value items: $ref: '#/components/schemas/LicenseModel' type: array type: object SecretServerSettingsImportCapabilitiesArgs: description: SecretServerSettingsImportCapabilitiesArgs properties: file: description: File type: string isImport: description: IsImport type: boolean type: object ViewFieldValueOfConfigurationSshCommandExportModel: description: SSH Command configuration properties: additionalLinks: description: AdditionalLinks items: $ref: '#/components/schemas/ViewFieldLink' type: array description: description: Description type: string fieldInputType: description: FieldInputType type: string nullable: true hasHistory: description: HasHistory type: boolean nullable: true helpLink: description: HelpLink type: string helpLinkText: description: HelpLinkText type: string hidden: description: Hidden type: boolean nullable: true hideOnView: description: HideOnView type: boolean nullable: true isRequired: description: IsRequired type: boolean nullable: true label: description: Label type: string maxLength: description: MaxLength type: integer format: int32 nullable: true name: description: Name type: string placeholder: description: Placeholder type: string readOnly: description: ReadOnly type: boolean nullable: true readOnlyReason: description: ReadOnlyReason type: string sortOrder: description: SortOrder type: integer format: int32 nullable: true value: $ref: '#/components/schemas/ConfigurationSshCommandExportModel' type: object SecretServerSettingsExportResultModel: description: SecretServerSettingsExportResultModel properties: exportedSecretSettingsFileText: description: Export File Text type: string fileName: description: Export File Name type: string fileType: $ref: '#/components/schemas/ExportFileType' type: object ViewFieldValueOfConfigurationTicketSystemModel: description: Ticket System configuration properties: additionalLinks: description: AdditionalLinks items: $ref: '#/components/schemas/ViewFieldLink' type: array description: description: Description type: string fieldInputType: description: FieldInputType type: string nullable: true hasHistory: description: HasHistory type: boolean nullable: true helpLink: description: HelpLink type: string helpLinkText: description: HelpLinkText type: string hidden: description: Hidden type: boolean nullable: true hideOnView: description: HideOnView type: boolean nullable: true isRequired: description: IsRequired type: boolean nullable: true label: description: Label type: string maxLength: description: MaxLength type: integer format: int32 nullable: true name: description: Name type: string placeholder: description: Placeholder type: string readOnly: description: ReadOnly type: boolean nullable: true readOnlyReason: description: ReadOnlyReason type: string sortOrder: description: SortOrder type: integer format: int32 nullable: true value: $ref: '#/components/schemas/ConfigurationTicketSystemModel' type: object ConfigurationLoginSshKeyIntegrationPatchModel: description: Ssh Key Integration Configuration properties: authenticationMethod: $ref: '#/components/schemas/UpdateFieldValueOfInt32' enable: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' expirationInHours: $ref: '#/components/schemas/UpdateFieldValueOfInt32' isPublicSshPassphraseRequired: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' keyExpires: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' twoFactorBypass: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' type: object UpdateFieldValueOfDefaultSecretPermissionsType: description: When a new Secret is created these permissions will be assigned properties: dirty: description: Dirty type: boolean value: $ref: '#/components/schemas/DefaultSecretPermissionsType' type: object UpdateFieldValueOfInt32: description: How many days until the password expires. properties: dirty: description: Dirty type: boolean value: description: Value type: integer format: int32 type: object ConfigurationApplicationSettingsModel: description: Configuration Application Settings properties: allowSendTelemetry: description: Send Anonymized System Metrics Information type: boolean nullable: true allowSoftwareUpdateChecks: description: Allow software update checks. This setting is ignored in cloud environments. type: boolean nullable: true apiRefreshTokensEnabled: description: API Refresh Tokens Enabled type: boolean apiSessionTimeoutDays: description: API session timeout days type: integer format: int32 apiSessionTimeoutHours: description: API session timeout hours type: integer format: int32 apiSessionTimeoutMinutes: description: API session timeout minutes type: integer format: int32 apiSessionTimeoutUnlimited: description: API session timeout unlimited type: boolean configurationEarlyAdopterEnabled: description: Notify when preview releases are available. False by default type: boolean nullable: true customUrl: description: Outward accessible url to get to application. This setting is ignored in cloud environments. type: string displayDowntimeMessageToAdminsOnly: description: Display Downtime Message To Admins Only type: boolean nullable: true enableCredSsp: description: Enable Cred SSP for win RM type: boolean enableSyslogCefLogging: description: Enable Syslog/CEF Logging type: boolean enableWebServices: description: Enable Web services type: boolean maximumTokenRefreshesAllowed: description: Maximum Token Refreshes Allowed type: integer format: int32 maxSecretLogLength: description: Maximum number of entries in secret log type: integer format: int32 mobileMaxOfflineDays: description: The Maximum Time for Offline Access on Mobile Devices setting in Secret Server determines how long to cache secret data on the mobile device type: integer format: int32 mobileMaxOfflineHours: description: The Maximum Time for Offline Access on Mobile Devices setting in Secret Server determines how long to cache secret data on the mobile device type: integer format: int32 obfuscatePersonallyIdentifiableInformation: description: Should Secret Server obfuscate information that could identify a person type: boolean piiObfuscationLevel: description: 'Delimit or replace personally identifiable information and automatically remove from Audit Exports ' type: string preventApplicationFromSleeping: description: A keep alive thread will run in the background pinging the web URL to make sure IIS does not stop running due to inactivity. This setting is ignored in cloud environments. type: boolean nullable: true preventDirectApiAuthentication: description: Prevent non-Application Account users from directly authenticating against the API. type: boolean syslogCefDateTimeFormat: description: 'DateTime Format for Syslog/CEF Protocol log timestamps. Syslog: Jun 23 2022 11:22:33; ISO 8601: 2022-06-23T11:22:33.000' type: string nullable: true syslogCefLogSite: description: This is the site that the CEF/Syslogs will run on type: integer format: int32 nullable: true syslogCefPort: description: Syslog/CEF Protocol type: integer format: int32 nullable: true syslogCefProtocol: description: Syslog/CEF Protocol to use when sending logs type: string nullable: true syslogCefServer: description: Syslog/CEF Server Address type: string syslogCefTimeZone: description: Time Zone to use when sending Syslog/CEF Protocol log entries type: string nullable: true tmsInstallationPath: description: If TMS is installed, the file location. This setting is ignored in cloud environments. type: string winRmEndpointUrl: description: Win RM endpoint url type: string writeSyslogToEventLog: description: Enable syslog events to the windows event log. This setting is ignored in cloud environments. type: boolean nullable: true type: object ConfigurationUserExperienceModel: description: Configuration User Experience properties: applicationLanguage: description: The default application language for users and the language for non-user specific tasks like logging when applicable type: integer format: int32 checkoutNotificationThreshold: description: Percentage of secret checkout time elapsed when checkout notification will be sent type: integer format: int32 defaultDateFormat: description: The default date format that everyone sees unless they override with a user preference type: integer format: int32 defaultNewUserRoleId: description: The role that should be assigned when a new user is created type: integer format: int32 nullable: true defaultTimeFormat: description: The default time format that everyone sees unless they override with a user preference type: integer format: int32 enableSecretCheckOutExtension: description: Enables users to extend secret check out sessions. type: boolean forceInactivityTimeout: description: Logout users that are inactive type: boolean forceInactivityTimeoutMinutes: description: Logout users that are inactive for this many minutes type: integer format: int32 maxCheckOutExtensionInMinutes: description: Maximum amount of time a secret check out can be extended in minutes. type: integer format: int32 nullable: true requireFolderForSecret: description: Secrets must be created within a folder type: boolean searchDelayMs: description: This controls the delay, in milliseconds, until the search is executed by the global search in the header. If set to 0, it will require the user to press enter in the search bar. type: integer format: int32 nullable: true secretPasswordHistoryRestrictionAll: description: No duplicate passwords on a Secret type: boolean secretPasswordHistoryRestrictionCount: description: How many passwords must be unique on a Secret type: integer format: int32 nullable: true secretViewIntervalMinutes: description: How long entering comments to view a Secret last before being required again type: integer format: int32 serverTimeZoneId: description: The timezone that the server shows by default and when job scheduling runs type: string uiInactivitySleepMinutes: description: How long until the UI will go inactive and stop polling for updates type: integer format: int32 type: object ConfigurationLoginTwoFactorDuoModel: description: Duo Two Factor Login Configuration properties: apiHostname: description: API Hostname type: string enable: description: Enable Duo Integration type: boolean nullable: true integrationKey: description: Integration Key type: string secretKey: description: Secret Key type: string useRadiusUsername: description: Use RADIUS Username for DUO type: boolean nullable: true type: object ConfigurationTicketSystemListCreateOrPatchModel: description: Ticket Systems Configuration properties: ticketSystemList: description: TicketSystemList items: $ref: '#/components/schemas/TicketSystemPatchModel' type: array type: object ConfigurationSecurityModel: description: Security Configuration properties: allowFilesWithoutExtension: description: When file extension restrictions are enabled you cannot upload a file that does not have an extension. When this is true files without extensions are allowed. type: boolean allowQuantumSafeEncryption: description: Allow Quantum Safe Encryption to provide Quantum Safe Encryption options to users. type: boolean allowWebServiceHttpGet: description: Allows the Http Get verb for Web Services. This allows REST-style calls to many Web Service methods, but reduces security type: boolean auditTlsErrors: description: When enabled, this setting will add audits for TLS certificate validation. Auditing will apply to all Active Directory domains using LDAPS and Syslog using TLS. Certificate policy options including ignoring certificate revocation failures applies to Syslog using TLS only. The default is the most strict so the certificate chain policy may need to be updated. TLS errors will be logged to Security Audit Log found on the Administration page type: boolean auditTlsErrorsDebug: description: Enable TLS Debugging and Connection Tracking type: boolean certificateChainPolicyOptions: description: Certificate chain policy options type: string clientCertificateIds: description: Client Certificate Thumbprint(s) type: string databaseIntegrityMonitoringSymmetricKey: description: The secure symmetric key to use when sending data to the separate Database Integrity Monitoring service. This can be retrieved from the configuration utility in the Database Integrity Monitoring service install location type: string enableApplicationHardening: description: Enabling Application Hardening to disallow Admins from tampering the database type: boolean enableDatabaseIntegrityMonitoring: description: When enabled, Secret Server will communicate with the separately installed Database Integrity Monitoring service. This service will send email alerts if it detects possible database tampering. Access to Secret Server's database and web servers should be restricted to highly trusted individuals only type: boolean nullable: true enableFileRestrictions: description: Enable restrictions on the types or sizes of files that can be uploaded into Secret Server type: boolean enableFrameBlocking: description: Enable Frame Blocking type: boolean nullable: true enableHSTS: description: Enable HTTP Strict Transport Security type: boolean nullable: true enableSecretErase: description: Enable secret erase functionality type: boolean fileExtensionRestrictions: description: File Extension Restrictions type: string fipsEnabled: description: Allow only FIPS compliant encryption schemes to be used type: boolean nullable: true forceHttps: description: By requiring HTTPS, users will not be able to access Secret Server using HTTP type: boolean nullable: true hideVersionNumber: description: This will disable the VersionGet SOAP call. It will also hide the Secret Server Version Numbers from the Headers and Footer type: boolean hstsMaxAge: description: Maximum Age (in seconds) type: integer format: int32 nullable: true ignoreCertificateRevocationFailures: description: Indicates if X509RevocationMode.NoCheck certificate chain policy option is set type: boolean maximumFileSizeBytes: description: Maximum File Size (bytes) type: string maximumFileSizeSupported: description: Maximum File Size supported by ASP.NET type: boolean multifactorAuthenticationProfile: description: The current Authentication Profile for Multifactor Authentication type: string format: uuid nullable: true secretEraseWorkflow: description: The workflow used by secret erase type: integer format: int32 nullable: true webPasswordFillerRequiresFullDomainMatch: description: When enabled, the Web Password Filler will only allow exact domain matches. When disabled, subdomains such as https://sub.google.com will match http://google.com Secrets. The recommended setting is enabled. type: boolean type: object ExportSecretSettingsArgs: description: ExportSecretSettingsArgs properties: data: $ref: '#/components/schemas/ExportSecretSettingsModel' type: object SshCommandBlocklistModel: description: SSH command Blocklist properties: active: description: Active / inactive type: boolean description: description: SSH command Blocklist description type: string name: description: SSH command Blocklist name type: string sshCommandBlocklistId: description: SSH command Blocklist ID type: string format: uuid sshCommands: description: SSH commands in Blocklist items: $ref: '#/components/schemas/SshCommandModel' type: array type: object TicketSystemModelV2: description: List of Ticket Systems properties: active: description: Ticket System Active status type: boolean addCommentsToTicket: description: Send comment to your integrated Ticket System and add it to the incident or change request. type: boolean bmcChangeManagementCommentWorkType: description: BMC Remedy Incident Management integration only. Select work type for comments added. type: string nullable: true bmcIncidentManagementCommentWorkType: description: BMC Remedy Incident Management integration only. Select work type for comments added. type: string nullable: true bmcRemedyAuthentication: description: BMC Remedy integration only. Authentication value that usually represents a login server. type: string bmcRemedyUrlEndpoint: description: BMC Remedy integration only. The SOAP URL endpoint for the BMC Remedy Incident or Change Management. Should be the CHG_ChangeInterface_WS or HPD_IncidentInterface_WS endpoint. type: string description: description: Ticket System Description type: string displayMessage: description: Ticket System Ticket Title type: string forceRequireTicketNumber: $ref: '#/components/schemas/ForceRequireTicketSystemOptions' hideComment: description: Hide comment box on secret access request. type: boolean isDefault: description: Indicates the Ticket System is the default choice. type: boolean name: description: Ticket System Name type: string organizationId: description: Ticket System Organization Id type: integer format: int32 nullable: true powerShellAddCommentScriptArguments: description: PowerShell integration only. Optional arguments for the comment script. Arguemnts are separated by a space. type: string powerShellAddCommentScriptId: description: PowerShell integration only. Custom PowerSHell script to add a comment to a ticket system. type: integer format: int32 nullable: true powerShellAddTicketCommentScriptArguments: description: PowerShell integration only. Optional arguments for the ticket comment script. Arguemnts are separated by a space. type: string powerShellAddTicketCommentScriptId: description: PowerShell integration only. Custom PowerSHell script to add a comment to a ticket in a ticket system. type: integer format: int32 nullable: true powerShellRunAsAccountSecretId: description: PowerShell integration only. Secret Id for credentials to use to run the Powershell. type: integer format: int32 nullable: true powerShellRunAsAccountSecretName: description: 'PowerShell integration only. Secret Name for credentials to use to run the Powershell. ' type: string powerShellTicketStatusScriptArguments: description: PowerShell integration only. Optional arguments for the ticket status script. Arguemnts are separated by a space. type: string powerShellTicketStatusScriptId: description: Powreshell Integration only. Custom PowerShell script to get the ticket status. type: integer format: int32 nullable: true serviceNowAllowedStatuses: description: ServiceNow integration only. Statuses to accept from ServiceNow separated by commas. type: string serviceNowDomainName: description: ServiceNow integration only. The domain name that hosts the RESTful web services for Ticket System integration. type: string siteId: description: Ticket System Site type: integer format: int32 nullable: true systemCredentialSecretId: description: Privilged Secret Id for credentials to connect to integrated Ticket Systems. type: integer format: int32 nullable: true systemCredentialSecretName: description: Privilged Secret name for credentials to connect to integrated Ticket Systems. type: string ticketNumberErrorMessage: description: Ticket Number Validation Error Message type: string ticketNumberValidation: description: Ticket Number Validation Regex type: string ticketSystemId: description: The unique Id of the ticket system. type: integer format: int32 ticketSystemType: $ref: '#/components/schemas/TicketSystemTypes' viewTicketUrl: description: Ticket System URL pattern type: string type: object ViewFieldValueOfConfigurationEmailModel: description: Email configuration properties: additionalLinks: description: AdditionalLinks items: $ref: '#/components/schemas/ViewFieldLink' type: array description: description: Description type: string fieldInputType: description: FieldInputType type: string nullable: true hasHistory: description: HasHistory type: boolean nullable: true helpLink: description: HelpLink type: string helpLinkText: description: HelpLinkText type: string hidden: description: Hidden type: boolean nullable: true hideOnView: description: HideOnView type: boolean nullable: true isRequired: description: IsRequired type: boolean nullable: true label: description: Label type: string maxLength: description: MaxLength type: integer format: int32 nullable: true name: description: Name type: string placeholder: description: Placeholder type: string readOnly: description: ReadOnly type: boolean nullable: true readOnlyReason: description: ReadOnlyReason type: string sortOrder: description: SortOrder type: integer format: int32 nullable: true value: $ref: '#/components/schemas/ConfigurationEmailModel' type: object TicketSystemPatchModel: description: Data properties: active: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' addCommentsToTicket: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' bmcChangeManagementCommentWorkType: $ref: '#/components/schemas/UpdateFieldValueOfOptionalBmcChangeManagementCommentWorkType' bmcIncidentManagementCommentWorkType: $ref: '#/components/schemas/UpdateFieldValueOfOptionalBmcIncidentManagementCommentWorkType' bmcRemedyAuthentication: $ref: '#/components/schemas/UpdateFieldValueOfString' bmcRemedyUrlEndpoint: $ref: '#/components/schemas/UpdateFieldValueOfString' description: $ref: '#/components/schemas/UpdateFieldValueOfString' displayMessage: $ref: '#/components/schemas/UpdateFieldValueOfString' forceRequireTicketNumber: $ref: '#/components/schemas/UpdateFieldValueOfForceRequireTicketSystemOptions' hideComment: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' isDefault: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' name: $ref: '#/components/schemas/UpdateFieldValueOfString' powerShellAddCommentScriptArguments: $ref: '#/components/schemas/UpdateFieldValueOfString' powerShellAddCommentScriptId: $ref: '#/components/schemas/UpdateFieldValueOfOptionalInt32' powerShellAddTicketCommentScriptArguments: $ref: '#/components/schemas/UpdateFieldValueOfString' powerShellAddTicketCommentScriptId: $ref: '#/components/schemas/UpdateFieldValueOfOptionalInt32' powerShellRunAsAccountSecretId: $ref: '#/components/schemas/UpdateFieldValueOfOptionalInt32' powerShellTicketStatusScriptArguments: $ref: '#/components/schemas/UpdateFieldValueOfString' powerShellTicketStatusScriptId: $ref: '#/components/schemas/UpdateFieldValueOfOptionalInt32' serviceNowAllowedStatuses: $ref: '#/components/schemas/UpdateFieldValueOfString' serviceNowDomainName: $ref: '#/components/schemas/UpdateFieldValueOfString' siteId: $ref: '#/components/schemas/UpdateFieldValueOfOptionalInt32' systemCredentialSecretId: $ref: '#/components/schemas/UpdateFieldValueOfOptionalInt32' ticketNumberErrorMessage: $ref: '#/components/schemas/UpdateFieldValueOfString' ticketNumberValidation: $ref: '#/components/schemas/UpdateFieldValueOfString' ticketSystemId: description: TicketSystemId type: integer format: int32 ticketSystemType: $ref: '#/components/schemas/UpdateFieldValueOfTicketSystemTypes' viewTicketUrl: $ref: '#/components/schemas/UpdateFieldValueOfString' type: object SshCommandPatchModel: description: SshCommands properties: command: $ref: '#/components/schemas/UpdateFieldValueOfString' name: $ref: '#/components/schemas/UpdateFieldValueOfString' sortOrder: $ref: '#/components/schemas/UpdateFieldValueOfInt32' sshCommandGuid: description: SshCommandGuid type: string format: uuid nullable: true sshCommandId: description: SshCommandId type: integer format: int32 nullable: true type: object ConfigurationSamlIdentityProviderPatchModel: description: SAML Identity Provider configuration properties: active: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' authnContext: $ref: '#/components/schemas/UpdateFieldValueOfString' clockSkew: $ref: '#/components/schemas/UpdateFieldValueOfInt32' description: $ref: '#/components/schemas/UpdateFieldValueOfString' disableAssertionReplayCheck: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' disableAudienceRestrictionCheck: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' disableAuthnContextCheck: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' disableDestinationCheck: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' disableInboundLogout: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' disableInResponseToCheck: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' disablePendingLogoutCheck: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' disableRecipientCheck: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' disableTimePeriodCheck: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' displayName: $ref: '#/components/schemas/UpdateFieldValueOfString' domainAttribute: $ref: '#/components/schemas/UpdateFieldValueOfString' enableDetailedLog: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' enableSLO: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' forceAuthentication: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' identityProviderId: description: SAML Identity Provider Id type: integer format: int32 logoutRequestLifeTime: $ref: '#/components/schemas/UpdateFieldValueOfInt32' name: $ref: '#/components/schemas/UpdateFieldValueOfString' overridePendingAuthnRequest: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' publicCertificate: $ref: '#/components/schemas/UpdateFieldValueOfString' signAuthnRequest: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' signLogoutRequest: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' signLogoutResponse: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' singleLogoutServiceResponseUrl: $ref: '#/components/schemas/UpdateFieldValueOfString' singleLogoutServiceUrl: $ref: '#/components/schemas/UpdateFieldValueOfString' ssoServiceBinding: $ref: '#/components/schemas/UpdateFieldValueOfInt32' ssoServiceUrl: $ref: '#/components/schemas/UpdateFieldValueOfString' usernameAttribute: $ref: '#/components/schemas/UpdateFieldValueOfString' wantAssertionEncrypted: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' wantAssertionOrResponseSigned: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' wantAssertionSigned: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' wantLogoutRequestSigned: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' wantLogoutResponseSigned: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' wantSAMLResponseSigned: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' type: object ConfigurationUserInterfaceModel: description: User interface settings properties: allowUserToSelectTheme: description: Allow users to pick their theme when in classic mode type: boolean nullable: true customBannerStyle: description: Style to be used for the global banner type: string customBannerText: description: Main body of text for the global banner type: string customBannerViewLink: description: Link for the View Link of the global banner type: string customBannerViewLinkText: description: Text for the View Link of the global banner type: string customLogoCollapsed: description: Custom logo when left nav is collapsed type: string customLogoCollapsedDark: description: Custom logo when left nav is collapsed in dark mode type: string customLogoFullSize: description: Custom logo full size type: string customLogoFullSizeDark: description: Custom logo full size in dark mode type: string customLogoLogin: description: Custom logo for login type: string customLogoLoginDark: description: Custom logo for login in dark mode type: string defaultClassicTheme: description: Default classic theme type: string disableLegacyUi: description: When true the legacy UI cannot be used type: boolean isCustomBannerDismissable: description: Is the global banner able to be dismissed by a user type: boolean newUiDefault: description: New users will use the new ui by default type: boolean showCustomBanner: description: Should the global banner be shown type: boolean type: object SshCommandBlocklistPatchModel: description: SshCommandBlocklists properties: active: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' description: $ref: '#/components/schemas/UpdateFieldValueOfString' name: $ref: '#/components/schemas/UpdateFieldValueOfString' sshCommandBlocklistId: description: SshCommandBlocklistId type: string format: uuid sshCommandIds: $ref: '#/components/schemas/UpdateFieldValueOfGuidArray' type: object CommandPermissionType: description: Allowed or Blocked properties: {} type: string enum: - Allowed - Blocked ViewFieldValueOfConfigurationSamlModel: description: SAML configuration properties: additionalLinks: description: AdditionalLinks items: $ref: '#/components/schemas/ViewFieldLink' type: array description: description: Description type: string fieldInputType: description: FieldInputType type: string nullable: true hasHistory: description: HasHistory type: boolean nullable: true helpLink: description: HelpLink type: string helpLinkText: description: HelpLinkText type: string hidden: description: Hidden type: boolean nullable: true hideOnView: description: HideOnView type: boolean nullable: true isRequired: description: IsRequired type: boolean nullable: true label: description: Label type: string maxLength: description: MaxLength type: integer format: int32 nullable: true name: description: Name type: string placeholder: description: Placeholder type: string readOnly: description: ReadOnly type: boolean nullable: true readOnlyReason: description: ReadOnlyReason type: string sortOrder: description: SortOrder type: integer format: int32 nullable: true value: $ref: '#/components/schemas/ConfigurationSamlModel' type: object ConfigurationLoginTwoFactorPatchModel: description: Two Factor Login Configuration properties: allowTwoFactorRememberMe: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' duo: $ref: '#/components/schemas/ConfigurationLoginTwoFactorDuoPatchModel' openIdConnect: $ref: '#/components/schemas/ConfigurationLoginTwoFactorOpenIdConnectPatchModel' radius: $ref: '#/components/schemas/ConfigurationLoginTwoFactorRadiusPatchModel' requireTwoFactorForWebLogin: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' requireTwoFactorForWebServices: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' twoFactorRememberMeTimeOutDays: $ref: '#/components/schemas/UpdateFieldValueOfInt32' type: object LicenseModel: description: License Keys properties: description: description: License Description (read-only) type: string licenseKey: description: License Key type: string licenseName: description: License Name type: string type: object ConfigurationLauncherSettingsModel: description: Configuration Launcher Settings properties: checkInSecretOnLastLauncherClose: description: Forces Check In of Secret when user closes their only active launcher. type: boolean nullable: true closeLauncherOnCheckInSecret: description: When Secret is Checked In, all active launchers associated with it will close. type: boolean nullable: true enableDomainDownload: description: Allow the user to download existing and tested mappings from Thycotic.com. type: boolean enableDomainUpload: description: Allow the user to upload mappings type: boolean enableLauncher: description: Enable Launcher type: boolean enableLauncherAutoUpdate: description: Enable Launcher Auto Update type: boolean enableWebParsing: description: Allow Secret Server to retrieve and parse the mapped website when using the web launcher. type: boolean launcherDeploymentType: description: Launcher Deployment Type type: string nullable: true sendSecretUrlToLauncher: description: Send the URL that is on the Secret to the web password launcher in addition to the bookmarklet type: boolean type: object UpdateFieldValueOfOptionalDateTimeOffset: description: When should be global banner stop displaying to users properties: dirty: description: Dirty type: boolean value: $ref: '#/components/schemas/OptionalDateTimeOffset' type: object UpdateFieldValueOfSyslogCefTimeZoneType: description: Time Zone to use when sending Syslog/CEF Protocol log entries properties: dirty: description: Dirty type: boolean value: $ref: '#/components/schemas/SyslogCefTimeZoneType' type: object ConfigurationEmailModel: description: Outgoing email server configuration properties: fromEmailAddress: description: All emails will be sent from this address type: string fromEmailName: description: This is the 'From' friendly name for emails that are sent. It can be left empty. type: string sendLegacyEmails: description: Send Legacy Emails type: boolean nullable: true smtpCheckCertificateRevocation: description: Check Certificate Revocation when in Implicit SSL Connection Mode type: boolean nullable: true smtpDomain: description: SMTP user domain type: string smtpPassword: description: SMTP user password type: string smtpPort: description: Custom port, otherwise the default type: integer format: int32 nullable: true smtpServer: description: The resolvable and reachable host name for the outgoing SMTP server type: string smtpUseCredentials: description: true if credentials are set, false if anonymous type: boolean nullable: true smtpUseImplicitSSL: description: Implicit SSL Connection Mode type: boolean nullable: true smtpUserName: description: SMTP user name type: string smtpUseSSL: description: Use SSL to connect type: boolean nullable: true type: object ConfigurationSshCommandImportModel: description: SSH Commands configuration properties: sshCommandBlocklists: description: SshCommandBlocklists items: $ref: '#/components/schemas/SshCommandBlocklistPatchModel' type: array sshCommandMenuMaps: description: SshCommandMenuMaps items: $ref: '#/components/schemas/ConfigurationSshCommandMenuMapModel' type: array sshCommandMenus: description: SshCommandMenus items: $ref: '#/components/schemas/ConfigurationSshCommandMenuModel' type: array sshCommands: description: SshCommands items: $ref: '#/components/schemas/SshCommandPatchModel' type: array type: object SecretServerSettingsImportResultModel: description: Secret Server Settings import results properties: errors: $ref: '#/components/schemas/DictionaryOfStringAndString' secretServerSettings: $ref: '#/components/schemas/SecretServerSettingsModel' warnings: $ref: '#/components/schemas/DictionaryOfStringAndString' type: object ConfigurationSessionRecordingModel: description: Session Recording Configuration properties: archiveLocationBySite: description: If archive location changes based on site type: boolean nullable: true archivePath: description: The location of the recordings stored on disk type: string archivePathMappings: description: A list of archive paths mapped to sites, used when ArchiveLocationBySite is true items: $ref: '#/components/schemas/ConfigurationSessionRecordingSiteArchiveSummary' type: array daysUntilArchive: description: The number of days until a recording is archived type: integer format: int32 nullable: true daysUntilDelete: description: The number of days before a session recording is deleted type: integer format: int32 nullable: true enableArchive: description: If recordings should be archived type: boolean nullable: true enableDelete: description: If session recordings will be automatically deleted type: boolean enableHardwareAcceleration: description: If hardware acceleration should be enabled type: boolean nullable: true enableInactivityTimeout: description: If sessions should end if inactive type: boolean enableOnDemandVideoProcessing: description: If on demand video processing should be available type: boolean enableSessionRecording: description: Whether or not Session Recording is enabled type: boolean encryptArchive: description: If archived session recordings should be encrypted type: boolean hideRecordingIndicator: description: If the recording indicator should be shown type: boolean inactivityTimeoutMinutes: description: The length of inactivity before the session is ended type: integer format: int32 nullable: true maxSessionLength: description: The longest a session is allowed to be in hours type: integer format: int32 rdpProxyRecordKeyStrokes: description: If proxied RDP sessions should have keystrokes recorded type: boolean nullable: true rdpProxyRecordVideo: description: If proxied RDP sessions should have video recorded type: boolean nullable: true sshProxyRecordKeyStrokes: description: If proxied SSH sessions should have keystrokes recorded type: boolean nullable: true sshProxyRecordVideo: description: If proxied SSH sessions should have video recorded type: boolean nullable: true storeInDatabase: description: If session recordings should be stored in the database type: boolean nullable: true useTemporaryArchives: description: If the archive location should store temporary session recording data instead of the database type: boolean videoCodecId: description: Which video codec to use for session recordings on OSX type: integer format: int32 nullable: true type: object SecretServerSettingsQuery: description: Filter properties: loadAdvancedSettings: description: LoadAdvancedSettings type: boolean loadAll: description: LoadAll type: boolean loadApplicationSettings: description: LoadApplicationSettings type: boolean loadEmail: description: LoadEmail type: boolean loadFolderSettings: description: LoadFolderSettings type: boolean loadLauncherSettings: description: LoadLauncherSettings type: boolean loadLicenses: description: LoadLicenses type: boolean loadLocalUserPasswords: description: LoadLocalUserPasswords type: boolean loadLogin: description: LoadLogin type: boolean loadPermissionOptions: description: LoadPermissionOptions type: boolean loadProtocolHandlerSettings: description: LoadProtocolHandlerSettings type: boolean loadSaml: description: LoadSaml type: boolean loadSecurity: description: LoadSecurity type: boolean loadSessionRecording: description: LoadSessionRecording type: boolean loadSshCommands: description: LoadSshCommands type: boolean loadTicketSystem: description: LoadTicketSystem type: boolean loadUserExperience: description: LoadUserExperience type: boolean loadUserInterface: description: LoadUserInterface type: boolean type: object ConfigurationLoginTwoFactorRadiusPatchModel: description: RADIUS Two Factor Login Configuration properties: attemptSilentAuth: $ref: '#/components/schemas/UpdateFieldValueOfInt32' clientPortRange: $ref: '#/components/schemas/UpdateFieldValueOfString' defaultUsername: $ref: '#/components/schemas/UpdateFieldValueOfString' disableNasIpAddressAttribute: $ref: '#/components/schemas/UpdateFieldValueOfOptionalBoolean' enable: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' enableFailoverServer: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' enableRadiusNasId: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' failoverServerIP: $ref: '#/components/schemas/UpdateFieldValueOfString' failoverServerPort: $ref: '#/components/schemas/UpdateFieldValueOfInt32' failoverSharedSecret: $ref: '#/components/schemas/UpdateFieldValueOfString' failoverTimeoutSeconds: $ref: '#/components/schemas/UpdateFieldValueOfInt32' loginExplanation: $ref: '#/components/schemas/UpdateFieldValueOfString' nasId: $ref: '#/components/schemas/UpdateFieldValueOfString' protocol: $ref: '#/components/schemas/UpdateFieldValueOfInt32' serverIP: $ref: '#/components/schemas/UpdateFieldValueOfString' serverPort: $ref: '#/components/schemas/UpdateFieldValueOfInt32' sharedSecret: $ref: '#/components/schemas/UpdateFieldValueOfString' sharedSecretSameForAllUsers: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' silentAnswerValue: $ref: '#/components/schemas/UpdateFieldValueOfString' timeoutSeconds: $ref: '#/components/schemas/UpdateFieldValueOfInt32' type: object InternalServerErrorResponse: description: Response object for internal server errors required: - message - exceptionMessage - exceptionType - stackTrace properties: message: description: Error message type: string exceptionMessage: description: Error message from exception type: string exceptionType: description: Exception type type: string stackTrace: description: Exception stack trace type: string type: object UpdateFieldValueOfGuid: description: The Current Multifactor Authentication Profile that is being used by Secret Server properties: dirty: description: Dirty type: boolean value: description: Value type: string format: uuid type: object ViewFieldValueOfConfigurationFoldersModel: description: Folder configuration properties: additionalLinks: description: AdditionalLinks items: $ref: '#/components/schemas/ViewFieldLink' type: array description: description: Description type: string fieldInputType: description: FieldInputType type: string nullable: true hasHistory: description: HasHistory type: boolean nullable: true helpLink: description: HelpLink type: string helpLinkText: description: HelpLinkText type: string hidden: description: Hidden type: boolean nullable: true hideOnView: description: HideOnView type: boolean nullable: true isRequired: description: IsRequired type: boolean nullable: true label: description: Label type: string maxLength: description: MaxLength type: integer format: int32 nullable: true name: description: Name type: string placeholder: description: Placeholder type: string readOnly: description: ReadOnly type: boolean nullable: true readOnlyReason: description: ReadOnlyReason type: string sortOrder: description: SortOrder type: integer format: int32 nullable: true value: $ref: '#/components/schemas/ConfigurationFoldersModel' type: object SyslogCefDateTimeFormatType: description: Value properties: {} type: string enum: - Syslog - ISO8601 ConfigurationTicketSystemModel: description: List of Ticket Systems properties: ticketSystemList: description: List of Ticket Systems items: $ref: '#/components/schemas/TicketSystemModelV2' type: array warnings: $ref: '#/components/schemas/DictionaryOfStringAndString' type: object ConfigurationUserInterfacePatchModel: description: Update user interface configuration properties: allowUserToSelectTheme: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' customBannerEndDate: $ref: '#/components/schemas/UpdateFieldValueOfOptionalDateTimeOffset' customBannerStartDate: $ref: '#/components/schemas/UpdateFieldValueOfOptionalDateTimeOffset' customBannerStyle: $ref: '#/components/schemas/UpdateFieldValueOfString' customBannerText: $ref: '#/components/schemas/UpdateFieldValueOfString' customBannerViewLink: $ref: '#/components/schemas/UpdateFieldValueOfString' customBannerViewLinkText: $ref: '#/components/schemas/UpdateFieldValueOfString' customLogoCollapsed: $ref: '#/components/schemas/UpdateFieldValueOfString' customLogoCollapsedDark: $ref: '#/components/schemas/UpdateFieldValueOfString' customLogoFullSize: $ref: '#/components/schemas/UpdateFieldValueOfString' customLogoFullSizeDark: $ref: '#/components/schemas/UpdateFieldValueOfString' customLogoLogin: $ref: '#/components/schemas/UpdateFieldValueOfString' customLogoLoginDark: $ref: '#/components/schemas/UpdateFieldValueOfString' defaultClassicTheme: $ref: '#/components/schemas/UpdateFieldValueOfString' disableLegacyUi: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' isCustomBannerDismissable: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' newUiDefault: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' showCustomBanner: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' type: object ExportFileType: description: Export Job File Type properties: {} type: string enum: - Csv - Xml - Json UpdateFieldValueOfOptionalBoolean: description: Use RADIUS Username for DUO properties: dirty: description: Dirty type: boolean value: description: Value type: boolean nullable: true type: object ViewFieldValueOfConfigurationSessionRecordingModel: description: Session Recording configuration properties: additionalLinks: description: AdditionalLinks items: $ref: '#/components/schemas/ViewFieldLink' type: array description: description: Description type: string fieldInputType: description: FieldInputType type: string nullable: true hasHistory: description: HasHistory type: boolean nullable: true helpLink: description: HelpLink type: string helpLinkText: description: HelpLinkText type: string hidden: description: Hidden type: boolean nullable: true hideOnView: description: HideOnView type: boolean nullable: true isRequired: description: IsRequired type: boolean nullable: true label: description: Label type: string maxLength: description: MaxLength type: integer format: int32 nullable: true name: description: Name type: string placeholder: description: Placeholder type: string readOnly: description: ReadOnly type: boolean nullable: true readOnlyReason: description: ReadOnlyReason type: string sortOrder: description: SortOrder type: integer format: int32 nullable: true value: $ref: '#/components/schemas/ConfigurationSessionRecordingModel' type: object UpdateFieldValueOfGuidArray: description: SshCommandIds properties: dirty: description: Dirty type: boolean value: description: Value items: type: string format: uuid type: array type: object UpdateFieldValueOfForceRequireTicketSystemOptions: description: Ticket System Comment and/or Number Requirement properties: dirty: description: Dirty type: boolean value: $ref: '#/components/schemas/ForceRequireTicketSystemOptions' type: object ConfigurationSamlIdentityProviderModel: description: SAML Identity Provider configuration properties: active: description: Active status of the Identity Provider. Users can only log-in via an active Identity Provider. type: boolean authnContext: description: When specified, instructs the IDP on how to authenticate the user(optional). type: string clockSkew: description: The allowed number of minutes of difference between Secret Server's clock and the IDP's clock. The default is 3 minutes. type: integer format: int32 description: description: Description of the Identity Provider. type: string disableAssertionReplayCheck: description: When true, SAML messages that were already received from this IDP will be allowed by Secret Server. Otherwise, resending messages from the IDP will trigger an error. type: boolean disableAudienceRestrictionCheck: description: A SAML assertion may include an audience restriction URI. This identifies the intended recipient of the SAML assertion. If included it should match the service provider's name. When this setting is true, this check is skipped. type: boolean disableAuthnContextCheck: description: Disables the authentication context check, which validates that the real authentication method matches the ExpectedAuthnContext method. type: boolean disableDestinationCheck: description: When true, the destination URI in the SAML response will not be validated. type: boolean disableInboundLogout: description: When true, logout requests coming from this IDP are ignored. type: boolean disableInResponseToCheck: description: When true, the InResponseTo attribute in SAML messages is not checked. type: boolean disablePendingLogoutCheck: description: When true, a SAML logout response will be considered legitimate even if there was no corresponding logout request. type: boolean disableRecipientCheck: description: When true, the built-in check against the AssertionConsumerService URL will be skipped. type: boolean disableTimePeriodCheck: description: When true, a SAML response is valid regardless of when it was sent. type: boolean displayName: description: The Display Name for the Identity Provider. type: string domainAttribute: description: Optional AttributeName to use for matching a Secret Server user's domain. type: string enableDetailedLog: description: When true, a more detailed log will be generated for SAML logins and logouts. type: boolean enableSLO: description: When true, logging out of Secret Server will log the user out of this Identity Provider. type: boolean forceAuthentication: description: When true, the Identity Provider will be instructed to re-authenticate the user, even if they are already authenticated. type: boolean identityProviderId: description: SAML Identity Provider Id type: integer format: int32 logoutRequestLifeTime: description: The logout request life time. type: integer format: int32 name: description: Name of the Identity Provider. type: string overridePendingAuthnRequest: description: When true, an in-progress SP-initiated login may be interrupted by an IDP-initiated login. type: boolean publicCertificate: description: The public certificate for the Identity Provider. Base64 encoded type: string publicCertificateThumbprint: description: The public certificate thumbprint type: string signAuthnRequest: description: When true, the authentication requests sent to this IDP will be signed. type: boolean signLogoutRequest: description: When true, logout requests sent to this IDP will be signed.< type: boolean signLogoutResponse: description: When true, logout responses sent to this IDP will be signed. type: boolean singleLogoutServiceResponseUrl: description: The URL where Secret Server will send responses to single logout messages. type: string singleLogoutServiceUrl: description: The URL to send the single logout message to. type: string ssoServiceBinding: description: Method for communicating with the Identity Provider. HTTPRedirect is recommended in most cases. type: integer format: int32 ssoServiceUrl: description: The URL of the Identity Provider where the user will be sent to authenticate. type: string usernameAttribute: description: Optional AttributeName to use for matching a Secret Server user. type: string wantAssertionEncrypted: description: When true, Secret Server will expect SAML assertions from this IDP to be encrypted. Unencrypted assertions or assertions that cannot be decrypted will cause an error. type: boolean wantAssertionOrResponseSigned: description: When true, Secret Server will expect either SAML assertions or SAML responses from this IDP to be signed. Unsigned assertions/responses and assertions/responses whose signatures cannot be verified will cause an error. type: boolean wantAssertionSigned: description: When true, Secret Server will expect SAML assertions from this IDP to be signed. Unsigned assertions or assertions whose signatures cannot be verified will cause an error. type: boolean wantLogoutRequestSigned: description: When true, Secret Server will expect logout requests from this IDP to be signed. Unsigned responses or responses whose signatures cannot be verified will cause an error. type: boolean wantLogoutResponseSigned: description: When true, Secret Server will expect logout responses from this IDP to be signed. Unsigned responses or responses whose signatures cannot be verified will cause an error. type: boolean wantSAMLResponseSigned: description: When true, Secret Server will expect SAML responses from this IDP to be signed. Unsigned responses or responses whose signatures cannot be verified will cause an error. type: boolean type: object ConfigurationSessionRecordingPatchModel: description: Update session recording configuration properties: archiveLocationBySite: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' archivePath: $ref: '#/components/schemas/UpdateFieldValueOfString' archivePathMappings: $ref: '#/components/schemas/UpdateFieldValueOfConfigurationSessionRecordingSiteArchiveUpdateModelArray' daysUntilArchive: $ref: '#/components/schemas/UpdateFieldValueOfInt32' daysUntilDelete: $ref: '#/components/schemas/UpdateFieldValueOfInt32' enableArchive: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' enableDelete: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' enableHardwareAcceleration: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' enableInactivityTimeout: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' enableOnDemandVideoProcessing: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' enableSessionRecording: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' encryptArchive: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' hideRecordingIndicator: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' inactivityTimeoutMinutes: $ref: '#/components/schemas/UpdateFieldValueOfInt32' maxSessionLength: $ref: '#/components/schemas/UpdateFieldValueOfInt32' rdpProxyRecordKeyStrokes: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' rdpProxyRecordVideo: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' sshProxyRecordKeyStrokes: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' sshProxyRecordVideo: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' storeInDatabase: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' useTemporaryArchives: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' videoCodecId: $ref: '#/components/schemas/UpdateFieldValueOfInt32' type: object ViewFieldValueOfConfigurationApplicationSettingsModel: description: Application Settings configuration properties: additionalLinks: description: AdditionalLinks items: $ref: '#/components/schemas/ViewFieldLink' type: array description: description: Description type: string fieldInputType: description: FieldInputType type: string nullable: true hasHistory: description: HasHistory type: boolean nullable: true helpLink: description: HelpLink type: string helpLinkText: description: HelpLinkText type: string hidden: description: Hidden type: boolean nullable: true hideOnView: description: HideOnView type: boolean nullable: true isRequired: description: IsRequired type: boolean nullable: true label: description: Label type: string maxLength: description: MaxLength type: integer format: int32 nullable: true name: description: Name type: string placeholder: description: Placeholder type: string readOnly: description: ReadOnly type: boolean nullable: true readOnlyReason: description: ReadOnlyReason type: string sortOrder: description: SortOrder type: integer format: int32 nullable: true value: $ref: '#/components/schemas/ConfigurationApplicationSettingsModel' type: object ConfigurationSshCommandExportModel: description: SSH Command configuration properties: sshCommandBlocklists: description: SshCommandBlocklists items: $ref: '#/components/schemas/SshCommandBlocklistModel' type: array sshCommandMenuMaps: description: SshCommandMenuMaps items: $ref: '#/components/schemas/ConfigurationSshCommandMenuMapModel' type: array sshCommandMenus: description: SshCommandMenus items: $ref: '#/components/schemas/ConfigurationSshCommandMenuModel' type: array sshCommands: description: SshCommands items: $ref: '#/components/schemas/SshCommandModel' type: array type: object UpdateFieldValueOfPersonalFolderNameOptionType: description: The format for the personal folder name for each user properties: dirty: description: Dirty type: boolean value: $ref: '#/components/schemas/PersonalFolderNameOptionType' type: object ConfigurationSshCommandMenuMapModel: description: SshCommandMenuMaps properties: sortOrder: description: SortOrder type: integer format: int32 sshCommandGuid: description: SshCommandGuid type: string format: uuid sshCommandMenuGuid: description: SshCommandMenuGuid type: string format: uuid type: object ConfigurationFoldersPatchModel: description: Update folder configuration properties: enablePersonalFolders: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' personalFolderName: $ref: '#/components/schemas/UpdateFieldValueOfString' personalFolderNameOption: $ref: '#/components/schemas/UpdateFieldValueOfPersonalFolderNameOptionType' personalFolderWarning: $ref: '#/components/schemas/UpdateFieldValueOfString' requireViewFolderPermission: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' showPersonalFolderWarning: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' type: object SshCommandModel: description: SSH Command properties: command: description: SSH command type: string commandPermissionType: $ref: '#/components/schemas/CommandPermissionType' name: description: SSH command name type: string sortOrder: description: Sort order type: integer format: int32 nullable: true sshCommandGuid: description: SSH command Guid type: string format: uuid sshCommandId: description: SSH command ID type: integer format: int32 type: object securitySchemes: BearerToken: type: apiKey description: 'Perform a POST request to `/oauth2/token`. It should include three form data parameters - `username`, `password`, and `grant_type`.The `grant_type` parameter should always have the value `password`.The access token returned should be included in the header of subsequent requests, like ''Authorization: Bearer token''. The token remains valid for a time period returned in the ''expires_in'' property (in seconds). For details, see the token request documentation.' name: Authorization in: header