Class SensitiveDataScannerIncludedKeywordConfiguration

Object defining a set of keywords and a number of characters that help reduce noise. You can provide a list of keywords you would like to check within a defined proximity of the matching pattern. If any of the keywords are found within the proximity check, the match is kept. If none are found, the match is discarded.

Hierarchy

  • SensitiveDataScannerIncludedKeywordConfiguration

Constructors

constructor

Properties

additionalProperties? characterCount keywords useRecommendedKeywords?

Constructors

constructor

Properties

Optional additionalProperties

additionalProperties?: {
    [key: string]: any;
}

A container for additional, undeclared properties. This is a holder for any undeclared properties as specified with the 'additionalProperties' keyword in the OAS document.

Type declaration

  • [key: string]: any

characterCount

characterCount: number

The number of characters behind a match detected by Sensitive Data Scanner to look for the keywords defined. character_count should be greater than the maximum length of a keyword defined for a rule.

keywords

keywords: string[]

Keyword list that will be checked during scanning in order to validate a match. The number of keywords in the list must be less than or equal to 30.

Optional useRecommendedKeywords

useRecommendedKeywords?: boolean

Should the rule use the underlying standard pattern keyword configuration. If set to true, the rule must be tied to a standard pattern. If set to false, the specified keywords and character_count are applied.

Settings

Member Visibility

Theme

Generated using TypeDoc