openapi: 3.0.0 info: title: Secret Server Rest Activations Bundle 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: Bundle description: Export and Import Bundles paths: /v1/bundle/export: post: tags: - Bundle summary: Get Bundle description: Get Bundle for Discovery Source operationId: BundleService_GetExport requestBody: content: application/json: schema: $ref: '#/components/schemas/ExportBundleArgs' description: args responses: '200': description: Bundle content: application/json: schema: $ref: '#/components/schemas/BundleSettingsModel' '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: ScriptSshAdditionalDataModel: description: Additional settings for SSH scripts properties: doNotUseEnvironment: description: Do not use environment variables in script type: boolean lineEnding: $ref: '#/components/schemas/SshScriptLineEndingType' parameters: description: Any parameters that can be used in the script items: $ref: '#/components/schemas/ScriptSshParameterModel' type: array port: description: The port that should be used by an SSH script type: integer format: int32 nullable: true type: object RunnerType: description: Runner Type properties: {} type: string enum: - Standard - Legacy DiscoveryCommandSetModel: description: Discovery Command Set properties: actions: $ref: '#/components/schemas/DiscoveryCommandSetActionsModel' commands: description: The actual commands that will run in the shell for this command set type: string commandSetId: description: Unique ID for the command set type: integer format: int32 commandSetName: description: Name of the command set type: string discoveryScannerId: description: 'Defines the scan type ID: 1 = SSH, 2 = ODBC' type: integer format: int32 isActive: description: Indicates if this command set is active type: boolean isStandard: description: Indicates if this is a standard out of the box command set type: boolean scanTypeId: description: 'Defines the scan type ID: 1 = host, 2 = machine, 3 = account, 4 = dependency' type: integer format: int32 scanTypeName: description: The name of the scan type type: string type: object ExportBundleArgs: description: ExportBundleArgs properties: data: $ref: '#/components/schemas/ExportBundleSettingsModel' type: object MachineNameResolutionType: description: Use machine name and FQDM or only use machine name properties: {} type: string enum: - UseMachineNameAndFQDM - OnlyUseMachineName DropDownOption: description: DropDownOptions properties: localizeKey: description: LocalizeKey type: string optionValue: description: OptionValue type: string type: object IRestPasswordTypeField: description: Password Type Fields properties: isOptional: description: IsOptional type: boolean name: description: Name type: string passwordTypeFieldId: description: PasswordTypeFieldId type: integer format: int32 scanItemFieldId: description: ScanItemFieldId type: integer format: int32 nullable: true type: object DiscoveryScannerActionsModel: description: Defines the actions that the current user can perform on the scanner properties: canEdit: description: Can the current user edit this scanner type: boolean canEditInputTemplate: description: Can the current user change the input template type: boolean canEditOutputTemplate: description: Can the current user change the output template type: boolean type: object ScriptSshParamType: description: ParameterSshType properties: {} type: string enum: - Intrepreted - Literal 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 SettingDependency: description: SettingDependency properties: dependentOnValue: description: DependentOnValue type: boolean dependentScanType: description: DependentScanType type: integer format: int32 type: object EditRequiresOptions: description: What option is required to edit this field including Owner, Edit, and Not Editable properties: {} type: string enum: - Edit - Owner - NotEditable DiscoveryScannerDetailItemModel: description: The scanner settings for this scanner on this discovery source properties: determinesAuthentication: description: DeterminesAuthentication type: boolean displayName: description: DisplayName type: string dropDownOptions: description: DropDownOptions items: $ref: '#/components/schemas/ViewFieldDropDownOption' type: array editable: description: Editable type: boolean fieldType: description: FieldType type: integer format: int32 name: description: Name type: string regexValidation: description: RegexValidation type: string tooltip: description: Tooltip type: string value: description: Value type: string visible: description: Visible type: boolean 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 ScriptModelV2: description: Script properties: additionalData: $ref: '#/components/schemas/ScriptAdditionalDataModel' concurrencyId: description: Script Global Id type: string description: description: Script Description type: string isActive: description: Whether the Script is Active type: boolean name: description: Script Name type: string script: description: Script Text type: string scriptCategoryId: description: Script Category Id type: integer format: int32 scriptCategoryName: description: Script Category Name type: string scriptId: description: Script Id type: integer format: int32 scriptType: $ref: '#/components/schemas/UserScriptType' usageCount: description: Usage Count type: integer format: int32 type: object BundleSettingsModel: description: BundleSettingsModel properties: configurationVersion: description: Export Configuration Version type: string discoveryCommandSets: description: Discovery Command Sets items: $ref: '#/components/schemas/DiscoveryCommandSetModel' type: array discoveryScanTemplates: description: Scan Item Templates items: $ref: '#/components/schemas/DiscoveryScanTemplateModel' type: array discoverySource: $ref: '#/components/schemas/DiscoverySourceModel' externalInstanceId: description: ID for specific instance type: string format: uuid passwordChangers: description: Password Changers items: $ref: '#/components/schemas/PasswordTypeModel' type: array scanItemTemplates: description: Scan Item Templates items: $ref: '#/components/schemas/DiscoveryScanTemplateModel' type: array scanners: description: Scanners items: $ref: '#/components/schemas/ScannerBundle' type: array scripts: description: Scripts items: $ref: '#/components/schemas/ScriptModelV2' type: array secretTemplates: description: Secret Templates items: $ref: '#/components/schemas/SecretTemplateModel' type: array type: object ScriptSqlParamType: description: ParameterDbType properties: {} type: string enum: - AnsiString - Binary - Byte - Boolean - Currency - Date - DateTime - Decimal - Double - Guid - Int16 - Int32 - Int64 - Object - SByte - Single - String - Time - UInt16 - UInt32 - UInt64 - VarNumeric - AnsiStringFixedLength - StringFixedLength - Xml - DateTime2 - DateTimeOffset DiscoveryScanTemplateActionsModel: description: Actions that the current user can perforom on the scan template properties: canEdit: description: Can the current user edit the scan template type: boolean type: object RequiredScanTypes: description: RequiredScanTypes properties: hostRangeScannerIds: description: HostRangeScannerIds items: type: integer format: int32 type: array machineScannerIds: description: MachineScannerIds items: type: integer format: int32 type: array type: object PasswordTypeModel: description: Displays the properties of a Password Type properties: active: description: 'Whether the Password Type is Active ' type: boolean allowsPrivilegedAccount: description: Allows a Default Privileged Account type: boolean canEdit: description: Whether the Password Type can be edited type: boolean concurrencyId: description: Globally unique Id type: string customPort: description: Custom Port type: integer format: int32 exitCommand: description: Exit Command type: string fields: description: Password Type Fields items: $ref: '#/components/schemas/IRestPasswordTypeField' type: array hasCommands: description: Whether Commands Exist type: boolean hasLDAPSettings: description: Whether LDAP Settings Exist type: boolean heartbeatScriptArgs: description: Heartbeat Script Args type: string heartbeatScriptId: description: Heartbeat Script Id type: integer format: int32 nullable: true ignoreSSL: description: Whether Password Type ignores SSL warnings type: boolean isWeb: description: Whether Is Web type: boolean ldapConnectionSettingsId: description: LDAP Connection Settings Id type: integer format: int32 nullable: true lineEnding: $ref: '#/components/schemas/LineEnding' mainframeConnectionString: description: Mainframe Connection String type: string name: description: Password Type Name type: string odbcConnectionString: description: ODBC Connection String type: string passwordTypeId: description: Password Type Id type: integer format: int32 requestTerminal: description: Request Terminal type: boolean rpcScriptArgs: description: RPC Script Args type: string rpcScriptId: description: RPC Script Id type: integer format: int32 nullable: true runnerType: $ref: '#/components/schemas/RunnerType' scanItemTemplateId: description: Scan Template Id type: integer format: int32 nullable: true supportsCustomSettings: description: Identifies if changer supports custom settings type: boolean supportsIgnoreSslErrors: description: Identifies if changer supports ignoring of SSL errors type: boolean supportsSsl: description: Identifies if changer supports SSL type: boolean supportsTakeOver: description: Identifies if changer supports take over type: boolean supportsUseSsl: description: Identifies if changer supports Use of SSL type: boolean typeName: description: Federator Type type: string useSSL: description: Whether Password Type uses SSL type: boolean useUsernameAndPassword: description: Whether Password Type uses both Username and Password type: boolean validForTakeover: description: Whether is Valid For Takeover type: boolean windowsCustomPorts: description: Custom Ports for Windows type: string type: object DropDownOptionForDisplay: description: DropDownOptionsForDisplay properties: localizeKey: description: LocalizeKey type: string nameForDisplay: description: NameForDisplay type: string optionValue: description: OptionValue type: string type: object SshScriptLineEndingType: description: The type of line ending that should be sent to the script properties: {} type: string enum: - NewLine - CarriageReturn - CarriageReturnNewLine ScriptSshParameterModel: description: Any parameters that can be used in the script properties: parameterName: description: ParameterName type: string parameterSshType: $ref: '#/components/schemas/ScriptSshParamType' type: object UserScriptType: description: Script Type (Powershell = 1, SQL = 2, SSH = 3) properties: {} type: string enum: - PowerShell - SQL - SSH ScriptAdditionalDataModel: description: Additional data for this script including parameters and settings properties: sqlSettings: $ref: '#/components/schemas/ScriptSqlAdditionalDataModel' sshSettings: $ref: '#/components/schemas/ScriptSshAdditionalDataModel' type: object ScannerBundle: description: Scanners properties: defaultDiscoverySettingForDisplays: description: DefaultDiscoverySettingForDisplays items: $ref: '#/components/schemas/DefaultDiscoverySettingForDisplay' type: array discoveryScannerDetail: $ref: '#/components/schemas/DiscoveryScannerDetailModel' scanner: $ref: '#/components/schemas/DiscoveryScannerModel' type: object DiscoveryScannerCredentialModel: description: The credentials used by this discovery source properties: secretId: description: SecretId type: integer format: int32 nullable: true secretName: description: SecretName type: string secretNameSearchPattern: description: SecretNameSearchPattern type: string secretSearchFilterId: description: SecretSearchFilterId type: integer format: int32 nullable: true sortOrder: description: SortOrder type: integer format: int32 type: object AuthenticationFailedResponse: description: Response object for authentication failures required: - message properties: message: description: Error message type: string type: object DiscoveryScannerModel: description: Scanner Model properties: actions: $ref: '#/components/schemas/DiscoveryScannerActionsModel' baseScannerId: description: The base scanner ID type: integer format: int32 baseScannerName: description: The name of the base scanner type: string commandSetId: description: The specific command set ID if this is an SSH scanner type: integer format: int32 nullable: true commandSetName: description: The specific command set ID if this is an SSH scanner type: string concurrencyId: description: Globally unique ID for this scan template type: string dependencyItemScannerDisplayName: description: A localized version of the scanner item name type: string discoveryItemScannerDisplayDescription: description: A localized description for this scanner type: string discoveryItemScannerDisplayName: description: A localized version of the scanner name type: string inputScanItemTemplateId: description: The ID of the input scan template type: integer format: int32 inputTemplateDisplayName: description: A localized name of the input template type: string inputTemplateName: description: The name of the input scan template type: string isActive: description: Indicates if this scanner is active type: boolean isInUse: description: Indicates if this scanner is used in any discover source scanner flows type: boolean itemScannerDescription: description: The description of the scanner type: string itemScannerId: description: Unique ID for this scanner type: integer format: int32 itemScannerName: description: The name of the scanner type: string outputScanItemTemplateId: description: The ID of the output scan template type: integer format: int32 outputTemplateDisplayName: description: A localized name of the output template type: string outputTemplateName: description: The name of the output scan template type: string scannerId: description: The scanner ID for this scanner type: integer format: int32 scannerItems: description: All of the setting values for this scanner items: $ref: '#/components/schemas/DiscoveryScannerDetailItemModel' type: array scanTypeId: description: The scan type (1, 2, 3, 4) type: integer format: int32 scriptArguments: description: Any args that will be passed to the PS scanner script type: string scriptId: description: If this is a PS scanner this is the associated script type: integer format: int32 nullable: true scriptName: description: If this is a PS scanner this is the associated script name type: string type: object ViewFieldDropDownOption: description: DropDownOptions properties: fieldDisplay: description: FieldDisplay type: string fieldValue: description: FieldValue type: string type: object DiscoveryScannerDetailModel: description: Scanner details properties: canEdit: description: Can the scanner be edited type: boolean credentials: description: The credentials used by this discovery source items: $ref: '#/components/schemas/DiscoveryScannerCredentialModel' type: array discoveryItemScannerDescription: description: The description of the scanner type: string discoveryItemScannerDisplayName: description: The localized name of the scanner type: string discoveryItemScannerId: description: The ID for the instance of this scanner type for this discovery source type: integer format: int32 discoveryItemScannerName: description: The name of the scanner type: string discoveryScannerId: description: The ID for the type of scanner type: integer format: int32 discoverySourceId: description: Which discovery source is this scanner associated to type: integer format: int32 inputScanItemTemplateDisplayName: description: The localized name of the input template type: string inputScanItemTemplateId: description: The input template for this scanner type: integer format: int32 inputScanItemTemplateName: description: The name of the input template type: string isActive: description: Is this scanner active type: boolean outputScanItemTemplateDisplayName: description: The localized name of the output scan template type: string outputScanItemTemplateId: description: The output scan template ID type: integer format: int32 outputScanItemTemplateName: description: The name of the output scan template type: string scannerItems: description: The scanner settings for this scanner on this discovery source items: $ref: '#/components/schemas/DiscoveryScannerDetailItemModel' type: array sortOrder: description: The sort order for this scanner type: integer format: int32 type: object ScriptSqlAdditionalDataModel: description: Additional settings for SQL scripts properties: database: description: The database name to connect to type: string parameters: description: Parameters for this sql script items: $ref: '#/components/schemas/ScriptSqlParamModel' type: array passwordChangerId: description: Which password changer this is used with type: integer format: int32 passwordChangerName: description: Which password changer this is used with type: string port: description: A specific port to use type: integer format: int32 nullable: true type: object DiscoveryCommandSetActionsModel: description: Indicates the actions the current user can perform on this command set properties: canEdit: description: Indicates if the current user can edit this command set type: boolean type: object ExportBundleSettingsModel: description: Data properties: discoverySourceId: description: DiscoverySourceId type: integer format: int32 nullable: true passwordTypeIds: description: PasswordTypeIds items: type: integer format: int32 type: array type: object DiscoveryScanTemplateFieldModel: description: Scan template field properties: includeInMatch: description: Include this field in the matching to find unique items type: boolean isActive: description: indicates if this field is active type: boolean isRequired: description: Indicates if this field is required type: boolean parentScanItemFieldId: description: The ID of the parent field type: integer format: int32 nullable: true parentScanItemFieldName: description: The name of the parent field type: string scanItemFieldId: description: Scan template field ID type: integer format: int32 scanItemFieldName: description: The name of the field type: string scanItemTemplateId: description: Which scan template does this field belong to type: integer format: int32 sortOrder: description: The sort order for this field type: integer format: int32 systemField: description: IS this a system field type: boolean type: object DiscoverySourceModel: description: Discovery Source Settings properties: active: description: Is discovery source active type: boolean daysToKeepMachines: description: Days To Keep Machines type: integer format: int32 discoverSpecificOUs: description: Discover specific OUs type: boolean discoveryScannerId: description: Discovery scanner ID type: string nullable: true discoverySourceId: description: The discovery source ID type: integer format: int32 discoverySourceSettings: $ref: '#/components/schemas/DiscoverySourceSettingsModel' lastDiscoveryRunDate: description: Last discovery run date type: string format: date-time nullable: true machineNameResolutionType: $ref: '#/components/schemas/MachineNameResolutionType' name: description: The discovery source naame type: string secretId: description: Default Discovery Secret credentials type: integer format: int32 nullable: true siteId: description: The site ID type: integer format: int32 type: object DefaultDiscoverySettingForDisplay: description: DefaultDiscoverySettingForDisplays properties: determinesAuthentication: description: DeterminesAuthentication type: boolean dropDownOptions: description: DropDownOptions items: $ref: '#/components/schemas/DropDownOption' type: array dropDownOptionsForDisplay: description: DropDownOptionsForDisplay items: $ref: '#/components/schemas/DropDownOptionForDisplay' type: array editable: description: Editable type: boolean hasError: description: HasError type: boolean name: description: Name type: string nameForDisplay: description: NameForDisplay type: string nameLocalizeKey: description: NameLocalizeKey type: string regexValidation: description: RegexValidation type: string requiredScanTypes: $ref: '#/components/schemas/RequiredScanTypes' settingDependency: $ref: '#/components/schemas/SettingDependency' tooltipForDisplay: description: TooltipForDisplay type: string tooltipLocalizeKey: description: TooltipLocalizeKey type: string type: description: Type type: integer format: int32 value: description: Value type: string visible: description: Visible type: boolean type: object SecretTemplateModel: description: Secret template properties: concurrencyId: description: Global unique identifier type: string fields: description: Secret template fields items: $ref: '#/components/schemas/SecretTemplateField' type: array id: description: Secret template Id type: integer format: int32 name: description: Secret template name type: string passwordTypeId: description: Password Type Id type: integer format: int32 nullable: true type: object ListType: description: What type of contents does this list field contain properties: {} type: string enum: - None - Generic - URL ScriptSqlParamModel: description: Parameters for this sql script properties: parameterDbType: $ref: '#/components/schemas/ScriptSqlParamType' parameterName: description: ParameterName type: string type: object SecretTemplateField: description: Secret template field properties: description: description: Field description type: string displayName: description: Field display name type: string editablePermission: description: Who has editing rights type: integer format: int32 editRequires: $ref: '#/components/schemas/EditRequiresOptions' fieldSlugName: description: Field Slug Name type: string generatePasswordCharacterSet: description: Generate password character set. Only returned if user can manage secret templates type: string generatePasswordLength: description: Generate password length. Only returned if user can manage secret templates type: integer format: int32 nullable: true hideOnView: description: Hide this field when viewing type: boolean historyLength: description: History length type: integer format: int32 isExpirationField: description: Is expiration field type: boolean isFile: description: Is this field a file type type: boolean isIndexable: description: Is able to be indexed type: boolean isList: description: Is this field a list field type type: boolean isNotes: description: Is this field a notes field type type: boolean isPassword: description: Is this field a password field type type: boolean isRequired: description: Is this field required type: boolean isUrl: description: Is this field a url field type type: boolean listType: $ref: '#/components/schemas/ListType' mustEncrypt: description: Must encrypt. Only returned if user can manage secret templates type: boolean nullable: true name: description: Field name type: string passwordRequirementId: description: ID For Password Requirement assigned to field type: integer format: int32 passwordTypeFieldId: description: Type of password field type: integer format: int32 secretTemplateFieldId: description: Field Id type: integer format: int32 sortOrder: description: Sort Order for Field type: integer format: int32 type: object DiscoverySourceSettingsModel: description: Additional settings for discovery source properties: daysToKeepMachines: description: Days To Keep Machines type: string nullable: true distinguishedName: description: The domain distinguished name type: string domainType: description: 'Domain type: ActiveDirectory, OpenLdap, or AzureActiveDirectory' type: string nullable: true friendlyName: description: The domain friendly name type: string fullyQualifiedDomainName: description: The fully qualified domain name type: string netBIOSName: description: The NetBIOS name type: string useSecureLDAP: description: Use secure LDAP type: boolean type: object LineEnding: description: Line ending type properties: {} type: string enum: - NewLine - CarriageReturn - CarriageReturnNewLine DiscoveryScanTemplateModel: description: Discovery scan template properties: actions: $ref: '#/components/schemas/DiscoveryScanTemplateActionsModel' concurrencyId: description: Globally unique ID for this scan template type: string isActive: description: Indicates if this template is active type: boolean isInUse: description: Will return true if in use. A scan template cannot be modified once it is in use. type: boolean parentConcurrencyId: description: The globally unique id of the parent template if it has one type: string parentScanTemplateId: description: The ID of the parent template if it has one type: integer format: int32 nullable: true parentScanTemplateName: description: The name of the parent scan template type: string scanTemplateFields: description: The fields on this template items: $ref: '#/components/schemas/DiscoveryScanTemplateFieldModel' type: array scanTemplateId: description: The unique ID for this scan template type: integer format: int32 scanTemplateName: description: The name of this template type: string scanTypeId: description: The scan type ID type: integer format: int32 scanTypeName: description: The name of the scan type 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