netsparker-cloud

/** * Invicti Enterprise API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: v1 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import { RequestFile } from './models'; import { AdditionalWebsiteModel } from './additionalWebsiteModel'; import { ApiFileModel } from './apiFileModel'; import { BasicAuthenticationSettingModel } from './basicAuthenticationSettingModel'; import { ClientCertificateAuthenticationApiModel } from './clientCertificateAuthenticationApiModel'; import { ExcludedLinkModel } from './excludedLinkModel'; import { ExcludedUsageTrackerModel } from './excludedUsageTrackerModel'; import { FormAuthenticationSettingModel } from './formAuthenticationSettingModel'; import { HeaderAuthenticationModel } from './headerAuthenticationModel'; import { OAuth2SettingApiModel } from './oAuth2SettingApiModel'; import { PreRequestScriptSettingModel } from './preRequestScriptSettingModel'; import { ScanTimeWindowModel } from './scanTimeWindowModel'; import { ScheduledScanRecurrenceApiModel } from './scheduledScanRecurrenceApiModel'; import { SharkModel } from './sharkModel'; import { UrlRewriteExcludedPathModel } from './urlRewriteExcludedPathModel'; import { UrlRewriteRuleModel } from './urlRewriteRuleModel'; /** * Contains properties that required to start scheduled scan. */ export class NewScheduledScanApiModel { /** * Gets or sets the name. */ 'name': string; /** * Gets or sets the next execution time. Date string must be in the same format as in the account settings. */ 'nextExecutionTime': string; /** * Gets or sets the run interval of scheduled scan. */ 'scheduleRunType': NewScheduledScanApiModel.ScheduleRunTypeEnum; 'customRecurrence'?: ScheduledScanRecurrenceApiModel; /** * Gets or sets the target URI. */ 'targetUri': string; /** * Gets or sets the additional websites to scan. */ 'additionalWebsites'?: Array<AdditionalWebsiteModel>; 'basicAuthenticationApiModel'?: BasicAuthenticationSettingModel; 'clientCertificateAuthenticationSetting'?: ClientCertificateAuthenticationApiModel; /** * Gets or sets the cookies. Separate multiple cookies with semicolon. Cookie values must be URL encoded. You can use the following format: Cookiename=Value */ 'cookies'?: string; /** * Gets or sets a value indicating whether parallel attacker is enabled. Default: true */ 'crawlAndAttack'?: boolean; /** * Gets or sets a value indicating whether Heuristic URL Rewrite support is enabled together with custom URL Rewrite support. */ 'enableHeuristicChecksInCustomUrlRewrite'?: boolean; /** * Gets or sets the excluded links. Default: \"(log|sign)\\\\-?(out|off)\", \"exit\", \"endsession\", \"gtm\\\\.js\" */ 'excludedLinks'?: Array<ExcludedLinkModel>; /** * Gets or sets the excluded usage trackers. */ 'excludedUsageTrackers'?: Array<ExcludedUsageTrackerModel>; /** * Gets or sets the disallowed http methods. */ 'disallowedHttpMethods'?: Array<NewScheduledScanApiModel.DisallowedHttpMethodsEnum>; /** * Gets or sets a value indicating whether links should be excluded/included. Default: <see ref=\"bool.True\" /> */ 'excludeLinks'?: boolean; /** * Specifies whether the authentication related pages like login, logout etc. should be excluded from the scan. If form authentication is enabled, exclude authentication pages will be set as true. If you want to scan exclude authentication pages please set as false. */ 'excludeAuthenticationPages'?: boolean; /** * Gets or sets a value indicating whether automatic crawling is enabled. */ 'findAndFollowNewLinks'?: boolean; 'formAuthenticationSettingModel'?: FormAuthenticationSettingModel; 'headerAuthentication'?: HeaderAuthenticationModel; 'sharkSetting'?: SharkModel; /** * Gets or sets the type of the authentication profile option. */ 'authenticationProfileOption'?: NewScheduledScanApiModel.AuthenticationProfileOptionEnum; /** * Gets or sets the type of the authentication profile identifier. */ 'authenticationProfileId'?: string; /** * Gets or sets the imported links. */ 'importedLinks'?: Array<string>; /** * Gets or sets the imported files. If imported files have not contains any URL, the file not added to scan profile. */ 'importedFiles'?: Array<ApiFileModel>; /** * Gets or sets a value indicating whether max scan duration is enabled. This is only used for scheduled group scan and regular group scan. */ 'isMaxScanDurationEnabled'?: boolean; /** * Gets or sets the root path maximum dynamic signatures for heuristic URL Rewrite detection. Default: 60 */ 'maxDynamicSignatures'?: number; /** * Gets or sets the maximum duration of the scan in hours. Default: 48 hours */ 'maxScanDuration'?: number; /** * Gets or sets the scan policy identifier. Default: Default Security Checks */ 'policyId'?: string; /** * Gets or sets the report policy identifier. Default: Default Report Policy */ 'reportPolicyId'?: string; /** * Gets or sets the scan scope. Default: {Invicti.Cloud.Core.Models.ScanTaskScope.EnteredPathAndBelow} */ 'scope'?: NewScheduledScanApiModel.ScopeEnum; /** * Gets or sets the sub path maximum dynamic signatures for heuristic URL Rewrite detection. Default: 30 */ 'subPathMaxDynamicSignatures'?: number; 'timeWindow'?: ScanTimeWindowModel; /** * Gets or sets the extensions that will be analyzed for heuristic URL Rewrite detection. Default: htm,html */ 'urlRewriteAnalyzableExtensions'?: string; /** * Gets or sets the block separators for heuristic URL Rewrite detection. Default: /_ $.,;|: */ 'urlRewriteBlockSeparators'?: string; /** * Gets or sets the URL Rewrite mode. Default: Heuristic */ 'urlRewriteMode'?: NewScheduledScanApiModel.UrlRewriteModeEnum; /** * Gets or sets the URL Rewrite rules. */ 'urlRewriteRules'?: Array<UrlRewriteRuleModel>; 'preRequestScriptSetting'?: PreRequestScriptSettingModel; /** * Gets or sets a value indicating whether http and https protocols are differentiated. */ 'doNotDifferentiateProtocols'?: boolean; /** * Gets or sets the URL rewrite excluded links. */ 'urlRewriteExcludedLinks'?: Array<UrlRewriteExcludedPathModel>; 'oAuth2SettingModel'?: OAuth2SettingApiModel; /** * Defines whether a pci scan task going to be started. */ 'enablePciScanTask'?: boolean; /** * Gets or sets the tags */ 'tags'?: Array<string>; static discriminator: string | undefined = undefined; static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [ { "name": "name", "baseName": "Name", "type": "string" }, { "name": "nextExecutionTime", "baseName": "NextExecutionTime", "type": "string" }, { "name": "scheduleRunType", "baseName": "ScheduleRunType", "type": "NewScheduledScanApiModel.ScheduleRunTypeEnum" }, { "name": "customRecurrence", "baseName": "CustomRecurrence", "type": "ScheduledScanRecurrenceApiModel" }, { "name": "targetUri", "baseName": "TargetUri", "type": "string" }, { "name": "additionalWebsites", "baseName": "AdditionalWebsites", "type": "Array<AdditionalWebsiteModel>" }, { "name": "basicAuthenticationApiModel", "baseName": "BasicAuthenticationApiModel", "type": "BasicAuthenticationSettingModel" }, { "name": "clientCertificateAuthenticationSetting", "baseName": "ClientCertificateAuthenticationSetting", "type": "ClientCertificateAuthenticationApiModel" }, { "name": "cookies", "baseName": "Cookies", "type": "string" }, { "name": "crawlAndAttack", "baseName": "CrawlAndAttack", "type": "boolean" }, { "name": "enableHeuristicChecksInCustomUrlRewrite", "baseName": "EnableHeuristicChecksInCustomUrlRewrite", "type": "boolean" }, { "name": "excludedLinks", "baseName": "ExcludedLinks", "type": "Array<ExcludedLinkModel>" }, { "name": "excludedUsageTrackers", "baseName": "ExcludedUsageTrackers", "type": "Array<ExcludedUsageTrackerModel>" }, { "name": "disallowedHttpMethods", "baseName": "DisallowedHttpMethods", "type": "Array<NewScheduledScanApiModel.DisallowedHttpMethodsEnum>" }, { "name": "excludeLinks", "baseName": "ExcludeLinks", "type": "boolean" }, { "name": "excludeAuthenticationPages", "baseName": "ExcludeAuthenticationPages", "type": "boolean" }, { "name": "findAndFollowNewLinks", "baseName": "FindAndFollowNewLinks", "type": "boolean" }, { "name": "formAuthenticationSettingModel", "baseName": "FormAuthenticationSettingModel", "type": "FormAuthenticationSettingModel" }, { "name": "headerAuthentication", "baseName": "HeaderAuthentication", "type": "HeaderAuthenticationModel" }, { "name": "sharkSetting", "baseName": "SharkSetting", "type": "SharkModel" }, { "name": "authenticationProfileOption", "baseName": "AuthenticationProfileOption", "type": "NewScheduledScanApiModel.AuthenticationProfileOptionEnum" }, { "name": "authenticationProfileId", "baseName": "AuthenticationProfileId", "type": "string" }, { "name": "importedLinks", "baseName": "ImportedLinks", "type": "Array<string>" }, { "name": "importedFiles", "baseName": "ImportedFiles", "type": "Array<ApiFileModel>" }, { "name": "isMaxScanDurationEnabled", "baseName": "IsMaxScanDurationEnabled", "type": "boolean" }, { "name": "maxDynamicSignatures", "baseName": "MaxDynamicSignatures", "type": "number" }, { "name": "maxScanDuration", "baseName": "MaxScanDuration", "type": "number" }, { "name": "policyId", "baseName": "PolicyId", "type": "string" }, { "name": "reportPolicyId", "baseName": "ReportPolicyId", "type": "string" }, { "name": "scope", "baseName": "Scope", "type": "NewScheduledScanApiModel.ScopeEnum" }, { "name": "subPathMaxDynamicSignatures", "baseName": "SubPathMaxDynamicSignatures", "type": "number" }, { "name": "timeWindow", "baseName": "TimeWindow", "type": "ScanTimeWindowModel" }, { "name": "urlRewriteAnalyzableExtensions", "baseName": "UrlRewriteAnalyzableExtensions", "type": "string" }, { "name": "urlRewriteBlockSeparators", "baseName": "UrlRewriteBlockSeparators", "type": "string" }, { "name": "urlRewriteMode", "baseName": "UrlRewriteMode", "type": "NewScheduledScanApiModel.UrlRewriteModeEnum" }, { "name": "urlRewriteRules", "baseName": "UrlRewriteRules", "type": "Array<UrlRewriteRuleModel>" }, { "name": "preRequestScriptSetting", "baseName": "PreRequestScriptSetting", "type": "PreRequestScriptSettingModel" }, { "name": "doNotDifferentiateProtocols", "baseName": "DoNotDifferentiateProtocols", "type": "boolean" }, { "name": "urlRewriteExcludedLinks", "baseName": "UrlRewriteExcludedLinks", "type": "Array<UrlRewriteExcludedPathModel>" }, { "name": "oAuth2SettingModel", "baseName": "OAuth2SettingModel", "type": "OAuth2SettingApiModel" }, { "name": "enablePciScanTask", "baseName": "EnablePciScanTask", "type": "boolean" }, { "name": "tags", "baseName": "Tags", "type": "Array<string>" } ]; static getAttributeTypeMap() { return NewScheduledScanApiModel.attributeTypeMap; } } export namespace NewScheduledScanApiModel { export enum ScheduleRunTypeEnum { Once = <any> 'Once', Daily = <any> 'Daily', Weekly = <any> 'Weekly', Monthly = <any> 'Monthly', Quarterly = <any> 'Quarterly', Biannually = <any> 'Biannually', Yearly = <any> 'Yearly', Custom = <any> 'Custom' } export enum DisallowedHttpMethodsEnum { Get = <any> 'GET', Post = <any> 'POST', Connect = <any> 'CONNECT', Head = <any> 'HEAD', Trace = <any> 'TRACE', Debug = <any> 'DEBUG', Track = <any> 'TRACK', Put = <any> 'PUT', Options = <any> 'OPTIONS', Delete = <any> 'DELETE', Link = <any> 'LINK', Unlink = <any> 'UNLINK', Patch = <any> 'PATCH' } export enum AuthenticationProfileOptionEnum { DontUse = <any> 'DontUse', UseMatchedProfile = <any> 'UseMatchedProfile', SelectedProfile = <any> 'SelectedProfile' } export enum ScopeEnum { EnteredPathAndBelow = <any> 'EnteredPathAndBelow', OnlyEnteredUrl = <any> 'OnlyEnteredUrl', WholeDomain = <any> 'WholeDomain' } export enum UrlRewriteModeEnum { None = <any> 'None', Heuristic = <any> 'Heuristic', Custom = <any> 'Custom' } }