The attributes of a secret detection rule, including its pattern, priority, and validation configuration.

Hierarchy

  • SecretRuleDataAttributes

Constructors

Properties

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
defaultIncludedKeywords?: string[]

A list of keywords that are included by default when scanning for secrets matching this rule.

description?: string

A detailed explanation of what type of secret this rule detects.

license?: string

The license under which this secret rule is distributed.

Configuration for validating whether a detected secret is active by making an HTTP request and inspecting the response.

name?: string

The unique name of the secret detection rule.

pattern?: string

The regular expression pattern used to identify potential secrets in source code or configuration.

priority?: string

The priority level of this rule, used to rank findings when multiple rules match.

sdsId?: string

The identifier of the corresponding Sensitive Data Scanner rule, if one exists.

validators?: string[]

A list of validator identifiers used to further confirm a detected secret is genuine.

Generated using TypeDoc