openapi: 3.0.0
info:
title: Secret Server Rest Activations Configuration 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: Configuration
description: Secret Server Configuration
paths:
/v1/configuration/saml/identity-provider/{id}:
get:
tags:
- Configuration
summary: Get Saml Identity Provider configuration
description: Get Saml Identity Provider Configuration
operationId: ConfigurationService_GetSamlIdentityProviderConfiguration
parameters:
- name: id
in: path
description: Saml Identity Provider Id
required: true
schema:
type: integer
format: int32
responses:
'200':
description: Saml Identity Provider configuration
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigurationSamlIdentityProviderModel'
'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
delete:
tags:
- Configuration
summary: Delete Saml Configuration Identity Provider
description: Delete Saml Configuration Identity Provider
operationId: ConfigurationService_DeleteSamlConfigurationIdentityProvider
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int32
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigurationSamlIdentityProviderDeleteResultModel'
'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/configuration/state:
get:
tags:
- Configuration
summary: The allowed permissions for configuration for the current user
description: The allowed permissions for configuration for the current user
operationId: ConfigurationService_GetConfigurationState
responses:
'200':
description: The allowed configuration for the current user
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigurationStateModel'
'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/configuration/audit:
get:
tags:
- Configuration
summary: Audit of system configuration changes
description: Audit of system configuration changes
operationId: ConfigurationService_GetConfigurationAudit
parameters:
- name: isExporting
in: query
description: isExporting
required: false
schema:
type: boolean
- name: filter.searchTerm
in: query
description: SearchTerm
required: false
schema:
type: string
- name: skip
in: query
description: Number of records to skip before taking results
required: false
schema:
type: integer
format: int32
- name: sortBy[0].direction
in: query
description: Sort direction
required: false
schema:
type: string
- name: sortBy[0].name
in: query
description: Sort field name
required: false
schema:
type: string
- name: sortBy[0].priority
in: query
description: Priority index. Sorts with lower values are executed earlier
required: false
schema:
type: integer
format: int32
- name: take
in: query
description: Maximum number of records to include in results
required: false
schema:
type: integer
format: int32
responses:
'200':
description: Configuration audit items
content:
application/json:
schema:
$ref: '#/components/schemas/PagingOfConfigurationAuditItem'
'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
/v3/configuration/general:
get:
tags:
- Configuration
summary: Get the general configuration
description: Get configuration
operationId: ConfigurationService_GetGeneralConfigurationV3
parameters:
- name: loadAll
in: query
description: Load all configuration sections
required: false
schema:
type: boolean
- name: loadApplicationSettings
in: query
description: Load application settings section
required: false
schema:
type: boolean
- name: loadEmail
in: query
description: Load email section
required: false
schema:
type: boolean
- name: loadFolders
in: query
description: Load folder configuration section
required: false
schema:
type: boolean
- name: loadLauncherSettings
in: query
description: Load launcher settings section
required: false
schema:
type: boolean
- name: loadLocalUserPasswords
in: query
description: Load local user passwords section
required: false
schema:
type: boolean
- name: loadLogin
in: query
description: Load log in section
required: false
schema:
type: boolean
- name: loadPermissionOptions
in: query
description: Load permission options configuration section
required: false
schema:
type: boolean
- name: loadProtocolHandlerSettings
in: query
description: Load security protocol hander section
required: false
schema:
type: boolean
- name: loadSecurity
in: query
description: Load security section
required: false
schema:
type: boolean
- name: loadSessionRecording
in: query
description: Load the session recording section
required: false
schema:
type: boolean
- name: loadUnlimitedAdmin
in: query
description: Load unlimited admin section
required: false
schema:
type: boolean
- name: loadUserExperience
in: query
description: Load user experience configuration section
required: false
schema:
type: boolean
- name: loadUserInterface
in: query
description: Load user interface section
required: false
schema:
type: boolean
responses:
'200':
description: Configuration
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigurationGeneralModelV3'
'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/configuration/settings-menu:
get:
tags:
- Configuration
summary: Get settings menu
description: Get settings needed to build the admin settings menu
operationId: ConfigurationService_GetSettingsMenu
responses:
'200':
description: Settings menu options
content:
application/json:
schema:
$ref: '#/components/schemas/SettingsMenuModel'
'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/configuration/local-user-passwords:
get:
tags:
- Configuration
summary: Get the local user password configuration
description: Get the local user password configuration. Password requirements only require an authenticated user. Extended fields will be null unless you have the View / Administer Configuration role permission.
operationId: ConfigurationService_GetLocalPasswordConfiguration
responses:
'200':
description: Local User Password Configuration Settings
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigurationLocalUserPasswordsModel'
'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
patch:
tags:
- Configuration
summary: Update the local user password configuration
description: Update the local user password configuration
operationId: ConfigurationService_PatchLocalPasswordConfiguration
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigurationLocalPasswordPatchArgs'
description: Local user password update args
responses:
'200':
description: Local User Password Configuration Settings
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigurationLocalUserPasswordsModel'
'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/configuration/security:
get:
tags:
- Configuration
summary: Get Security configuration
description: Get Security Configuration
operationId: ConfigurationService_GetSecurityConfiguration
responses:
'200':
description: Security Configuration
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigurationSecurityModel'
'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
patch:
tags:
- Configuration
summary: Update Security configuration
description: Update Security Configuration
operationId: ConfigurationService_PatchSecurityConfiguration
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigurationSecurityPatchArgs'
description: Security update args
responses:
'200':
description: Security configuration after updates
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigurationSecurityModel'
'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
/v2/configuration/login:
get:
tags:
- Configuration
summary: Get Login configuration
description: Get Login Configuration
operationId: ConfigurationService_GetLoginConfigurationV2
responses:
'200':
description: Login Configuration
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigurationLoginV2Model'
'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
patch:
tags:
- Configuration
summary: Update Login configuration
description: Update Login Configuration
operationId: ConfigurationService_PatchLoginConfigurationV2
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigurationLoginV2PatchArgs'
description: Login update args
responses:
'200':
description: Login configuration after updates
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigurationLoginV2Model'
'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/configuration/login-policy:
get:
tags:
- Configuration
summary: Get Login Policy configuration
description: Get Login Policy Configuration
operationId: ConfigurationService_GetLoginPolicyConfiguration
responses:
'200':
description: Login Policy Configuration
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigurationLoginPolicyModel'
'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
patch:
tags:
- Configuration
summary: Update Login Policy configuration
description: Update Login Policy Configuration
operationId: ConfigurationService_PatchLoginPolicyConfiguration
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigurationLoginPolicyPatchArgs'
description: Login Policy update args
responses:
'200':
description: Login Policy configuration after updates
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigurationLoginPolicyModel'
'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/configuration/saml:
get:
tags:
- Configuration
summary: Get Saml configuration
description: Get Saml Configuration
operationId: ConfigurationService_GetSamlConfiguration
responses:
'200':
description: Saml Configuration
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigurationSamlModel'
'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
patch:
tags:
- Configuration
summary: Update Saml configuration
description: Update Saml Configuration
operationId: ConfigurationService_PatchSamlConfiguration
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigurationSamlPatchArgs'
description: Saml update args
responses:
'200':
description: Saml configuration after updates
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigurationSamlModel'
'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/configuration/folder-synchronization:
get:
tags:
- Configuration
summary: Get folder synchronization configuration
description: Get the settings for how folders are synchronized with an external system
operationId: ConfigurationService_GetFolderSyncConfiguration
responses:
'200':
description: Folder synchronization configuration
content:
application/json:
schema:
$ref: '#/components/schemas/FolderSynchronizationModel'
'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
patch:
tags:
- Configuration
summary: Update folder synchronization configuration
description: Update the settings for how folders are synchronized with an external system
operationId: ConfigurationService_PatchFolderSyncConfiguration
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/FolderSynchronizationUpdateArgs'
description: Saml update args
responses:
'200':
description: Folder synchronization configuration after updates
content:
application/json:
schema:
$ref: '#/components/schemas/FolderSynchronizationModel'
'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/configuration/saml/identity-provider/stub:
get:
tags:
- Configuration
summary: Get Saml Identity Provider configuration stub
description: Get Saml Identity Provider Configuration stub
operationId: ConfigurationService_GetSamlIdentityProviderConfigurationStub
responses:
'200':
description: Saml Identity Provider configuration
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigurationSamlIdentityProviderModel'
'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/configuration/rpc:
get:
tags:
- Configuration
summary: Get RPC configuration
description: Get Remote Password Configuration
operationId: ConfigurationService_GetRpcConfiguration
responses:
'200':
description: RPC Configuration
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigurationRpcModel'
'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
patch:
tags:
- Configuration
summary: Update RPC configuration
description: Update Remote Password Configuration
operationId: ConfigurationService_PatchRpcConfiguration
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigurationRpcPatchArgs'
description: Local user password update args
responses:
'200':
description: RPC configuration after updates
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigurationRpcModel'
'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/configuration/sessionrecording-advanced:
get:
tags:
- Configuration
summary: Get Session Recording Advanced
description: Get Session Recording Advanced Configuration
operationId: ConfigurationService_GetSessionRecordingAdvancedConfiguration
responses:
'200':
description: Session Recording Advanced Configuration
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigurationSessionRecordingAdvancedModel'
'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
patch:
tags:
- Configuration
summary: Update Session Recording Advanced
description: Update Session Recording Advanced Configuration
operationId: ConfigurationService_PatchSessionRecordingAdvancedConfiguration
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigurationSessionRecordingAdvancedPatchArgs'
description: Session recording advanced update args
responses:
'200':
description: Session Recording Advanced Configuration
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigurationSessionRecordingAdvancedModel'
'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/configuration/site-connector:
get:
tags:
- Configuration
summary: Site Connectors
description: Site Connectors
operationId: ConfigurationService_GetSiteConnectors
parameters:
- name: includeInactive
in: query
description: includeInactive
required: false
schema:
type: boolean
responses:
'200':
description: Site Connectors
content:
application/json:
schema:
description: Site Connectors
items:
$ref: '#/components/schemas/SiteConnectorsSummaryModel'
type: array
'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/configuration/internal-site-connector:
get:
tags:
- Configuration
summary: Internal Site Connector Configuration
description: Internal Site Connector Configuration
operationId: ConfigurationService_GetInternalSiteConfiguration
responses:
'200':
description: Internal Site Connector Configuration
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigurationInternalSiteConnectorModel'
'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
patch:
tags:
- Configuration
summary: Update Internal Site Connector
description: Update Internal Site Connector
operationId: ConfigurationService_PatchInternalSiteConfiguration
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigurationInternalSiteConnectorPatchArgs'
description: Internal Site Connector Update Options
responses:
'200':
description: Internal Site Connector Configuration
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigurationInternalSiteConnectorModel'
'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/configuration/unlimited-admin:
get:
tags:
- Configuration
summary: Get Unlimited Admin
description: Get Unlimited Admin
operationId: ConfigurationService_GetUnlimitedAdmin
responses:
'200':
description: The value of unlimited admin
content:
application/json:
schema:
$ref: '#/components/schemas/UnlimitedAdminModel'
'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
patch:
tags:
- Configuration
summary: Update Unlimited Admin
description: Update Unlimited Admin
operationId: ConfigurationService_UpdateUnlimitedAdmin
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UnlimitedAdminUpdateArgs'
description: Unlimited Admin Update Options
responses:
'200':
description: Success
content:
application/json:
schema:
description: Boolean
type: boolean
'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/configuration/unlimited-admin/audit:
get:
tags:
- Configuration
summary: Get unlimited admin configuration audits
description: Audit records for unlimited admin configuration changes
operationId: ConfigurationService_GetAuditUnlimitedAdmin
parameters:
- name: isExporting
in: query
description: isExporting
required: false
schema:
type: boolean
- name: skip
in: query
description: Number of records to skip before taking results
required: false
schema:
type: integer
format: int32
- name: sortBy[0].direction
in: query
description: Sort direction
required: false
schema:
type: string
- name: sortBy[0].name
in: query
description: Sort field name
required: false
schema:
type: string
- name: sortBy[0].priority
in: query
description: Priority index. Sorts with lower values are executed earlier
required: false
schema:
type: integer
format: int32
- name: take
in: query
description: Maximum number of records to include in results
required: false
schema:
type: integer
format: int32
responses:
'200':
description: Audit records for unlimited admin configuration changes
content:
application/json:
schema:
$ref: '#/components/schemas/PagingOfAdminAuditItem'
'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/configuration/secret-search-indexer:
get:
tags:
- Configuration
summary: Secret Search Indexer Configuration
description: Secret Search Indexer Configuration
operationId: ConfigurationService_GetSecretSearchIndexerConfiguration
responses:
'200':
description: Secret Search Indexer Configuration
content:
application/json:
schema:
$ref: '#/components/schemas/SearchIndexerModel'
'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
patch:
tags:
- Configuration
summary: Update Secret Search Indexer Configuration
description: Update Secret Search Indexer Configuration
operationId: ConfigurationService_PatchSecretSearchIndexerConfiguration
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SearchIndexerUpdateArgs'
description: Secret Search Indexer Configuration Update Settings
responses:
'200':
description: Updated Secret Search Indexer Configuration
content:
application/json:
schema:
$ref: '#/components/schemas/SearchIndexerModel'
'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/configuration/platform:
get:
tags:
- Configuration
summary: Get Platform Configuration
description: Retrieve the settings and descriptions for the Platform configuration view model.
operationId: ConfigurationService_GetPlatformConfiguration
responses:
'200':
description: Platform Configuration
content:
application/json:
schema:
$ref: '#/components/schemas/PlatformConfigurationModel'
'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
patch:
tags:
- Configuration
summary: Patch Platform Configuration
description: Patch Platform Configuration by sending one or more fields with dirty set to true. This will return the actual updated view model.
operationId: ConfigurationService_PatchPlatformConfiguration
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PlatformConfigurationArgs'
description: Platform Update Settings
responses:
'200':
description: Updated Platform Configuration
content:
application/json:
schema:
$ref: '#/components/schemas/PlatformConfigurationModel'
'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/configuration/platform-audits:
get:
tags:
- Configuration
summary: Get Platform Configuration Audits
description: Retrieve the audits for the Platform configuration.
operationId: ConfigurationService_GetPlatformConfigurationAudits
parameters:
- name: isExporting
in: query
description: isExporting
required: false
schema:
type: boolean
- name: skip
in: query
description: Number of records to skip before taking results
required: false
schema:
type: integer
format: int32
- name: sortBy[0].direction
in: query
description: Sort direction
required: false
schema:
type: string
- name: sortBy[0].name
in: query
description: Sort field name
required: false
schema:
type: string
- name: sortBy[0].priority
in: query
description: Priority index. Sorts with lower values are executed earlier
required: false
schema:
type: integer
format: int32
- name: take
in: query
description: Maximum number of records to include in results
required: false
schema:
type: integer
format: int32
responses:
'200':
description: Platform Configuration Audits
content:
application/json:
schema:
$ref: '#/components/schemas/PagingOfPlatformConfigurationAuditViewModel'
'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/configuration/auto-export:
get:
tags:
- Configuration
summary: Get Automatic Export Configuration
description: Retrieve the settings and descriptions for the automatic export configuration view model.
operationId: ConfigurationService_GetAutoExportConfiguration
responses:
'200':
description: Automatic Export Configuration
content:
application/json:
schema:
$ref: '#/components/schemas/AutoExportConfigurationModel'
'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
patch:
tags:
- Configuration
summary: Patch Automatic Export Configuration
description: Patch Automatic Export Configuration by sending one or more fields with dirty set to true. This will return the actual updated view model.
operationId: ConfigurationService_PatchAutomaticExportConfiguration
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AutoExportConfigurationArgs'
description: Automatic Export Update Settings
responses:
'200':
description: Updated Automatic Export Configuration
content:
application/json:
schema:
$ref: '#/components/schemas/AutoExportConfigurationModel'
'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/configuration/auto-export-audits:
get:
tags:
- Configuration
summary: Get Automatic Export Configuration Audits
description: Retrieve the audits for the automatic export configuration.
operationId: ConfigurationService_GetAutoExportConfigurationAudits
parameters:
- name: isExporting
in: query
description: isExporting
required: false
schema:
type: boolean
- name: skip
in: query
description: Number of records to skip before taking results
required: false
schema:
type: integer
format: int32
- name: sortBy[0].direction
in: query
description: Sort direction
required: false
schema:
type: string
- name: sortBy[0].name
in: query
description: Sort field name
required: false
schema:
type: string
- name: sortBy[0].priority
in: query
description: Priority index. Sorts with lower values are executed earlier
required: false
schema:
type: integer
format: int32
- name: take
in: query
description: Maximum number of records to include in results
required: false
schema:
type: integer
format: int32
responses:
'200':
description: Automatic Export Configuration Audits
content:
application/json:
schema:
$ref: '#/components/schemas/PagingOfAutoExportConfigurationAuditViewModel'
'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/configuration/auto-export-logs:
get:
tags:
- Configuration
summary: Get Automatic Export Logs
description: Retrieve the logs for the automatic exports.
operationId: ConfigurationService_GetAutoExportLogs
parameters:
- name: skip
in: query
description: Number of records to skip before taking results
required: false
schema:
type: integer
format: int32
- name: sortBy[0].direction
in: query
description: Sort direction
required: false
schema:
type: string
- name: sortBy[0].name
in: query
description: Sort field name
required: false
schema:
type: string
- name: sortBy[0].priority
in: query
description: Priority index. Sorts with lower values are executed earlier
required: false
schema:
type: integer
format: int32
- name: take
in: query
description: Maximum number of records to include in results
required: false
schema:
type: integer
format: int32
responses:
'200':
description: Automatic Export Logs
content:
application/json:
schema:
$ref: '#/components/schemas/PagingOfAutoExportLogViewModel'
'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/configuration/auto-export-storage:
get:
tags:
- Configuration
summary: Get Automatic Export Storage Items
description: Retrieves a list of the items in automatic export storage.
operationId: ConfigurationService_GetAutoExportStorageItemsDefault
parameters:
- name: skip
in: query
description: Number of records to skip before taking results
required: false
schema:
type: integer
format: int32
- name: sortBy[0].direction
in: query
description: Sort direction
required: false
schema:
type: string
- name: sortBy[0].name
in: query
description: Sort field name
required: false
schema:
type: string
- name: sortBy[0].priority
in: query
description: Priority index. Sorts with lower values are executed earlier
required: false
schema:
type: integer
format: int32
- name: take
in: query
description: Maximum number of records to include in results
required: false
schema:
type: integer
format: int32
responses:
'200':
description: Automatic Export Storage Items
content:
application/json:
schema:
$ref: '#/components/schemas/PagingOfAutoExportStorageItemViewModel'
'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/configuration/auto-export-storage/{id}:
get:
tags:
- Configuration
summary: Get Automatic Export Storage Items For Configuration
description: Retrieves a list of the items in automatic export storage for a configuration.
operationId: ConfigurationService_GetAutoExportStorageItems
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int32
- name: skip
in: query
description: Number of records to skip before taking results
required: false
schema:
type: integer
format: int32
- name: sortBy[0].direction
in: query
description: Sort direction
required: false
schema:
type: string
- name: sortBy[0].name
in: query
description: Sort field name
required: false
schema:
type: string
- name: sortBy[0].priority
in: query
description: Priority index. Sorts with lower values are executed earlier
required: false
schema:
type: integer
format: int32
- name: take
in: query
description: Maximum number of records to include in results
required: false
schema:
type: integer
format: int32
responses:
'200':
description: Automatic Export Storage Items For Configuration
content:
application/json:
schema:
$ref: '#/components/schemas/PagingOfAutoExportStorageItemViewModel'
'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/configuration/auto-export-storage/item/{id}:
get:
tags:
- Configuration
summary: Get Automatic Export Storage Item
description: Retrieves the automatic export storage item's contents.
operationId: ConfigurationService_GetAutoExportStorageItem
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int32
responses:
'200':
description: Automatic Export Storage Item
content:
application/json:
schema:
$ref: '#/components/schemas/StreamContent'
'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/configuration/backup:
get:
tags:
- Configuration
summary: Get Backup Configuration
description: Retrieve the settings and descriptions for the backup configuration view model.
operationId: ConfigurationService_GetDatabaseBackupConfiguration
responses:
'200':
description: Backup Configuration
content:
application/json:
schema:
$ref: '#/components/schemas/BackupConfigurationModel'
'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
patch:
tags:
- Configuration
summary: Patch Backup Configuration
description: Patch Backup Configuration by sending one or more fields with dirty set to true. This will return the actual updated view model.
operationId: ConfigurationService_PatchDatabaseBackupConfiguration
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BackupConfigurationArgs'
description: Backup Configuration Update Settings
responses:
'200':
description: Updated Backup Configuration
content:
application/json:
schema:
$ref: '#/components/schemas/BackupConfigurationModel'
'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
/v2/configuration/backup-logs:
get:
tags:
- Configuration
summary: Get Backup Logs
description: Retrieve the logs for the backups run.
operationId: ConfigurationService_GetBackupLogsV2
parameters:
- name: skip
in: query
description: Number of records to skip before taking results
required: false
schema:
type: integer
format: int32
- name: sortBy[0].direction
in: query
description: Sort direction
required: false
schema:
type: string
- name: sortBy[0].name
in: query
description: Sort field name
required: false
schema:
type: string
- name: sortBy[0].priority
in: query
description: Priority index. Sorts with lower values are executed earlier
required: false
schema:
type: integer
format: int32
- name: take
in: query
description: Maximum number of records to include in results
required: false
schema:
type: integer
format: int32
responses:
'200':
description: Backup Logs
content:
application/json:
schema:
$ref: '#/components/schemas/PagingOfBackupLogViewModel'
'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/configuration/system-log:
get:
tags:
- Configuration
summary: Get system log configuration
description: Get system log configuration
operationId: ConfigurationService_GetSystemLogConfiguration
responses:
'200':
description: System log configuration
content:
application/json:
schema:
$ref: '#/components/schemas/SystemLogConfigurationViewModel'
'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
patch:
tags:
- Configuration
summary: Patch system log configuration
description: Patch system log configuration
operationId: ConfigurationService_PatchSystemLogConfiguration
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SystemLogConfigurationUpdateArgs'
description: args
responses:
'200':
description: System log configuration
content:
application/json:
schema:
$ref: '#/components/schemas/SystemLogConfigurationViewModel'
'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/configuration/system-log/clear:
get:
tags:
- Configuration
summary: Clear system log
description: Clear system log
operationId: ConfigurationService_ClearSystemLog
responses:
'200':
description: Cleared System Log Result
content:
application/json:
schema:
description: Boolean
type: boolean
'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/configuration/public-ssh-key:
get:
tags:
- Configuration
summary: Public SSH Key Expiration
description: Public SSH Key Expiration
operationId: ConfigurationService_GetPublicSshKeyExpiration
responses:
'200':
description: Public SSH Key Expiration Result
content:
application/json:
schema:
$ref: '#/components/schemas/PublicSshKeyConfigurationViewModel'
'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/configuration/ticket-system:
get:
tags:
- Configuration
summary: Get the ticket system configuration
description: Get the ticket system configuration
operationId: ConfigurationService_GetTicketSystemConfiguration
responses:
'200':
description: Ticket System Configuration
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigurationTicketSystemViewModel'
'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
patch:
tags:
- Configuration
summary: Update the ticket system configuration
description: Update the ticket system configuration
operationId: ConfigurationService_PatchTicketSystemConfiguration
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigurationTicketSystemArgs'
description: Ticket System update args
responses:
'200':
description: Ticket System Configuration
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigurationTicketSystemViewModel'
'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/configuration/database:
get:
tags:
- Configuration
summary: Get the database configuration
description: Get the database configuration
operationId: ConfigurationService_GetDatabaseConfiguration
responses:
'200':
description: Database Configuration
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigurationDatabaseModel'
'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
patch:
tags:
- Configuration
summary: Update the database configuration
description: Update the database configuration
operationId: ConfigurationService_PatchDatabaseConfiguration
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigurationDatabasePatchArgs'
description: Database configuration update args
responses:
'200':
description: Database Configuration
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigurationDatabaseModel'
'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/configuration/read-only-mode:
get:
tags:
- Configuration
summary: Get Read Only Mode Configuration
description: Get Read Only Mode Configuration
operationId: ConfigurationService_GetConfigurationReadOnlyMode
responses:
'200':
description: Read Only Mode Configuration
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigurationReadOnlyModeModel'
'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
patch:
tags:
- Configuration
summary: Patch Read Only Mode Configuration
description: Patch Read Only Mode Configuration
operationId: ConfigurationService_PatchConfigurationReadOnlyMode
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigurationReadOnlyModeArgs'
description: Configuration Read Only Mode Patch Settings
responses:
'200':
description: Read Only Mode Configuration
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigurationReadOnlyModeModel'
'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/configuration/security/rotate-secret-keys-status:
get:
tags:
- Configuration
summary: Get Rotate Secret Keys Status
description: Get Rotate Secret Keys Status
operationId: ConfigurationService_GetRotateSecretKeysStatus
responses:
'200':
description: Status of Rotate Secret Keys
content:
application/json:
schema:
$ref: '#/components/schemas/RotateSecretKeysStatusModel'
'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/configuration/dp/state:
get:
tags:
- Configuration
summary: Get DPAPI Encryption State
description: Get DPAPI Encryption State
operationId: ConfigurationService_GetDpapiEncryptState
responses:
'200':
description: DPAPI Encrytion State
content:
application/json:
schema:
$ref: '#/components/schemas/DpapiEncryptStateModel'
'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/configuration/mfa/get-auth-profiles:
get:
tags:
- Configuration
summary: Get Multifactor Authentication Profiles
description: Get Multifactor Authentication Profiles
operationId: ConfigurationService_GetMultifactorAuthenticationConfiguration
responses:
'200':
description: Multfactor Configuration Model
content:
application/json:
schema:
$ref: '#/components/schemas/MfaConfigurationModel'
'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/configuration/general:
patch:
tags:
- Configuration
summary: Update general configuration
description: Update general configuration
operationId: ConfigurationService_PatchGeneralConfiguration
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigurationGeneralPatchArgs'
description: Local user password update args
responses:
'200':
description: Updated Configuration
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigurationGeneralModel'
'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/configuration/saml/identity-provider:
post:
tags:
- Configuration
summary: Create Saml configuration
description: Create Saml Configuration
operationId: ConfigurationService_PostSamlConfiguration
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigurationSamlIdentityProviderCreateArgs'
description: Saml create args
responses:
'200':
description: Saml configuration after create
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigurationSamlIdentityProviderModel'
'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
patch:
tags:
- Configuration
summary: Update Saml Identity Provider configuration
description: Update Saml Identity Provider Configuration
operationId: ConfigurationService_PatchSamlIdentityProviderConfiguration
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigurationSamlIdentityProviderPatchArgs'
description: Saml Identity Provider update args
responses:
'200':
description: Saml Identity Provider configuration after updates
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigurationSamlIdentityProviderModel'
'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/configuration/sessionrecording:
patch:
tags:
- Configuration
summary: Session Recording
description: Update Session Recording Configuration
operationId: ConfigurationService_PatchSessionRecordingConfiguration
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigurationSessionRecordingPatchArgs'
description: Local user password update args
responses:
'200':
description: Session Recording Configuration
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigurationSessionRecordingModel'
'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/configuration/folder:
patch:
tags:
- Configuration
summary: Folder
description: Update Folder Configuration
operationId: ConfigurationService_PatchFolderConfiguration
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigurationFoldersPatchArgs'
description: Folders configuration args
responses:
'200':
description: Folder Configuration
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigurationFoldersModel'
'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/configuration/application-settings:
patch:
tags:
- Configuration
summary: Update the application settings configuration
description: Update the application settings configuration
operationId: ConfigurationService_PatchApplicationSettingsConfiguration
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigurationApplicationSettingsPatchArgs'
description: Application settings update args
responses:
'200':
description: Application Settings Configuration
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigurationApplicationSettingsModel'
'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/configuration/permission-options:
patch:
tags:
- Configuration
summary: Update the permission options configuration
description: Update the permission options configuration
operationId: ConfigurationService_PatchPermissionOptionsConfiguration
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigurationPermissionOptionsPatchArgs'
description: Permission options update args
responses:
'200':
description: Permission Options Configuration
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigurationPermissionOptionsModel'
'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/configuration/launcher-settings:
patch:
tags:
- Configuration
summary: Update the launcher settings configuration
description: Update the launcher settings configuration
operationId: ConfigurationService_PatchLauncherSettingsConfiguration
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigurationLauncherSettingsPatchArgs'
description: Launcher settings update args
responses:
'200':
description: launcher settings Configuration
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigurationLauncherSettingsModel'
'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/configuration/protocol-handler-settings:
patch:
tags:
- Configuration
summary: Update the protocol handler settings configuration
description: Update the protocol handler settings configuration
operationId: ConfigurationService_PatchProtocolHandlerSettingsConfiguration
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigurationProtocolHandlerSettingsPatchArgs'
description: Protocol handler settings update args
responses:
'200':
description: protocol handler settings Configuration
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigurationProtocolHandlerSettingsModel'
'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/configuration/user-experience:
patch:
tags:
- Configuration
summary: Update the user experience configuration
description: Update the user experience configuration
operationId: ConfigurationService_PatchUserExperienceConfiguration
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigurationUserExperiencePatchArgs'
description: User experience update args
responses:
'200':
description: User Experience Configuration
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigurationUserExperienceModel'
'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
/v2/configuration/user-interface:
patch:
tags:
- Configuration
summary: Update the user interface configuration
description: Update the user interface configuration
operationId: ConfigurationService_PatchUserInterfaceConfigurationV2
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigurationUserInterfacePatchArgsV2'
description: User interface update args
responses:
'200':
description: User Interface Configuration
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigurationUserInterfaceModelV2'
'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/configuration/email:
patch:
tags:
- Configuration
summary: Update the email configuration
description: Update the email configuration
operationId: ConfigurationService_PatchEmailConfiguration
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigurationEmailPatchArgs'
description: Email update args
responses:
'200':
description: Email Configuration
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigurationEmailModel'
'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/configuration/rpc/run-now:
post:
tags:
- Configuration
summary: Run RPC Now
description: Run RPC Now
operationId: ConfigurationService_RunRpcNow
responses:
'200':
description: Result of running RPC now
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigurationRpcRunNowResultModel'
'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/configuration/heartbeat/run-now:
post:
tags:
- Configuration
summary: Run Heartbeat Now
description: Run Heartbeat Now
operationId: ConfigurationService_RunHeartbeatNow
responses:
'200':
description: Result of running Heartbeat now
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigurationHeartbeatRunNowResultModel'
'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/configuration/secret-search-indexer/rebuild-index:
post:
tags:
- Configuration
summary: Rebuild Secret Search Index
description: Start Rebuilding the Secret Search Index. This method just indicates that a background process should start to process the index.
operationId: ConfigurationService_RebuildSecretSearchIndexerConfiguration
responses:
'200':
description: true if the job was queued
content:
application/json:
schema:
description: Boolean
type: boolean
'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/configuration/auto-export/run-now:
post:
tags:
- Configuration
summary: Start Automatic Export
description: Start the automatic export as configured
operationId: ConfigurationService_RunAutoExportNow
responses:
'200':
description: True if the job was queued
content:
application/json:
schema:
description: Boolean
type: boolean
'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/configuration/backup/run-now:
post:
tags:
- Configuration
summary: Start Backup
description: Start the backup as configured
operationId: ConfigurationService_RunBackupNow
responses:
'200':
description: true if the job was queued
content:
application/json:
schema:
description: Boolean
type: boolean
'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/configuration/security/rotate-secret-keys:
post:
tags:
- Configuration
summary: Rotate Secret Keys
description: Rotate Secret Keys
operationId: ConfigurationService_RotateSecretKeys
responses:
'200':
description: Result of running Rotate Secret Keys
content:
application/json:
schema:
$ref: '#/components/schemas/RotateSecretKeysStatusModel'
'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/configuration/security/cancel-rotate-secret-keys:
post:
tags:
- Configuration
summary: Cancel Rotate Secret Keys
description: Cancel Rotate Secret Keys
operationId: ConfigurationService_CancelRotateSecretKeys
responses:
'200':
description: Result of running Cancel Rotate Secret Keys
content:
application/json:
schema:
$ref: '#/components/schemas/RotateSecretKeysStatusModel'
'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/configuration/email/test:
post:
tags:
- Configuration
summary: TestEmail
description: Send Test Email
operationId: ConfigurationService_TestEmail
responses:
'200':
description: Test Email Response
content:
application/json:
schema:
$ref: '#/components/schemas/TestEmailResponse'
'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/configuration/login/clear-ad-credentials:
post:
tags:
- Configuration
summary: Clear AD Credentials
description: Clear AD Credentials
operationId: ConfigurationService_ClearADCredentials
responses:
'200':
description: Clear AD Credentials Result
content:
application/json:
schema:
$ref: '#/components/schemas/ClearCachedADCredentialsResultModel'
'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/configuration/login/radius/test:
post:
tags:
- Configuration
summary: Test Radius Login
description: Test a Radius Login
operationId: ConfigurationService_TestRadiusLogin
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TestRadiusLoginArgs'
description: args
responses:
'200':
description: Test Radius Login Response
content:
application/json:
schema:
$ref: '#/components/schemas/TestRadiusLoginResponseModel'
'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/configuration/syslog/test:
post:
tags:
- Configuration
summary: Test Syslog
description: Send a simple message to the configured syslog
operationId: ConfigurationService_TestSyslog
responses:
'200':
description: Result of the test
content:
application/json:
schema:
$ref: '#/components/schemas/TestSyslogResponseModel'
'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/configuration/dp/encrypt:
post:
tags:
- Configuration
summary: Encrypt using DPAPI
description: Encrypt using DPAPI
operationId: ConfigurationService_DpapiEncrypt
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DpapiEncryptArgs'
description: args
responses:
'200':
description: DPAPI Encrypt Response
content:
application/json:
schema:
$ref: '#/components/schemas/DpapiEncryptStateModel'
'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/configuration/dp/decrypt:
post:
tags:
- Configuration
summary: Decrypt using DPAPI
description: Decrypt using DPAPI
operationId: ConfigurationService_DpapiDecrypt
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DpapiDecryptArgs'
description: args
responses:
'200':
description: DPAPI Decrypt Response
content:
application/json:
schema:
$ref: '#/components/schemas/DpapiEncryptStateModel'
'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/configuration/saml/identity-provider/import:
put:
tags:
- Configuration
summary: Import Saml configuration Identity Provider
description: Import Saml configuration Identity Provider
operationId: ConfigurationService_ImportSamlConfiguration
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigurationSamlIdentityProviderImportArgs'
description: Saml Identity Provider import args
responses:
'200':
description: Saml configuration Identity Provider after import
content:
application/json:
schema:
description: Saml configuration Identity Provider after import
items:
$ref: '#/components/schemas/ConfigurationSamlIdentityProviderModel'
type: array
'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/configuration/mfa/set-auth-profile:
put:
tags:
- Configuration
summary: Set Current Multifactor Authentication Profile
description: Set Current Multifactor Authentication Profile
operationId: ConfigurationService_SetCurrentMultifactorAuthenticationConfiguration
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/MfaConfigurationSetProfileArgs'
description: args
responses:
'200':
description: Multfactor Configuration Model
content:
application/json:
schema:
$ref: '#/components/schemas/MfaConfigurationModel'
'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:
ConfigurationFoldersUpdateModel:
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
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
SortDirection:
description: Sort direction
properties: {}
type: string
enum:
- None
- Asc
- Desc
ConfigurationReadOnlyModeUpdateModel:
description: Data
properties:
enabled:
$ref: '#/components/schemas/UpdateFieldValueOfBoolean'
type: object
ConfigurationUserInterfacePatchArgsV2:
description: ConfigurationUserInterfacePatchArgsV2
properties:
data:
$ref: '#/components/schemas/ConfigurationUserInterfacePatchModelV2'
type: object
RotateSecretKeysStatusModel:
description: Rotate Secret Keys Status
properties:
lastRequestDate:
description: Date of the last time Rotate Secret Keys was requested. Null if never run.
type: string
format: date-time
nullable: true
lastRunDate:
description: Date of the last time Rotate Secret Keys was executed. Null if never run.
type: string
format: date-time
nullable: true
lastStatus:
description: Status of the last time Rotate Secret Keys was executed.
type: string
message:
description: Message about the last time Rotate Secret Keys was executed.
type: string
progressStatus:
$ref: '#/components/schemas/RotateSecretKeysProgressModel'
type: object
NameValueHeaderValue:
description: Parameters
properties:
name:
description: Name
type: string
value:
description: Value
type: string
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
UnlimitedAdminUpdateModel:
description: Unlimited Admin Update Model
properties:
enabled:
$ref: '#/components/schemas/UpdateFieldValueOfBoolean'
notes:
$ref: '#/components/schemas/UpdateFieldValueOfString'
type: object
ConfigurationReadOnlyModeArgs:
description: ConfigurationReadOnlyModeArgs
properties:
data:
$ref: '#/components/schemas/ConfigurationReadOnlyModeUpdateModel'
type: object
TicketSystemTypes:
description: Value
properties: {}
type: string
enum:
- TicketNumberValidation
- BmcRemedyIncidentManagement
- BmcRemedyChangeManagement
- PowerShell
- ServiceNowChangeManagement
- ServiceNowIncidentManagement
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
FolderSynchronizationModel:
description: FolderSynchronizationModel
properties:
companyId:
description: ConnectWise company ID
type: string
daysToKeepOperationalLogs:
description: How long to keep the logs
type: integer
format: int32
folderStructure:
description: Folder structure
type: string
integratorCredentials:
description: Credentials used to connect
type: integer
format: int32
nullable: true
integratorCredentialsName:
description: Name of the Credentials secret used to connect
type: string
intervalDays:
description: Number of days between synchronizations
type: integer
format: int32
intervalHours:
description: Number of hours between synchronizations
type: integer
format: int32
intervalMinutes:
description: Number of minutes between synchronizations
type: integer
format: int32
siteUrl:
description: ConnectWise Site URL
type: string
sqlCustomView:
description: If a custom view is needed enter it here. Left empty the standard ConnectWise view will be used.
type: string
sqlPassword:
description: The sql password when using legacy database connection mode
type: string
sqlServerLocation:
description: The sql server when using legacy database connection mode
type: string
sqlUsername:
description: The sql username when using legacy database connection mode
type: string
syncAllFolders:
description: Indicates whether or not to synchronize all folders
type: boolean
syncFolderId:
description: When not synchronizing all folders this defines the folder to synchronize
type: integer
format: int32
nullable: true
syncMethodType:
$ref: '#/components/schemas/FolderSynchronizationMethodType'
type: object
DpapiEncryptArgs:
description: DpapiEncryptArgs
properties:
data:
$ref: '#/components/schemas/DpapiEncryptRequestModel'
type: object
ConfigurationAuditItem:
description: Configuration Audit Item
properties:
action:
description: Action that was performed
type: string
date:
description: Date of Action
type: string
format: date-time
displayName:
description: Display name of user performing action
type: string
notes:
description: Notes on the action that was performed
type: string
type: object
AutoExportConfigurationUpdateModel:
description: Data
properties:
enableAutoExport:
$ref: '#/components/schemas/UpdateFieldValueOfBoolean'
exportChildFolders:
$ref: '#/components/schemas/UpdateFieldValueOfBoolean'
exportFolderPaths:
$ref: '#/components/schemas/UpdateFieldValueOfBoolean'
exportPasswordSecretId:
$ref: '#/components/schemas/UpdateFieldValueOfOptionalInt32'
exportPath:
$ref: '#/components/schemas/UpdateFieldValueOfString'
exportTotpSettings:
$ref: '#/components/schemas/UpdateFieldValueOfBoolean'
folderId:
$ref: '#/components/schemas/UpdateFieldValueOfOptionalInt32'
frequencyDays:
$ref: '#/components/schemas/UpdateFieldValueOfInt32'
type: object
ConfigurationSessionRecordingPatchArgs:
description: ConfigurationSessionRecordingPatchArgs
properties:
data:
$ref: '#/components/schemas/ConfigurationSessionRecordingPatchModel'
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
ConfigurationRpcPatchModel:
description: Data
properties:
checkOutIntervalDays:
$ref: '#/components/schemas/UpdateFieldValueOfInt32'
checkOutIntervalHours:
$ref: '#/components/schemas/UpdateFieldValueOfInt32'
checkOutIntervalMinutes:
$ref: '#/components/schemas/UpdateFieldValueOfInt32'
daysToKeepLogs:
$ref: '#/components/schemas/UpdateFieldValueOfInt32'
enableHeartbeat:
$ref: '#/components/schemas/UpdateFieldValueOfBoolean'
enableHeartbeatSmbFallback:
$ref: '#/components/schemas/UpdateFieldValueOfBoolean'
enablePasswordChangeOnCheckIn:
$ref: '#/components/schemas/UpdateFieldValueOfBoolean'
enableRpc:
$ref: '#/components/schemas/UpdateFieldValueOfBoolean'
type: object
UpdateFieldValueOfFolderSynchronizationMethodType:
description: Defines what type of folder synchronization to use
properties:
dirty:
description: Dirty
type: boolean
value:
$ref: '#/components/schemas/FolderSynchronizationMethodType'
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
ConfigurationDatabasePatchArgs:
description: ConfigurationDatabasePatchArgs
properties:
data:
$ref: '#/components/schemas/ConfigurationDatabasePatchModel'
type: object
TestRadiusLoginResponseModel:
description: Test Radius Login Response
properties:
success:
description: True to indicate success
type: boolean
type: object
ViewFieldValueOfBoolean:
description: When enabled, the log will be able to be viewed online
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
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
ConfigurationSessionRecordingAdvancedModel:
description: Session Recording Advanced Configuration
properties:
agentCallbackUrl:
description: Agent Callback URL
type: string
enableAdvancedSessionRecording:
description: Whether or not Avanced Session Recording is enabled
type: boolean
type: object
ConfigurationUserInterfacePatchModelV2:
description: Update user interface configuration
properties:
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'
isCustomBannerDismissable:
$ref: '#/components/schemas/UpdateFieldValueOfBoolean'
showCustomBanner:
$ref: '#/components/schemas/UpdateFieldValueOfBoolean'
type: object
ConfigurationRpcPatchArgs:
description: ConfigurationRpcPatchArgs
properties:
data:
$ref: '#/components/schemas/ConfigurationRpcPatchModel'
type: object
ConfigurationStateModel:
description: The configuration sections avaible to the current user
properties:
sections:
description: Sections
items:
$ref: '#/components/schemas/ConfigurationSectionAccessModel'
type: array
type: object
TicketSystemViewModel:
description: List of Ticket Systems
properties:
active:
$ref: '#/components/schemas/ViewFieldValueOfBoolean'
addCommentsToTicket:
$ref: '#/components/schemas/ViewFieldValueOfBoolean'
bmcChangeManagementCommentWorkType:
$ref: '#/components/schemas/ViewFieldValueOfOptionalBmcChangeManagementCommentWorkType'
bmcIncidentManagementCommentWorkType:
$ref: '#/components/schemas/ViewFieldValueOfOptionalBmcIncidentManagementCommentWorkType'
bmcRemedyAuthentication:
$ref: '#/components/schemas/ViewFieldValueOfString'
bmcRemedyUrlEndpoint:
$ref: '#/components/schemas/ViewFieldValueOfString'
description:
$ref: '#/components/schemas/ViewFieldValueOfString'
displayMessage:
$ref: '#/components/schemas/ViewFieldValueOfString'
forceRequireTicketNumber:
$ref: '#/components/schemas/ViewFieldValueOfForceRequireTicketSystemOptions'
hideComment:
$ref: '#/components/schemas/ViewFieldValueOfBoolean'
isDefault:
$ref: '#/components/schemas/ViewFieldValueOfBoolean'
name:
$ref: '#/components/schemas/ViewFieldValueOfString'
organizationId:
$ref: '#/components/schemas/ViewFieldValueOfInt32'
powerShellAddCommentScriptArguments:
$ref: '#/components/schemas/ViewFieldValueOfString'
powerShellAddCommentScriptId:
$ref: '#/components/schemas/ViewFieldValueOfOptionalInt32'
powerShellAddTicketCommentScriptArguments:
$ref: '#/components/schemas/ViewFieldValueOfString'
powerShellAddTicketCommentScriptId:
$ref: '#/components/schemas/ViewFieldValueOfOptionalInt32'
powerShellRunAsAccountSecretId:
$ref: '#/components/schemas/ViewFieldValueOfOptionalInt32'
powerShellTicketStatusScriptArguments:
$ref: '#/components/schemas/ViewFieldValueOfString'
powerShellTicketStatusScriptId:
$ref: '#/components/schemas/ViewFieldValueOfOptionalInt32'
serviceNowAllowedStatuses:
$ref: '#/components/schemas/ViewFieldValueOfString'
serviceNowDomainName:
$ref: '#/components/schemas/ViewFieldValueOfString'
siteId:
$ref: '#/components/schemas/ViewFieldValueOfOptionalInt32'
systemCredentialSecretId:
$ref: '#/components/schemas/ViewFieldValueOfOptionalInt32'
ticketNumberErrorMessage:
$ref: '#/components/schemas/ViewFieldValueOfString'
ticketNumberValidation:
$ref: '#/components/schemas/ViewFieldValueOfString'
ticketSystemId:
$ref: '#/components/schemas/ViewFieldValueOfInt32'
ticketSystemType:
$ref: '#/components/schemas/ViewFieldValueOfTicketSystemTypes'
viewTicketURL:
$ref: '#/components/schemas/ViewFieldValueOfString'
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
ConfigurationRpcRunNowResultModel:
description: RPC Run Now Result
properties:
success:
description: Whether or not the call to Run Now was successful
type: boolean
type: object
ConfigurationSamlIdentityProviderPatchArgs:
description: ConfigurationSamlIdentityProviderPatchArgs
properties:
data:
$ref: '#/components/schemas/ConfigurationSamlIdentityProviderPatchModel'
type: object
UpdateFieldValueOfLauncherDeploymentType:
description: Launcher Deployment Type
properties:
dirty:
description: Dirty
type: boolean
value:
$ref: '#/components/schemas/LauncherDeploymentType'
type: object
ConfigurationLoginV2Model:
description: Login Configuration
properties:
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: integer
format: int32
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
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
ConfigurationApplicationSettingsPatchArgs:
description: ConfigurationApplicationSettingsPatchArgs
properties:
data:
$ref: '#/components/schemas/ConfigurationApplicationSettingsPatchModel'
type: object
UpdateFieldValueOfSqlAuthenticationType:
description: The type of authentication method used for connecting to the sql server.
properties:
dirty:
description: Dirty
type: boolean
value:
$ref: '#/components/schemas/SqlAuthenticationType'
type: object
PlatformConfigurationArgs:
description: PlatformConfigurationArgs
properties:
data:
$ref: '#/components/schemas/PlatformConfigurationUpdateModel'
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
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
Sort:
description: Sort options. Multiple sort options can be provided in the query string.
required:
- name
- direction
properties:
direction:
$ref: '#/components/schemas/SortDirection'
name:
description: Sort field name
type: string
priority:
description: Priority index. Sorts with lower values are executed earlier
type: integer
format: int32
type: object
ConfigurationSectionAccess:
description: SectionAccess
properties: {}
type: string
enum:
- None
- InvalidLicense
- View
- Admin
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
ConfigurationLocalPasswordPatchArgs:
description: ConfigurationLocalPasswordPatchArgs
properties:
data:
$ref: '#/components/schemas/ConfigurationLocalPasswordPatchModel'
type: object
UpdateFieldValueOfStringArray:
description: Characters that split keys to be indexed
properties:
dirty:
description: Dirty
type: boolean
value:
description: Value
items:
type: string
type: array
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
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
BackupConfigurationUpdateModel:
description: Data
properties:
backupDatabasePath:
$ref: '#/components/schemas/UpdateFieldValueOfString'
backupFailureNotification:
$ref: '#/components/schemas/UpdateFieldValueOfBoolean'
backupPath:
$ref: '#/components/schemas/UpdateFieldValueOfString'
backupStartDateTime:
$ref: '#/components/schemas/UpdateFieldValueOfDateTime'
configurationSqlBackupTimeoutMinutes:
$ref: '#/components/schemas/UpdateFieldValueOfInt32'
copyOnlyDatabaseBackup:
$ref: '#/components/schemas/UpdateFieldValueOfBoolean'
enableDatabaseBackup:
$ref: '#/components/schemas/UpdateFieldValueOfBoolean'
enableScheduledBackup:
$ref: '#/components/schemas/UpdateFieldValueOfBoolean'
enableTmsBackup:
$ref: '#/components/schemas/UpdateFieldValueOfBoolean'
enableWebApplicationBackup:
$ref: '#/components/schemas/UpdateFieldValueOfBoolean'
numberOfBackupsToKeep:
$ref: '#/components/schemas/UpdateFieldValueOfInt32'
repeatDays:
$ref: '#/components/schemas/UpdateFieldValueOfInt32'
repeatHours:
$ref: '#/components/schemas/UpdateFieldValueOfInt32'
repeatMinutes:
$ref: '#/components/schemas/UpdateFieldValueOfInt32'
tmsInstallationPath:
$ref: '#/components/schemas/UpdateFieldValueOfString'
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
ViewFieldValueOfString:
description: GeneratedToken
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
type: string
type: object
ConfigurationGeneralPatchArgs:
description: ConfigurationGeneralPatchArgs
properties:
data:
$ref: '#/components/schemas/ConfigurationGeneralUpdateModel'
type: object
PlatformConfigurationAuditViewModel:
description: Platform Configuration Audit
properties:
action:
description: Action
type: string
date:
description: Date
type: string
format: date-time
displayName:
description: DisplayName
type: string
notes:
description: Notes
type: string
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
AutoExportLogViewModel:
description: Automatic Export Log
properties:
exportDate:
description: ExportDate
type: string
format: date-time
notes:
description: Notes
type: string
success:
description: Success
type: boolean
type: object
PlatformConfigurationModel:
description: Platform Configuration
properties:
createGroupsDuringSynchronization:
description: Whether groups will be created during the Platform synchronization process.
type: boolean
enablePlatformAuditIntegration:
description: Whether event subscriptions are sent to the Platform Audit Service
type: boolean
enablePlatformInventoryForwarding:
description: Whether inventory data is forwarded to the Platform Inventory Service
type: boolean
enablePlatformOnLoginPage:
description: Whether Platform will be displayed as an option on the login page.
type: boolean
openIdConnectClientId:
description: The client ID for the OpenID Connect registered application.
type: string
openIdConnectClientSecret:
description: The client secret for the OpenID Connect registered application.
type: string
openIdConnectEnabled:
description: Whether Platform integration is enabled.
type: boolean
openIdConnectLoginUrl:
description: The login URL for the OpenID Connect provider.
type: string
openIdConnectLogoutUrl:
description: The logout URL for the OpenID Connect provider.
type: string
openIdConnectReplyUrl:
description: The reply URL that needs to be registered with the OpenID Connect provider.
type: string
platformPermissionCacheExpirationInMinutes:
description: Cache expiration (time to live) for user permissions
type: integer
format: int32
platformPermissionSynchronizationIntervalMinutes:
description: Synchronize minutes interval for user permissions
type: integer
format: int32
platformTenantId:
description: The Unique Identifier for the connected Platform tenant.
type: string
format: uuid
nullable: true
synchronizationIntervalDays:
description: Synchronize days interval for users and group membership
type: integer
format: int32
synchronizationIntervalHours:
description: Synchronize hours interval for users and group membership
type: integer
format: int32
usePlatformSettings:
description: Whether Platform Settings will be used for permissions.
type: boolean
vaultId:
description: An identifier to uniquely identify this vault to Platform
type: string
format: uuid
nullable: true
type: object
SearchIndexerUpdateArgs:
description: SearchIndexerUpdateArgs
properties:
data:
$ref: '#/components/schemas/SearchIndexerUpdateModel'
type: object
SystemLogConfigurationUpdateArgs:
description: SystemLogConfigurationUpdateArgs
properties:
data:
$ref: '#/components/schemas/SystemLogConfigurationUpdateModel'
type: object
SyslogCefProtocolType:
description: Value
properties: {}
type: string
enum:
- UDP
- TCP
- SECURE_TCP
ConfigurationDatabaseModel:
description: Database Configuration
properties:
applicationPoolIdentity:
description: The current application pool identity.
type: string
authenticationType:
$ref: '#/components/schemas/SqlAuthenticationType'
connectionTimeout:
description: The network connection timeout for connecting to SQL Server (not for query execution timeouts).
type: integer
format: int32
nullable: true
databaseConfigFilePath:
description: The database configuration file path on the current server.
type: string
databaseName:
description: The database name.
type: string
enableMultiSubnetFailover:
description: When true Multi-Subnet Failover is configured.
type: boolean
enableSslEncryption:
description: When true ssl encryption will be enabled when communicating with sql server.
type: boolean
failoverPartner:
description: The current failover partner.
type: string
hasDiskWritePermissions:
description: When true the application pool account has disk write permissions.
type: boolean
isTmsInstalled:
description: When true the TMS / Privilege manager database exists.
type: boolean
serverName:
description: The sql server name.
type: string
trustServerCertificate:
description: When true the sql server ssl certificate will be trusted without validating the certificate chain.
type: boolean
userName:
description: The username when using sql authentication.
type: string
type: object
SearchIndexerUpdateModel:
description: Data
properties:
daysToKeepLogs:
$ref: '#/components/schemas/UpdateFieldValueOfInt32'
enabled:
$ref: '#/components/schemas/UpdateFieldValueOfBoolean'
indexingSeparators:
$ref: '#/components/schemas/UpdateFieldValueOfStringArray'
indexMode:
$ref: '#/components/schemas/UpdateFieldValueOfSearchIndexMode'
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
ConfigurationSessionRecordingSiteArchiveUpdateModel:
description: Value
properties:
path:
description: Path
type: string
siteId:
description: SiteId
type: integer
format: int32
type: object
SystemLogConfigurationViewModel:
description: System Log Configuration View Model
properties:
allowViewingOnline:
$ref: '#/components/schemas/ViewFieldValueOfBoolean'
enableSystemLog:
$ref: '#/components/schemas/ViewFieldValueOfBoolean'
maxLogLength:
$ref: '#/components/schemas/ViewFieldValueOfOptionalInt32'
notifyWhenShrunk:
$ref: '#/components/schemas/ViewFieldValueOfBoolean'
type: object
PagingOfBackupLogViewModel:
description: Specify paging and sorting options for querying records and returning results
properties:
batchCount:
description: Number of result batches available with current query options
type: integer
format: int32
currentPage:
description: Index of current result page
type: integer
format: int32
hasNext:
description: Whether there are any results in additional pages
type: boolean
hasPrev:
description: Whether there are any results in previous pages
type: boolean
nextSkip:
description: Correct value of 'skip' for the next page of results
type: integer
format: int32
pageCount:
description: Number of result pages available with current query options
type: integer
format: int32
prevSkip:
description: Correct value of 'skip' for the previous page of results
type: integer
format: int32
records:
description: Query results
items:
$ref: '#/components/schemas/BackupLogViewModel'
type: array
severity:
$ref: '#/components/schemas/Severity'
skip:
description: Number of records to skip before taking results
type: integer
format: int32
sortBy:
description: List of sort properties
items:
$ref: '#/components/schemas/Sort'
type: array
success:
description: Whether the query executed successfully
type: boolean
take:
description: Maximum number of records to include in results
type: integer
format: int32
total:
description: Total number of results available
type: integer
format: int32
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
ConfigurationLoginV2PatchModel:
description: Login Configuration
properties:
allowRememberMe:
$ref: '#/components/schemas/UpdateFieldValueOfBoolean'
cacheADCredentials:
$ref: '#/components/schemas/UpdateFieldValueOfBoolean'
defaultLoginDomain:
$ref: '#/components/schemas/UpdateFieldValueOfInt32'
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
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
ContentDispositionHeaderValue:
description: ContentDisposition
properties:
creationDate:
$ref: '#/components/schemas/OptionalDateTimeOffset'
dispositionType:
description: DispositionType
type: string
fileName:
description: FileName
type: string
fileNameStar:
description: FileNameStar
type: string
modificationDate:
$ref: '#/components/schemas/OptionalDateTimeOffset'
name:
description: Name
type: string
parameters:
description: Parameters
items:
$ref: '#/components/schemas/NameValueHeaderValue'
type: array
readDate:
$ref: '#/components/schemas/OptionalDateTimeOffset'
size:
description: Size
type: integer
format: int64
nullable: true
type: object
DpapiDecryptRequestModel:
description: DPAPI Decrypt Request
properties:
password:
description: Password for Decryption
type: string
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
UpdateFieldValueOfDateTime:
description: BackupStartDateTime
properties:
dirty:
description: Dirty
type: boolean
value:
description: Value
type: string
format: date-time
type: object
ViewFieldValueOfTicketSystemTypes:
description: TicketSystemType
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/TicketSystemTypes'
type: object
ConfigurationSecurityPatchArgs:
description: ConfigurationSecurityPatchArgs
properties:
data:
$ref: '#/components/schemas/ConfigurationSecurityPatchModel'
type: object
DayOfWeek:
description: DayOfWeek
properties: {}
type: string
enum:
- Sunday
- Monday
- Tuesday
- Wednesday
- Thursday
- Friday
- Saturday
SearchIndexMode:
description: 'The index mode: standard or extended'
properties: {}
type: string
enum:
- Standard
- Extended
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
AuthenticationFailedResponse:
description: Response object for authentication failures
required:
- message
properties:
message:
description: Error message
type: string
type: object
PagingOfAutoExportConfigurationAuditViewModel:
description: Specify paging and sorting options for querying records and returning results
properties:
batchCount:
description: Number of result batches available with current query options
type: integer
format: int32
currentPage:
description: Index of current result page
type: integer
format: int32
hasNext:
description: Whether there are any results in additional pages
type: boolean
hasPrev:
description: Whether there are any results in previous pages
type: boolean
nextSkip:
description: Correct value of 'skip' for the next page of results
type: integer
format: int32
pageCount:
description: Number of result pages available with current query options
type: integer
format: int32
prevSkip:
description: Correct value of 'skip' for the previous page of results
type: integer
format: int32
records:
description: Query results
items:
$ref: '#/components/schemas/AutoExportConfigurationAuditViewModel'
type: array
severity:
$ref: '#/components/schemas/Severity'
skip:
description: Number of records to skip before taking results
type: integer
format: int32
sortBy:
description: List of sort properties
items:
$ref: '#/components/schemas/Sort'
type: array
success:
description: Whether the query executed successfully
type: boolean
take:
description: Maximum number of records to include in results
type: integer
format: int32
total:
description: Total number of results available
type: integer
format: int32
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
ConfigurationReadOnlyModeModel:
description: Read Only Mode Configuration
properties:
enabled:
description: Whether read only mode is enabled.
type: boolean
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
MfaConfigurationSetProfileArgs:
description: MfaConfigurationSetProfileArgs
properties:
authProfileId:
description: AuthProfileId
type: string
format: uuid
type: object
PagingOfPlatformConfigurationAuditViewModel:
description: Specify paging and sorting options for querying records and returning results
properties:
batchCount:
description: Number of result batches available with current query options
type: integer
format: int32
currentPage:
description: Index of current result page
type: integer
format: int32
hasNext:
description: Whether there are any results in additional pages
type: boolean
hasPrev:
description: Whether there are any results in previous pages
type: boolean
nextSkip:
description: Correct value of 'skip' for the next page of results
type: integer
format: int32
pageCount:
description: Number of result pages available with current query options
type: integer
format: int32
prevSkip:
description: Correct value of 'skip' for the previous page of results
type: integer
format: int32
records:
description: Query results
items:
$ref: '#/components/schemas/PlatformConfigurationAuditViewModel'
type: array
severity:
$ref: '#/components/schemas/Severity'
skip:
description: Number of records to skip before taking results
type: integer
format: int32
sortBy:
description: List of sort properties
items:
$ref: '#/components/schemas/Sort'
type: array
success:
description: Whether the query executed successfully
type: boolean
take:
description: Maximum number of records to include in results
type: integer
format: int32
total:
description: Total number of results available
type: integer
format: int32
type: object
ContentRangeHeaderValue:
description: ContentRange
properties:
from:
description: From
type: integer
format: int64
nullable: true
hasLength:
description: HasLength
type: boolean
hasRange:
description: HasRange
type: boolean
length:
description: Length
type: integer
format: int64
nullable: true
to:
description: To
type: integer
format: int64
nullable: true
unit:
description: Unit
type: string
type: object
SearchIndexerModel:
description: Configuration for Secret search indexer
properties:
daysToKeepLogs:
description: How many days to keep the logs for the search indexer
type: integer
format: int32
enabled:
description: Whether or not the search indexer is enabled
type: boolean
indexingSeparators:
description: Characters that split keys to be indexed
items:
type: string
type: array
indexMode:
$ref: '#/components/schemas/SearchIndexMode'
indexPercentComplete:
description: The percent of the index that is built
type: number
format: float
lastIndexDate:
description: The time of the last indexing
type: string
format: date-time
nullable: true
logAvailable:
description: Whether or not a log is available for the Secret Search Indexer
type: boolean
status:
$ref: '#/components/schemas/SearchIndexStatus'
type: object
ConfigurationRpcModel:
description: RPC Configuration
properties:
checkOutIntervalDays:
description: Check Out Interval Days
type: integer
format: int32
checkOutIntervalHours:
description: Check Out Interval Hours
type: integer
format: int32
checkOutIntervalMinutes:
description: Check Out Interval Minutes
type: integer
format: int32
daysToKeepLogs:
description: How many days to keep the operational logs
type: integer
format: int32
enableHeartbeat:
description: Whether or not heartbeat is enabled
type: boolean
enableHeartbeatSmbFallback:
description: Whether or not unsuccessful RPC heartbeat should attempt SMB
type: boolean
enablePasswordChangeOnCheckIn:
description: Whether or not to allow changing the password when a Secret is checked in
type: boolean
enableRpc:
description: Whether or not RPC is enabled
type: boolean
type: object
BackupLogViewModel:
description: Database Backup Log
properties:
backupTime:
description: BackupTime
type: string
format: date-time
displayName:
description: DisplayName
type: string
notes:
description: Notes
type: string
success:
description: Success
type: boolean
type: object
SyslogCefTimeZoneType:
description: Value
properties: {}
type: string
enum:
- ServerTime
- UtcTime
ConfigurationGeneralModel:
description: Configuration General
properties:
applicationSettings:
$ref: '#/components/schemas/ConfigurationApplicationSettingsModel'
email:
$ref: '#/components/schemas/ConfigurationEmailModel'
folders:
$ref: '#/components/schemas/ConfigurationFoldersModel'
launcherSettings:
$ref: '#/components/schemas/ConfigurationLauncherSettingsModel'
localUserPasswords:
$ref: '#/components/schemas/ConfigurationLocalUserPasswordsModel'
login:
$ref: '#/components/schemas/ConfigurationLoginModel'
permissionOptions:
$ref: '#/components/schemas/ConfigurationPermissionOptionsModel'
protocolHandlerSettings:
$ref: '#/components/schemas/ConfigurationProtocolHandlerSettingsModel'
security:
$ref: '#/components/schemas/ConfigurationSecurityModel'
sessionRecording:
$ref: '#/components/schemas/ConfigurationSessionRecordingModel'
unlimitedAdmin:
$ref: '#/components/schemas/UnlimitedAdminModel'
userExperience:
$ref: '#/components/schemas/ConfigurationUserExperienceModel'
userInterface:
$ref: '#/components/schemas/ConfigurationUserInterfaceModel'
type: object
ConfigurationDatabasePatchModel:
description: Database Configuration
properties:
authenticationType:
$ref: '#/components/schemas/UpdateFieldValueOfSqlAuthenticationType'
connectionTimeout:
$ref: '#/components/schemas/UpdateFieldValueOfOptionalInt32'
databaseName:
$ref: '#/components/schemas/UpdateFieldValueOfString'
enableMultiSubnetFailover:
$ref: '#/components/schemas/UpdateFieldValueOfOptionalBoolean'
enableSslEncryption:
$ref: '#/components/schemas/UpdateFieldValueOfOptionalBoolean'
failoverPartner:
$ref: '#/components/schemas/UpdateFieldValueOfString'
fileOverridePassword:
$ref: '#/components/schemas/UpdateFieldValueOfString'
fileOverrideUserName:
$ref: '#/components/schemas/UpdateFieldValueOfString'
password:
$ref: '#/components/schemas/UpdateFieldValueOfString'
serverName:
$ref: '#/components/schemas/UpdateFieldValueOfString'
trustServerCertificate:
$ref: '#/components/schemas/UpdateFieldValueOfOptionalBoolean'
userName:
$ref: '#/components/schemas/UpdateFieldValueOfString'
type: object
UpdateFieldValueOfString:
description: Description
properties:
dirty:
description: Dirty
type: boolean
value:
description: Value
type: string
type: object
Uri:
description: ContentLocation
properties:
absolutePath:
description: AbsolutePath
type: string
absoluteUri:
description: AbsoluteUri
type: string
authority:
description: Authority
type: string
dnsSafeHost:
description: DnsSafeHost
type: string
fragment:
description: Fragment
type: string
host:
description: Host
type: string
hostNameType:
$ref: '#/components/schemas/UriHostNameType'
idnHost:
description: IdnHost
type: string
isAbsoluteUri:
description: IsAbsoluteUri
type: boolean
isDefaultPort:
description: IsDefaultPort
type: boolean
isFile:
description: IsFile
type: boolean
isLoopback:
description: IsLoopback
type: boolean
isUnc:
description: IsUnc
type: boolean
localPath:
description: LocalPath
type: string
originalString:
description: OriginalString
type: string
pathAndQuery:
description: PathAndQuery
type: string
port:
description: Port
type: integer
format: int32
query:
description: Query
type: string
scheme:
description: Scheme
type: string
segments:
description: Segments
items:
type: string
type: array
userEscaped:
description: UserEscaped
type: boolean
userInfo:
description: UserInfo
type: string
type: object
ConfigurationGeneralUpdateModel:
description: Update configuration, only need to send sections that should be updated
properties:
folders:
$ref: '#/components/schemas/ConfigurationFoldersUpdateModel'
permissionOptions:
$ref: '#/components/schemas/ConfigurationPermissionOptionsUpdateModel'
userExperience:
$ref: '#/components/schemas/ConfigurationUserExperienceUpdateModel'
type: object
Severity:
description: Error severity level
properties: {}
type: string
enum:
- None
- Retry
- Warn
- Critical
- Fatal
AdminAuditItem:
description: Audit entries for administration items
properties:
action:
description: The action that occurred
type: string
dateRecorded:
description: The date the audit entry was recorded
type: string
format: date-time
notes:
description: Extended information for the audit
type: string
userDisplayName:
description: Display Name for the user that made the audit
type: string
userId:
description: The user id of the user that made the audit
type: integer
format: int32
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
SiteConnectorsSummaryModel:
description: SiteConnectorsSummaryModel[]
properties:
active:
description: Active
type: boolean
siteConnectorId:
description: SiteConnectorId
type: integer
format: int32
nullable: true
siteConnectorName:
description: SiteConnectorName
type: string
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
ConfigurationLoginPolicyModel:
description: Login Policy Configuration
properties:
enableLoginPolicy:
description: When true this shows the login policy on the login screen.
type: boolean
forceLoginPolicy:
description: When true this will force the user to check that they accept the login policy that is displayed.
type: boolean
loginPolicy:
description: When EnableLoginPolicy is true this text will be shown to the user on the login page.
type: string
type: object
ConfigurationSamlPatchArgs:
description: ConfigurationSamlPatchArgs
properties:
data:
$ref: '#/components/schemas/ConfigurationSamlPatchModel'
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
AutoExportConfigurationModel:
description: Automatic Export Configuration
properties:
enableAutoExport:
description: Whether automatic export is enabled.
type: boolean
exportChildFolders:
description: Whether child folders are included in the export.
type: boolean
exportFolderPaths:
description: Whether folder paths are included in the export.
type: boolean
exportPasswordSecretId:
description: The ID of the Secret whose value is used to password protect exported data.
type: integer
format: int32
nullable: true
exportPath:
description: Where the exported file is stored if on-prem.
type: string
exportTotpSettings:
description: Whether TOTP settings are included in the export.
type: boolean
folderId:
description: Which folder to automatically export, if none provided then all are exported.
type: integer
format: int32
nullable: true
frequencyDays:
description: How many days between each automatic export.
type: integer
format: int32
lastExported:
description: The last time the automatic export ran.
type: string
format: date-time
nullable: true
userId:
description: The user the export will be run as.
type: integer
format: int32
nullable: true
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
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
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
ConfigurationUserExperienceUpdateModel:
description: Configuration User Experience
properties:
applicationLanguage:
$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'
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
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
ConfigurationInternalSiteConnectorPatchModel:
description: Internal Site Connector Settings
properties:
siteConnectorId:
$ref: '#/components/schemas/UpdateFieldValueOfOptionalInt32'
type: object
ConfigurationSamlIdentityProviderCreateArgs:
description: ConfigurationSamlIdentityProviderCreateArgs
properties:
data:
$ref: '#/components/schemas/ConfigurationSamlIdentityProviderCreateModel'
type: object
AutoExportConfigurationArgs:
description: AutoExportConfigurationArgs
properties:
data:
$ref: '#/components/schemas/AutoExportConfigurationUpdateModel'
type: object
FolderSynchronizationUpdateArgs:
description: FolderSynchronizationUpdateArgs
properties:
data:
$ref: '#/components/schemas/FolderSynchronizationUpdateModel'
type: object
ClearCachedADCredentialsResultModel:
description: A result from clearing cached AD credentials
properties:
success:
description: True is the call succeeded
type: boolean
type: object
DpapiEncryptRequestModel:
description: DPAPI Encypt Request
properties:
password:
description: Password for Encryption
type: string
type: object
SearchIndexStatus:
description: The current status of the search secret indexer
properties: {}
type: string
enum:
- NotStarted
- Idle
- Indexing
ConfigurationGeneralModelV3:
description: Configuration General
properties:
applicationSettings:
$ref: '#/components/schemas/ConfigurationApplicationSettingsModel'
email:
$ref: '#/components/schemas/ConfigurationEmailModel'
folders:
$ref: '#/components/schemas/ConfigurationFoldersModel'
launcherSettings:
$ref: '#/components/schemas/ConfigurationLauncherSettingsModel'
localUserPasswords:
$ref: '#/components/schemas/ConfigurationLocalUserPasswordsModel'
login:
$ref: '#/components/schemas/ConfigurationLoginV2Model'
permissionOptions:
$ref: '#/components/schemas/ConfigurationPermissionOptionsModel'
protocolHandlerSettings:
$ref: '#/components/schemas/ConfigurationProtocolHandlerSettingsModel'
security:
$ref: '#/components/schemas/ConfigurationSecurityModel'
sessionRecording:
$ref: '#/components/schemas/ConfigurationSessionRecordingModel'
unlimitedAdmin:
$ref: '#/components/schemas/UnlimitedAdminModel'
userExperience:
$ref: '#/components/schemas/ConfigurationUserExperienceModel'
userInterface:
$ref: '#/components/schemas/ConfigurationUserInterfaceModelV2'
type: object
DpapiDecryptArgs:
description: DpapiDecryptArgs
properties:
data:
$ref: '#/components/schemas/DpapiDecryptRequestModel'
type: object
ConfigurationLoginPolicyPatchArgs:
description: ConfigurationLoginPolicyPatchArgs
properties:
data:
$ref: '#/components/schemas/ConfigurationLoginPolicyPatchModel'
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
MfaConfigurationModel:
description: Current Multifactor Authentication Configuration
properties:
authProfiles:
description: Authentication Profiles
items:
$ref: '#/components/schemas/AuthProfileModel'
type: array
type: object
ViewFieldValueOfInt32:
description: OrganizationId
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
type: integer
format: int32
type: object
UnlimitedAdminUpdateArgs:
description: UnlimitedAdminUpdateArgs
properties:
data:
$ref: '#/components/schemas/UnlimitedAdminUpdateModel'
type: object
ConfigurationSamlIdentityProviderDeleteResultModel:
description: SAML Identity Provider Delete Result
properties:
success:
description: Whether or not the call to Delete was successful
type: boolean
type: object
PagingOfAutoExportLogViewModel:
description: Specify paging and sorting options for querying records and returning results
properties:
batchCount:
description: Number of result batches available with current query options
type: integer
format: int32
currentPage:
description: Index of current result page
type: integer
format: int32
hasNext:
description: Whether there are any results in additional pages
type: boolean
hasPrev:
description: Whether there are any results in previous pages
type: boolean
nextSkip:
description: Correct value of 'skip' for the next page of results
type: integer
format: int32
pageCount:
description: Number of result pages available with current query options
type: integer
format: int32
prevSkip:
description: Correct value of 'skip' for the previous page of results
type: integer
format: int32
records:
description: Query results
items:
$ref: '#/components/schemas/AutoExportLogViewModel'
type: array
severity:
$ref: '#/components/schemas/Severity'
skip:
description: Number of records to skip before taking results
type: integer
format: int32
sortBy:
description: List of sort properties
items:
$ref: '#/components/schemas/Sort'
type: array
success:
description: Whether the query executed successfully
type: boolean
take:
description: Maximum number of records to include in results
type: integer
format: int32
total:
description: Total number of results available
type: integer
format: int32
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
RotateSecretKeysProgressModel:
description: Rotate Secret Keys Progress
properties:
isCancelling:
description: Flag indicating if the request is being cancelled.
type: boolean
message:
description: Message displayed during processing.
type: string
secretsProcessed:
description: Number of Secrets processed thus far in the run.
type: integer
format: int32
totalSecretsToProcess:
description: Total number of secrets to process in the run.
type: integer
format: int32
type: object
MediaTypeHeaderValue:
description: ContentType
properties:
charSet:
description: CharSet
type: string
mediaType:
description: MediaType
type: string
parameters:
description: Parameters
items:
$ref: '#/components/schemas/NameValueHeaderValue'
type: array
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
BackupConfigurationArgs:
description: BackupConfigurationArgs
properties:
data:
$ref: '#/components/schemas/BackupConfigurationUpdateModel'
type: object
ConfigurationSectionAccessModel:
description: Sections
properties:
sectionAccess:
$ref: '#/components/schemas/ConfigurationSectionAccess'
sectionId:
description: SectionId
type: string
type: object
TestRadiusLoginRequestModel:
description: Test Radius Login Request
properties:
radiusPassword:
description: Password for Radius Login Test
type: string
radiusUsername:
description: Username for Radius Login Test
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
FolderSynchronizationMethodType:
description: Defines what type of folder synchronization to use
properties: {}
type: string
enum:
- None
- LegacyDatabaseIntegration
- ApiIntegration
PublicSshKeyConfigurationViewModel:
description: User public ssh keys expiration
properties:
enabled:
description: User Public SSH Key Authentication is enabled
type: boolean
expirationMessage:
description: Expiration Message
type: string
isPassphraseRequired:
description: Indicates whether or not a passphrase is required when generating the ssh key
type: boolean
type: object
ConfigurationSessionRecordingAdvancedPatchModel:
description: Update session recording advanced configuration
properties:
agentCallbackUrl:
$ref: '#/components/schemas/UpdateFieldValueOfString'
enableAdvancedSessionRecording:
$ref: '#/components/schemas/UpdateFieldValueOfBoolean'
type: object
ViewFieldValueOfOptionalInt32:
description: Maximum number of messages to keep in log. When null, it is unlimited
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
type: integer
format: int32
nullable: true
type: object
ConfigurationEmailPatchArgs:
description: ConfigurationEmailPatchArgs
properties:
data:
$ref: '#/components/schemas/ConfigurationEmailPatchModel'
type: object
ConfigurationLauncherSettingsPatchArgs:
description: ConfigurationLauncherSettingsPatchArgs
properties:
data:
$ref: '#/components/schemas/ConfigurationLauncherSettingsPatchModel'
type: object
ConfigurationInternalSiteConnectorPatchArgs:
description: ConfigurationInternalSiteConnectorPatchArgs
properties:
data:
$ref: '#/components/schemas/ConfigurationInternalSiteConnectorPatchModel'
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
HttpContentHeaders:
description: Headers
properties:
allow:
description: Allow
items:
type: string
type: array
contentDisposition:
$ref: '#/components/schemas/ContentDispositionHeaderValue'
contentEncoding:
description: ContentEncoding
items:
type: string
type: array
contentLanguage:
description: ContentLanguage
items:
type: string
type: array
contentLength:
description: ContentLength
type: integer
format: int64
nullable: true
contentLocation:
$ref: '#/components/schemas/Uri'
contentMD5:
description: ContentMD5
type: string
format: binary
contentRange:
$ref: '#/components/schemas/ContentRangeHeaderValue'
contentType:
$ref: '#/components/schemas/MediaTypeHeaderValue'
expires:
$ref: '#/components/schemas/OptionalDateTimeOffset'
lastModified:
$ref: '#/components/schemas/OptionalDateTimeOffset'
type: object
ViewFieldValueOfForceRequireTicketSystemOptions:
description: ForceRequireTicketNumber
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/ForceRequireTicketSystemOptions'
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
ConfigurationSamlIdentityProviderCreateModel:
description: Data
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
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
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
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
ViewFieldValueOfOptionalBmcIncidentManagementCommentWorkType:
description: BmcIncidentManagementCommentWorkType
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
type: string
nullable: true
type: object
ConfigurationLoginV2PatchArgs:
description: ConfigurationLoginV2PatchArgs
properties:
data:
$ref: '#/components/schemas/ConfigurationLoginV2PatchModel'
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
AutoExportConfigurationAuditViewModel:
description: Automatic Export Configuration Audit
properties:
action:
description: Action
type: string
date:
description: Date
type: string
format: date-time
displayName:
description: DisplayName
type: string
notes:
description: Notes
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
SystemLogConfigurationUpdateModel:
description: System Log Configuration Update Model
properties:
allowViewingOnline:
$ref: '#/components/schemas/UpdateFieldValueOfBoolean'
enableSystemLog:
$ref: '#/components/schemas/UpdateFieldValueOfBoolean'
maxLogLength:
$ref: '#/components/schemas/UpdateFieldValueOfOptionalInt32'
notifyWhenShrunk:
$ref: '#/components/schemas/UpdateFieldValueOfBoolean'
type: object
PagingOfAutoExportStorageItemViewModel:
description: Specify paging and sorting options for querying records and returning results
properties:
batchCount:
description: Number of result batches available with current query options
type: integer
format: int32
currentPage:
description: Index of current result page
type: integer
format: int32
hasNext:
description: Whether there are any results in additional pages
type: boolean
hasPrev:
description: Whether there are any results in previous pages
type: boolean
nextSkip:
description: Correct value of 'skip' for the next page of results
type: integer
format: int32
pageCount:
description: Number of result pages available with current query options
type: integer
format: int32
prevSkip:
description: Correct value of 'skip' for the previous page of results
type: integer
format: int32
records:
description: Query results
items:
$ref: '#/components/schemas/AutoExportStorageItemViewModel'
type: array
severity:
$ref: '#/components/schemas/Severity'
skip:
description: Number of records to skip before taking results
type: integer
format: int32
sortBy:
description: List of sort properties
items:
$ref: '#/components/schemas/Sort'
type: array
success:
description: Whether the query executed successfully
type: boolean
take:
description: Maximum number of records to include in results
type: integer
format: int32
total:
description: Total number of results available
type: integer
format: int32
type: object
PlatformConfigurationUpdateModel:
description: Data
properties:
createGroupsDuringSynchronization:
$ref: '#/components/schemas/UpdateFieldValueOfBoolean'
enablePlatformAuditIntegration:
$ref: '#/components/schemas/UpdateFieldValueOfBoolean'
enablePlatformInventoryForwarding:
$ref: '#/components/schemas/UpdateFieldValueOfBoolean'
enablePlatformOnLoginPage:
$ref: '#/components/schemas/UpdateFieldValueOfOptionalBoolean'
openIdConnectClientId:
$ref: '#/components/schemas/UpdateFieldValueOfString'
openIdConnectClientSecret:
$ref: '#/components/schemas/UpdateFieldValueOfString'
openIdConnectEnabled:
$ref: '#/components/schemas/UpdateFieldValueOfBoolean'
openIdConnectLoginUrl:
$ref: '#/components/schemas/UpdateFieldValueOfString'
openIdConnectLogoutUrl:
$ref: '#/components/schemas/UpdateFieldValueOfString'
platformPermissionCacheExpirationInMinutes:
$ref: '#/components/schemas/UpdateFieldValueOfInt32'
profileName:
$ref: '#/components/schemas/UpdateFieldValueOfString'
provisioningMode:
$ref: '#/components/schemas/UpdateFieldValueOfOptionalInt32'
requirePlatformMfa:
$ref: '#/components/schemas/UpdateFieldValueOfBoolean'
synchronizationIntervalDays:
$ref: '#/components/schemas/UpdateFieldValueOfInt32'
synchronizationIntervalHours:
$ref: '#/components/schemas/UpdateFieldValueOfInt32'
usePlatformSettings:
$ref: '#/components/schemas/UpdateFieldValueOfOptionalBoolean'
type: object
BackupConfigurationModel:
description: Database Backup Configuration
properties:
backupDatabasePath:
description: Where to backup the database
type: string
backupFailureNotification:
description: Whether or not to send an email if backup fails
type: boolean
backupPath:
description: Where to store the web application backup files
type: string
backupStartDateTime:
description: The next time the backup will run
type: string
format: date-time
configurationSqlBackupTimeoutMinutes:
description: SQL Timeout when running the backup
type: integer
format: int32
copyOnlyDatabaseBackup:
description: Backup type
type: boolean
enableDatabaseBackup:
description: Whether or not the backup the database
type: boolean
enableScheduledBackup:
description: Is the backup enabled
type: boolean
enableTmsBackup:
description: Whether or not the TMS web files are backed up
type: boolean
enableWebApplicationBackup:
description: Whether or not the web application is set to backup
type: boolean
numberOfBackupsToKeep:
description: How many backups should be kept (deletes oldest)
type: integer
format: int32
repeatDays:
description: How many days between backups
type: integer
format: int32
repeatHours:
description: How many hours between backups
type: integer
format: int32
repeatMinutes:
description: How many minutes between backups
type: integer
format: int32
tmsInstallationPath:
description: Where TMS is installed
type: string
type: object
ConfigurationTicketSystemArgs:
description: ConfigurationTicketSystemArgs
properties:
data:
description: Data
items:
$ref: '#/components/schemas/TicketSystemPatchModel'
type: array
type: object
SyslogCefDateTimeFormatType:
description: Value
properties: {}
type: string
enum:
- Syslog
- ISO8601
TestEmailResponse:
description: TestEmailResponse
properties:
message:
description: Message
type: string
success:
description: Success
type: boolean
type: object
ConfigurationHeartbeatRunNowResultModel:
description: Heartbeat Run Now Result
properties:
success:
description: Whether or not the call to Run Now was successful
type: boolean
type: object
ConfigurationProtocolHandlerSettingsPatchArgs:
description: ConfigurationProtocolHandlerSettingsPatchArgs
properties:
data:
$ref: '#/components/schemas/ConfigurationProtocolHandlerSettingsPatchModel'
type: object
SqlAuthenticationType:
description: The type of authentication method used for connecting to the sql server.
properties: {}
type: string
enum:
- WindowsAuth
- SqlAuth
- AADIntegrated
- AADSqlAuth
TestRadiusLoginArgs:
description: TestRadiusLoginArgs
properties:
data:
$ref: '#/components/schemas/TestRadiusLoginRequestModel'
type: object
ConfigurationFoldersPatchArgs:
description: ConfigurationFoldersPatchArgs
properties:
data:
$ref: '#/components/schemas/ConfigurationFoldersPatchModel'
type: object
UpdateFieldValueOfOptionalBoolean:
description: Use RADIUS Username for DUO
properties:
dirty:
description: Dirty
type: boolean
value:
description: Value
type: boolean
nullable: true
type: object
UriHostNameType:
description: HostNameType
properties: {}
type: string
enum:
- Unknown
- Basic
- Dns
- IPv4
- IPv6
UpdateFieldValueOfForceRequireTicketSystemOptions:
description: Ticket System Comment and/or Number Requirement
properties:
dirty:
description: Dirty
type: boolean
value:
$ref: '#/components/schemas/ForceRequireTicketSystemOptions'
type: object
ConfigurationSessionRecordingAdvancedPatchArgs:
description: ConfigurationSessionRecordingAdvancedPatchArgs
properties:
data:
$ref: '#/components/schemas/ConfigurationSessionRecordingAdvancedPatchModel'
type: object
AutoExportStorageItemViewModel:
description: Details for an item in automatic export storage.
properties:
autoExportConfigurationId:
description: The ID for the configuration this item used.
type: integer
format: int32
canDownload:
description: Whether the user can download this item.
type: boolean
filename:
description: The name of the file stored.
type: string
id:
description: The ID for this item in storage.
type: integer
format: int32
storageDate:
description: The date and time this item was stored.
type: string
format: date-time
type: object
ConfigurationPermissionOptionsUpdateModel:
description: Configuration Permission Options
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
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
ConfigurationUserExperiencePatchArgs:
description: ConfigurationUserExperiencePatchArgs
properties:
data:
$ref: '#/components/schemas/ConfigurationUserExperiencePatchModel'
type: object
UpdateFieldValueOfSearchIndexMode:
description: 'The index mode: standard or extended'
properties:
dirty:
description: Dirty
type: boolean
value:
$ref: '#/components/schemas/SearchIndexMode'
type: object
ViewFieldValueOfOptionalBmcChangeManagementCommentWorkType:
description: BmcChangeManagementCommentWorkType
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
type: string
nullable: true
type: object
TestSyslogResponseModel:
description: Result of a syslog test
properties:
description:
description: If there is any information about the failure it will be provided as the description
type: string
success:
description: True indicates syslog message was sent without error.
type: boolean
type: object
PagingOfConfigurationAuditItem:
description: Specify paging and sorting options for querying records and returning results
properties:
batchCount:
description: Number of result batches available with current query options
type: integer
format: int32
currentPage:
description: Index of current result page
type: integer
format: int32
hasNext:
description: Whether there are any results in additional pages
type: boolean
hasPrev:
description: Whether there are any results in previous pages
type: boolean
nextSkip:
description: Correct value of 'skip' for the next page of results
type: integer
format: int32
pageCount:
description: Number of result pages available with current query options
type: integer
format: int32
prevSkip:
description: Correct value of 'skip' for the previous page of results
type: integer
format: int32
records:
description: Query results
items:
$ref: '#/components/schemas/ConfigurationAuditItem'
type: array
severity:
$ref: '#/components/schemas/Severity'
skip:
description: Number of records to skip before taking results
type: integer
format: int32
sortBy:
description: List of sort properties
items:
$ref: '#/components/schemas/Sort'
type: array
success:
description: Whether the query executed successfully
type: boolean
take:
description: Maximum number of records to include in results
type: integer
format: int32
total:
description: Total number of results available
type: integer
format: int32
type: object
AuthProfileModel:
description: Authentication Profiles
properties:
id:
description: Id
type: string
format: uuid
isCurrent:
description: IsCurrent
type: boolean
name:
description: Name
type: string
type: object
ConfigurationInternalSiteConnectorModel:
description: Internal Site Connector Settings
properties:
siteConnectorId:
description: Site connector that is used internally by Secret Server
type: integer
format: int32
nullable: true
type: object
FolderSynchronizationUpdateModel:
description: Data
properties:
companyId:
$ref: '#/components/schemas/UpdateFieldValueOfString'
daysToKeepOperationalLogs:
$ref: '#/components/schemas/UpdateFieldValueOfInt32'
folderStructure:
$ref: '#/components/schemas/UpdateFieldValueOfString'
integratorCredentials:
$ref: '#/components/schemas/UpdateFieldValueOfInt32'
intervalDays:
$ref: '#/components/schemas/UpdateFieldValueOfInt32'
intervalHours:
$ref: '#/components/schemas/UpdateFieldValueOfInt32'
intervalMinutes:
$ref: '#/components/schemas/UpdateFieldValueOfInt32'
siteUrl:
$ref: '#/components/schemas/UpdateFieldValueOfString'
sqlCustomView:
$ref: '#/components/schemas/UpdateFieldValueOfString'
sqlDatabaseName:
$ref: '#/components/schemas/UpdateFieldValueOfString'
sqlPassword:
$ref: '#/components/schemas/UpdateFieldValueOfString'
sqlServerLocation:
$ref: '#/components/schemas/UpdateFieldValueOfString'
sqlUsername:
$ref: '#/components/schemas/UpdateFieldValueOfString'
syncAllFolders:
$ref: '#/components/schemas/UpdateFieldValueOfBoolean'
syncFolderId:
$ref: '#/components/schemas/UpdateFieldValueOfInt32'
syncMethodType:
$ref: '#/components/schemas/UpdateFieldValueOfFolderSynchronizationMethodType'
type: object
PagingOfAdminAuditItem:
description: Specify paging and sorting options for querying records and returning results
properties:
batchCount:
description: Number of result batches available with current query options
type: integer
format: int32
currentPage:
description: Index of current result page
type: integer
format: int32
hasNext:
description: Whether there are any results in additional pages
type: boolean
hasPrev:
description: Whether there are any results in previous pages
type: boolean
nextSkip:
description: Correct value of 'skip' for the next page of results
type: integer
format: int32
pageCount:
description: Number of result pages available with current query options
type: integer
format: int32
prevSkip:
description: Correct value of 'skip' for the previous page of results
type: integer
format: int32
records:
description: Query results
items:
$ref: '#/components/schemas/AdminAuditItem'
type: array
severity:
$ref: '#/components/schemas/Severity'
skip:
description: Number of records to skip before taking results
type: integer
format: int32
sortBy:
description: List of sort properties
items:
$ref: '#/components/schemas/Sort'
type: array
success:
description: Whether the query executed successfully
type: boolean
take:
description: Maximum number of records to include in results
type: integer
format: int32
total:
description: Total number of results available
type: integer
format: int32
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
UnlimitedAdminModel:
description: Unlimited Admin Configuration
properties:
enabled:
description: State of Unlimited Admin Mode
type: boolean
type: object
StreamContent:
description: StreamContent
properties:
headers:
$ref: '#/components/schemas/HttpContentHeaders'
type: object
ConfigurationUserInterfaceModelV2:
description: User interface settings
properties:
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
isCustomBannerDismissable:
description: Is the global banner able to be dismissed by a user
type: boolean
showCustomBanner:
description: Should the global banner be shown
type: boolean
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
ConfigurationLoginPolicyPatchModel:
description: Login Policy Configuration
properties:
enableLoginPolicy:
$ref: '#/components/schemas/UpdateFieldValueOfBoolean'
forceLoginPolicy:
$ref: '#/components/schemas/UpdateFieldValueOfBoolean'
loginPolicy:
$ref: '#/components/schemas/UpdateFieldValueOfString'
type: object
ConfigurationPermissionOptionsPatchArgs:
description: ConfigurationPermissionOptionsPatchArgs
properties:
data:
$ref: '#/components/schemas/ConfigurationPermissionOptionsPatchModel'
type: object
DpapiEncryptStateModel:
description: DPAPI Encryption State
properties:
configFilePath:
description: Local path to the config file that is/will be encrypted
type: string
isDpapiEncrypted:
description: True if system is currently encrypted using DPAPI
type: boolean
isHsmEncrypted:
description: True if system is currently encrypted using HSM
type: boolean
type: object
ConfigurationSamlIdentityProviderImportArgs:
description: ConfigurationSamlIdentityProviderImportArgs
properties:
importFile:
description: 'Uploaded file (used for file attachment fields with "Content-Type: multipart/form-data")'
type: string
format: binary
importFileData:
description: 'Binary file data (used for file attachment fields with "Content-Type: application/json")'
type: string
format: binary
type: object
ConfigurationTicketSystemViewModel:
description: Ticket System Configuration
properties:
ticketSystemList:
description: List of Ticket Systems
items:
$ref: '#/components/schemas/TicketSystemViewModel'
type: array
type: object
SettingsMenuModel:
description: Defines options for the settings menu
properties:
hidden:
description: All of the content IDs that are not available in this instance
items:
type: string
type: array
privilegeManagerLink:
description: Link to priv man, if installed
type: string
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