diff --git a/.apigentools-info b/.apigentools-info index 7a024f723bfa0..444cd52e72423 100644 --- a/.apigentools-info +++ b/.apigentools-info @@ -4,13 +4,13 @@ "spec_versions": { "v1": { "apigentools_version": "1.6.6", - "regenerated": "2024-10-28 18:38:56.326868", - "spec_repo_commit": "b4ad1786" + "regenerated": "2024-10-28 21:31:46.602951", + "spec_repo_commit": "fb1c43e3" }, "v2": { "apigentools_version": "1.6.6", - "regenerated": "2024-10-28 18:39:04.239857", - "spec_repo_commit": "b4ad1786" + "regenerated": "2024-10-28 21:31:54.934681", + "spec_repo_commit": "fb1c43e3" } } } \ No newline at end of file diff --git a/content/en/api/v2/sensitive-data-scanner/examples.json b/content/en/api/v2/sensitive-data-scanner/examples.json index 19e17a473fcfc..56162e96911ec 100644 --- a/content/en/api/v2/sensitive-data-scanner/examples.json +++ b/content/en/api/v2/sensitive-data-scanner/examples.json @@ -30,7 +30,8 @@ "keywords": [ "credit card", "cc" - ] + ], + "use_recommended_keywords": false }, "is_enabled": false, "name": "string", @@ -73,7 +74,7 @@ "version": 0 } }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Response data related to the scanning groups.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the Sensitive Data configuration.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the configuration.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the configuration.

\n
\n
\n
\n
\n
\n

groups

\n
\n

object

\n

List of groups, ordered.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

List of groups. The order is important.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the group.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Sensitive Data Scanner group type. \nAllowed enum values: sensitive_data_scanner_group

default: sensitive_data_scanner_group

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Sensitive Data Scanner configuration type. \nAllowed enum values: sensitive_data_scanner_configuration

default: sensitive_data_scanner_configuration

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Included objects from relationships.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

A Scanning Rule included item.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the Sensitive Data Scanner rule.

\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the rule.

\n
\n \n
\n
\n
\n
\n
\n

excluded_namespaces

\n
\n

[string]

\n

Attributes excluded from the scan. If namespaces is provided, it has to be a sub-path of the namespaces array.

\n
\n \n
\n
\n
\n
\n
\n

included_keyword_configuration

\n
\n

object

\n

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

\n
\n
\n
\n
\n
\n

character_count [required]

\n
\n

int64

\n

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

\n
\n \n
\n
\n
\n
\n
\n

keywords [required]

\n
\n

[string]

\n

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

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

is_enabled

\n
\n

boolean

\n

Whether or not the rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the rule.

\n
\n \n
\n
\n
\n
\n
\n

namespaces

\n
\n

[string]

\n

Attributes included in the scan. If namespaces is empty or missing, all attributes except excluded_namespaces are scanned.\nIf both are missing the whole event is scanned.

\n
\n \n
\n
\n
\n
\n
\n

pattern

\n
\n

string

\n

Not included if there is a relationship to a standard pattern.

\n
\n \n
\n
\n
\n
\n
\n

priority

\n
\n

int64

\n

Integer from 1 (high) to 5 (low) indicating rule issue severity.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

List of tags.

\n
\n \n
\n
\n
\n
\n
\n

text_replacement

\n
\n

object

\n

Object describing how the scanned event will be replaced.

\n
\n
\n
\n
\n
\n

number_of_chars

\n
\n

int64

\n

Required if type == 'partial_replacement_from_beginning'\nor 'partial_replacement_from_end'. It must be > 0.

\n
\n \n
\n
\n
\n
\n
\n

replacement_string

\n
\n

string

\n

Required if type == 'replacement_string'.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Type of the replacement text. None means no replacement.\nhash means the data will be stubbed. replacement_string means that\none can chose a text to replace the data. partial_replacement_from_beginning\nallows a user to partially replace the data from the beginning, and\npartial_replacement_from_end on the other hand, allows to replace data from\nthe end. \nAllowed enum values: none,hash,replacement_string,partial_replacement_from_beginning,partial_replacement_from_end

default: none

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the rule.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of a scanning rule.

\n
\n
\n
\n
\n
\n

group

\n
\n

object

\n

A scanning group data.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

A scanning group.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the group.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Sensitive Data Scanner group type. \nAllowed enum values: sensitive_data_scanner_group

default: sensitive_data_scanner_group

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

standard_pattern

\n
\n

object

\n

A standard pattern.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Data containing the standard pattern id.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the standard pattern.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Sensitive Data Scanner standard pattern type. \nAllowed enum values: sensitive_data_scanner_standard_pattern

default: sensitive_data_scanner_standard_pattern

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Sensitive Data Scanner rule type. \nAllowed enum values: sensitive_data_scanner_rule

default: sensitive_data_scanner_rule

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

A Scanning Group included item.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the Sensitive Data Scanner group.

\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the group.

\n
\n \n
\n
\n
\n
\n
\n

filter

\n
\n

object

\n

Filter for the Scanning Group.

\n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query to filter the events.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

is_enabled

\n
\n

boolean

\n

Whether or not the group is enabled.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the group.

\n
\n \n
\n
\n
\n
\n
\n

product_list

\n
\n

[string]

\n

List of products the scanning group applies.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the group.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the group.

\n
\n
\n
\n
\n
\n

configuration

\n
\n

object

\n

A Sensitive Data Scanner configuration data.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

A Sensitive Data Scanner configuration.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the configuration.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Sensitive Data Scanner configuration type. \nAllowed enum values: sensitive_data_scanner_configuration

default: sensitive_data_scanner_configuration

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

rules

\n
\n

object

\n

Rules included in the group.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

Rules included in the group. The order is important.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the rule.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Sensitive Data Scanner rule type. \nAllowed enum values: sensitive_data_scanner_rule

default: sensitive_data_scanner_rule

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Sensitive Data Scanner group type. \nAllowed enum values: sensitive_data_scanner_group

default: sensitive_data_scanner_group

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Meta response containing information about the API.

\n
\n
\n
\n
\n
\n

count_limit

\n
\n

int64

\n

Maximum number of scanning rules allowed for the org.

\n
\n \n
\n
\n
\n
\n
\n

group_count_limit

\n
\n

int64

\n

Maximum number of scanning groups allowed for the org.

\n
\n \n
\n
\n
\n
\n
\n

has_highlight_enabled

\n
\n

boolean

\n

DEPRECATED: (Deprecated) Whether or not scanned events are highlighted in Logs or RUM for the org.

default: true

\n
\n \n
\n
\n
\n
\n
\n

has_multi_pass_enabled

\n
\n

boolean

\n

DEPRECATED: (Deprecated) Whether or not scanned events have multi-pass enabled.

\n
\n \n
\n
\n
\n
\n
\n

is_pci_compliant

\n
\n

boolean

\n

Whether or not the org is compliant to the payment card industry standard.

\n
\n \n
\n
\n
\n
\n
\n

version

\n
\n

int64

\n

Version of the API.

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Response data related to the scanning groups.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the Sensitive Data configuration.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the configuration.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the configuration.

\n
\n
\n
\n
\n
\n

groups

\n
\n

object

\n

List of groups, ordered.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

List of groups. The order is important.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the group.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Sensitive Data Scanner group type. \nAllowed enum values: sensitive_data_scanner_group

default: sensitive_data_scanner_group

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Sensitive Data Scanner configuration type. \nAllowed enum values: sensitive_data_scanner_configuration

default: sensitive_data_scanner_configuration

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Included objects from relationships.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

A Scanning Rule included item.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the Sensitive Data Scanner rule.

\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the rule.

\n
\n \n
\n
\n
\n
\n
\n

excluded_namespaces

\n
\n

[string]

\n

Attributes excluded from the scan. If namespaces is provided, it has to be a sub-path of the namespaces array.

\n
\n \n
\n
\n
\n
\n
\n

included_keyword_configuration

\n
\n

object

\n

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

\n
\n
\n
\n
\n
\n

character_count [required]

\n
\n

int64

\n

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

\n
\n \n
\n
\n
\n
\n
\n

keywords [required]

\n
\n

[string]

\n

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

\n
\n \n
\n
\n
\n
\n
\n

use_recommended_keywords

\n
\n

boolean

\n

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

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

is_enabled

\n
\n

boolean

\n

Whether or not the rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the rule.

\n
\n \n
\n
\n
\n
\n
\n

namespaces

\n
\n

[string]

\n

Attributes included in the scan. If namespaces is empty or missing, all attributes except excluded_namespaces are scanned.\nIf both are missing the whole event is scanned.

\n
\n \n
\n
\n
\n
\n
\n

pattern

\n
\n

string

\n

Not included if there is a relationship to a standard pattern.

\n
\n \n
\n
\n
\n
\n
\n

priority

\n
\n

int64

\n

Integer from 1 (high) to 5 (low) indicating rule issue severity.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

List of tags.

\n
\n \n
\n
\n
\n
\n
\n

text_replacement

\n
\n

object

\n

Object describing how the scanned event will be replaced.

\n
\n
\n
\n
\n
\n

number_of_chars

\n
\n

int64

\n

Required if type == 'partial_replacement_from_beginning'\nor 'partial_replacement_from_end'. It must be > 0.

\n
\n \n
\n
\n
\n
\n
\n

replacement_string

\n
\n

string

\n

Required if type == 'replacement_string'.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Type of the replacement text. None means no replacement.\nhash means the data will be stubbed. replacement_string means that\none can chose a text to replace the data. partial_replacement_from_beginning\nallows a user to partially replace the data from the beginning, and\npartial_replacement_from_end on the other hand, allows to replace data from\nthe end. \nAllowed enum values: none,hash,replacement_string,partial_replacement_from_beginning,partial_replacement_from_end

default: none

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the rule.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of a scanning rule.

\n
\n
\n
\n
\n
\n

group

\n
\n

object

\n

A scanning group data.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

A scanning group.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the group.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Sensitive Data Scanner group type. \nAllowed enum values: sensitive_data_scanner_group

default: sensitive_data_scanner_group

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

standard_pattern

\n
\n

object

\n

A standard pattern.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Data containing the standard pattern id.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the standard pattern.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Sensitive Data Scanner standard pattern type. \nAllowed enum values: sensitive_data_scanner_standard_pattern

default: sensitive_data_scanner_standard_pattern

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Sensitive Data Scanner rule type. \nAllowed enum values: sensitive_data_scanner_rule

default: sensitive_data_scanner_rule

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

A Scanning Group included item.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the Sensitive Data Scanner group.

\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the group.

\n
\n \n
\n
\n
\n
\n
\n

filter

\n
\n

object

\n

Filter for the Scanning Group.

\n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query to filter the events.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

is_enabled

\n
\n

boolean

\n

Whether or not the group is enabled.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the group.

\n
\n \n
\n
\n
\n
\n
\n

product_list

\n
\n

[string]

\n

List of products the scanning group applies.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the group.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the group.

\n
\n
\n
\n
\n
\n

configuration

\n
\n

object

\n

A Sensitive Data Scanner configuration data.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

A Sensitive Data Scanner configuration.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the configuration.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Sensitive Data Scanner configuration type. \nAllowed enum values: sensitive_data_scanner_configuration

default: sensitive_data_scanner_configuration

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

rules

\n
\n

object

\n

Rules included in the group.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

Rules included in the group. The order is important.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the rule.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Sensitive Data Scanner rule type. \nAllowed enum values: sensitive_data_scanner_rule

default: sensitive_data_scanner_rule

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Sensitive Data Scanner group type. \nAllowed enum values: sensitive_data_scanner_group

default: sensitive_data_scanner_group

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Meta response containing information about the API.

\n
\n
\n
\n
\n
\n

count_limit

\n
\n

int64

\n

Maximum number of scanning rules allowed for the org.

\n
\n \n
\n
\n
\n
\n
\n

group_count_limit

\n
\n

int64

\n

Maximum number of scanning groups allowed for the org.

\n
\n \n
\n
\n
\n
\n
\n

has_highlight_enabled

\n
\n

boolean

\n

DEPRECATED: (Deprecated) Whether or not scanned events are highlighted in Logs or RUM for the org.

default: true

\n
\n \n
\n
\n
\n
\n
\n

has_multi_pass_enabled

\n
\n

boolean

\n

DEPRECATED: (Deprecated) Whether or not scanned events have multi-pass enabled.

\n
\n \n
\n
\n
\n
\n
\n

is_pci_compliant

\n
\n

boolean

\n

Whether or not the org is compliant to the payment card industry standard.

\n
\n \n
\n
\n
\n
\n
\n

version

\n
\n

int64

\n

Version of the API.

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -435,7 +436,8 @@ "keywords": [ "credit card", "cc" - ] + ], + "use_recommended_keywords": false }, "is_enabled": false, "name": "string", @@ -472,7 +474,7 @@ "version": 0 } }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Response data related to the creation of a rule.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the Sensitive Data Scanner rule.

\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the rule.

\n
\n \n
\n
\n
\n
\n
\n

excluded_namespaces

\n
\n

[string]

\n

Attributes excluded from the scan. If namespaces is provided, it has to be a sub-path of the namespaces array.

\n
\n \n
\n
\n
\n
\n
\n

included_keyword_configuration

\n
\n

object

\n

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

\n
\n
\n
\n
\n
\n

character_count [required]

\n
\n

int64

\n

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

\n
\n \n
\n
\n
\n
\n
\n

keywords [required]

\n
\n

[string]

\n

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

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

is_enabled

\n
\n

boolean

\n

Whether or not the rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the rule.

\n
\n \n
\n
\n
\n
\n
\n

namespaces

\n
\n

[string]

\n

Attributes included in the scan. If namespaces is empty or missing, all attributes except excluded_namespaces are scanned.\nIf both are missing the whole event is scanned.

\n
\n \n
\n
\n
\n
\n
\n

pattern

\n
\n

string

\n

Not included if there is a relationship to a standard pattern.

\n
\n \n
\n
\n
\n
\n
\n

priority

\n
\n

int64

\n

Integer from 1 (high) to 5 (low) indicating rule issue severity.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

List of tags.

\n
\n \n
\n
\n
\n
\n
\n

text_replacement

\n
\n

object

\n

Object describing how the scanned event will be replaced.

\n
\n
\n
\n
\n
\n

number_of_chars

\n
\n

int64

\n

Required if type == 'partial_replacement_from_beginning'\nor 'partial_replacement_from_end'. It must be > 0.

\n
\n \n
\n
\n
\n
\n
\n

replacement_string

\n
\n

string

\n

Required if type == 'replacement_string'.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Type of the replacement text. None means no replacement.\nhash means the data will be stubbed. replacement_string means that\none can chose a text to replace the data. partial_replacement_from_beginning\nallows a user to partially replace the data from the beginning, and\npartial_replacement_from_end on the other hand, allows to replace data from\nthe end. \nAllowed enum values: none,hash,replacement_string,partial_replacement_from_beginning,partial_replacement_from_end

default: none

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the rule.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of a scanning rule.

\n
\n
\n
\n
\n
\n

group

\n
\n

object

\n

A scanning group data.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

A scanning group.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the group.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Sensitive Data Scanner group type. \nAllowed enum values: sensitive_data_scanner_group

default: sensitive_data_scanner_group

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

standard_pattern

\n
\n

object

\n

A standard pattern.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Data containing the standard pattern id.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the standard pattern.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Sensitive Data Scanner standard pattern type. \nAllowed enum values: sensitive_data_scanner_standard_pattern

default: sensitive_data_scanner_standard_pattern

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Sensitive Data Scanner rule type. \nAllowed enum values: sensitive_data_scanner_rule

default: sensitive_data_scanner_rule

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Meta payload containing information about the API.

\n
\n
\n
\n
\n
\n

version

\n
\n

int64

\n

Version of the API (optional).

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Response data related to the creation of a rule.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the Sensitive Data Scanner rule.

\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the rule.

\n
\n \n
\n
\n
\n
\n
\n

excluded_namespaces

\n
\n

[string]

\n

Attributes excluded from the scan. If namespaces is provided, it has to be a sub-path of the namespaces array.

\n
\n \n
\n
\n
\n
\n
\n

included_keyword_configuration

\n
\n

object

\n

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

\n
\n
\n
\n
\n
\n

character_count [required]

\n
\n

int64

\n

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

\n
\n \n
\n
\n
\n
\n
\n

keywords [required]

\n
\n

[string]

\n

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

\n
\n \n
\n
\n
\n
\n
\n

use_recommended_keywords

\n
\n

boolean

\n

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

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

is_enabled

\n
\n

boolean

\n

Whether or not the rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the rule.

\n
\n \n
\n
\n
\n
\n
\n

namespaces

\n
\n

[string]

\n

Attributes included in the scan. If namespaces is empty or missing, all attributes except excluded_namespaces are scanned.\nIf both are missing the whole event is scanned.

\n
\n \n
\n
\n
\n
\n
\n

pattern

\n
\n

string

\n

Not included if there is a relationship to a standard pattern.

\n
\n \n
\n
\n
\n
\n
\n

priority

\n
\n

int64

\n

Integer from 1 (high) to 5 (low) indicating rule issue severity.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

List of tags.

\n
\n \n
\n
\n
\n
\n
\n

text_replacement

\n
\n

object

\n

Object describing how the scanned event will be replaced.

\n
\n
\n
\n
\n
\n

number_of_chars

\n
\n

int64

\n

Required if type == 'partial_replacement_from_beginning'\nor 'partial_replacement_from_end'. It must be > 0.

\n
\n \n
\n
\n
\n
\n
\n

replacement_string

\n
\n

string

\n

Required if type == 'replacement_string'.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Type of the replacement text. None means no replacement.\nhash means the data will be stubbed. replacement_string means that\none can chose a text to replace the data. partial_replacement_from_beginning\nallows a user to partially replace the data from the beginning, and\npartial_replacement_from_end on the other hand, allows to replace data from\nthe end. \nAllowed enum values: none,hash,replacement_string,partial_replacement_from_beginning,partial_replacement_from_end

default: none

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the rule.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of a scanning rule.

\n
\n
\n
\n
\n
\n

group

\n
\n

object

\n

A scanning group data.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

A scanning group.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the group.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Sensitive Data Scanner group type. \nAllowed enum values: sensitive_data_scanner_group

default: sensitive_data_scanner_group

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

standard_pattern

\n
\n

object

\n

A standard pattern.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Data containing the standard pattern id.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the standard pattern.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Sensitive Data Scanner standard pattern type. \nAllowed enum values: sensitive_data_scanner_standard_pattern

default: sensitive_data_scanner_standard_pattern

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Sensitive Data Scanner rule type. \nAllowed enum values: sensitive_data_scanner_rule

default: sensitive_data_scanner_rule

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Meta payload containing information about the API.

\n
\n
\n
\n
\n
\n

version

\n
\n

int64

\n

Version of the API (optional).

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -528,7 +530,8 @@ "keywords": [ "credit card", "cc" - ] + ], + "use_recommended_keywords": false }, "is_enabled": false, "name": "string", @@ -564,7 +567,7 @@ "version": 0 } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data related to the creation of a rule.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of the Sensitive Data Scanner rule.

\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the rule.

\n
\n \n
\n
\n
\n
\n
\n

excluded_namespaces

\n
\n

[string]

\n

Attributes excluded from the scan. If namespaces is provided, it has to be a sub-path of the namespaces array.

\n
\n \n
\n
\n
\n
\n
\n

included_keyword_configuration

\n
\n

object

\n

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

\n
\n
\n
\n
\n
\n

character_count [required]

\n
\n

int64

\n

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

\n
\n \n
\n
\n
\n
\n
\n

keywords [required]

\n
\n

[string]

\n

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

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

is_enabled

\n
\n

boolean

\n

Whether or not the rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the rule.

\n
\n \n
\n
\n
\n
\n
\n

namespaces

\n
\n

[string]

\n

Attributes included in the scan. If namespaces is empty or missing, all attributes except excluded_namespaces are scanned.\nIf both are missing the whole event is scanned.

\n
\n \n
\n
\n
\n
\n
\n

pattern

\n
\n

string

\n

Not included if there is a relationship to a standard pattern.

\n
\n \n
\n
\n
\n
\n
\n

priority

\n
\n

int64

\n

Integer from 1 (high) to 5 (low) indicating rule issue severity.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

List of tags.

\n
\n \n
\n
\n
\n
\n
\n

text_replacement

\n
\n

object

\n

Object describing how the scanned event will be replaced.

\n
\n
\n
\n
\n
\n

number_of_chars

\n
\n

int64

\n

Required if type == 'partial_replacement_from_beginning'\nor 'partial_replacement_from_end'. It must be > 0.

\n
\n \n
\n
\n
\n
\n
\n

replacement_string

\n
\n

string

\n

Required if type == 'replacement_string'.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Type of the replacement text. None means no replacement.\nhash means the data will be stubbed. replacement_string means that\none can chose a text to replace the data. partial_replacement_from_beginning\nallows a user to partially replace the data from the beginning, and\npartial_replacement_from_end on the other hand, allows to replace data from\nthe end. \nAllowed enum values: none,hash,replacement_string,partial_replacement_from_beginning,partial_replacement_from_end

default: none

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

relationships [required]

\n
\n

object

\n

Relationships of a scanning rule.

\n
\n
\n
\n
\n
\n

group

\n
\n

object

\n

A scanning group data.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

A scanning group.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the group.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Sensitive Data Scanner group type. \nAllowed enum values: sensitive_data_scanner_group

default: sensitive_data_scanner_group

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

standard_pattern

\n
\n

object

\n

A standard pattern.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Data containing the standard pattern id.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the standard pattern.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Sensitive Data Scanner standard pattern type. \nAllowed enum values: sensitive_data_scanner_standard_pattern

default: sensitive_data_scanner_standard_pattern

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Sensitive Data Scanner rule type. \nAllowed enum values: sensitive_data_scanner_rule

default: sensitive_data_scanner_rule

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

meta [required]

\n
\n

object

\n

Meta payload containing information about the API.

\n
\n
\n
\n
\n
\n

version

\n
\n

int64

\n

Version of the API (optional).

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data related to the creation of a rule.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of the Sensitive Data Scanner rule.

\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the rule.

\n
\n \n
\n
\n
\n
\n
\n

excluded_namespaces

\n
\n

[string]

\n

Attributes excluded from the scan. If namespaces is provided, it has to be a sub-path of the namespaces array.

\n
\n \n
\n
\n
\n
\n
\n

included_keyword_configuration

\n
\n

object

\n

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

\n
\n
\n
\n
\n
\n

character_count [required]

\n
\n

int64

\n

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

\n
\n \n
\n
\n
\n
\n
\n

keywords [required]

\n
\n

[string]

\n

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

\n
\n \n
\n
\n
\n
\n
\n

use_recommended_keywords

\n
\n

boolean

\n

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

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

is_enabled

\n
\n

boolean

\n

Whether or not the rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the rule.

\n
\n \n
\n
\n
\n
\n
\n

namespaces

\n
\n

[string]

\n

Attributes included in the scan. If namespaces is empty or missing, all attributes except excluded_namespaces are scanned.\nIf both are missing the whole event is scanned.

\n
\n \n
\n
\n
\n
\n
\n

pattern

\n
\n

string

\n

Not included if there is a relationship to a standard pattern.

\n
\n \n
\n
\n
\n
\n
\n

priority

\n
\n

int64

\n

Integer from 1 (high) to 5 (low) indicating rule issue severity.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

List of tags.

\n
\n \n
\n
\n
\n
\n
\n

text_replacement

\n
\n

object

\n

Object describing how the scanned event will be replaced.

\n
\n
\n
\n
\n
\n

number_of_chars

\n
\n

int64

\n

Required if type == 'partial_replacement_from_beginning'\nor 'partial_replacement_from_end'. It must be > 0.

\n
\n \n
\n
\n
\n
\n
\n

replacement_string

\n
\n

string

\n

Required if type == 'replacement_string'.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Type of the replacement text. None means no replacement.\nhash means the data will be stubbed. replacement_string means that\none can chose a text to replace the data. partial_replacement_from_beginning\nallows a user to partially replace the data from the beginning, and\npartial_replacement_from_end on the other hand, allows to replace data from\nthe end. \nAllowed enum values: none,hash,replacement_string,partial_replacement_from_beginning,partial_replacement_from_end

default: none

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

relationships [required]

\n
\n

object

\n

Relationships of a scanning rule.

\n
\n
\n
\n
\n
\n

group

\n
\n

object

\n

A scanning group data.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

A scanning group.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the group.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Sensitive Data Scanner group type. \nAllowed enum values: sensitive_data_scanner_group

default: sensitive_data_scanner_group

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

standard_pattern

\n
\n

object

\n

A standard pattern.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Data containing the standard pattern id.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the standard pattern.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Sensitive Data Scanner standard pattern type. \nAllowed enum values: sensitive_data_scanner_standard_pattern

default: sensitive_data_scanner_standard_pattern

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Sensitive Data Scanner rule type. \nAllowed enum values: sensitive_data_scanner_rule

default: sensitive_data_scanner_rule

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

meta [required]

\n
\n

object

\n

Meta payload containing information about the API.

\n
\n
\n
\n
\n
\n

version

\n
\n

int64

\n

Version of the API (optional).

\n
\n \n
\n
\n
\n
" } }, "DeleteScanningRule": { @@ -692,7 +695,8 @@ "keywords": [ "credit card", "cc" - ] + ], + "use_recommended_keywords": false }, "is_enabled": false, "name": "string", @@ -729,7 +733,7 @@ "version": 0 } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data related to the update of a rule.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the Sensitive Data Scanner rule.

\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the rule.

\n
\n \n
\n
\n
\n
\n
\n

excluded_namespaces

\n
\n

[string]

\n

Attributes excluded from the scan. If namespaces is provided, it has to be a sub-path of the namespaces array.

\n
\n \n
\n
\n
\n
\n
\n

included_keyword_configuration

\n
\n

object

\n

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

\n
\n
\n
\n
\n
\n

character_count [required]

\n
\n

int64

\n

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

\n
\n \n
\n
\n
\n
\n
\n

keywords [required]

\n
\n

[string]

\n

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

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

is_enabled

\n
\n

boolean

\n

Whether or not the rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the rule.

\n
\n \n
\n
\n
\n
\n
\n

namespaces

\n
\n

[string]

\n

Attributes included in the scan. If namespaces is empty or missing, all attributes except excluded_namespaces are scanned.\nIf both are missing the whole event is scanned.

\n
\n \n
\n
\n
\n
\n
\n

pattern

\n
\n

string

\n

Not included if there is a relationship to a standard pattern.

\n
\n \n
\n
\n
\n
\n
\n

priority

\n
\n

int64

\n

Integer from 1 (high) to 5 (low) indicating rule issue severity.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

List of tags.

\n
\n \n
\n
\n
\n
\n
\n

text_replacement

\n
\n

object

\n

Object describing how the scanned event will be replaced.

\n
\n
\n
\n
\n
\n

number_of_chars

\n
\n

int64

\n

Required if type == 'partial_replacement_from_beginning'\nor 'partial_replacement_from_end'. It must be > 0.

\n
\n \n
\n
\n
\n
\n
\n

replacement_string

\n
\n

string

\n

Required if type == 'replacement_string'.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Type of the replacement text. None means no replacement.\nhash means the data will be stubbed. replacement_string means that\none can chose a text to replace the data. partial_replacement_from_beginning\nallows a user to partially replace the data from the beginning, and\npartial_replacement_from_end on the other hand, allows to replace data from\nthe end. \nAllowed enum values: none,hash,replacement_string,partial_replacement_from_beginning,partial_replacement_from_end

default: none

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the rule.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of a scanning rule.

\n
\n
\n
\n
\n
\n

group

\n
\n

object

\n

A scanning group data.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

A scanning group.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the group.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Sensitive Data Scanner group type. \nAllowed enum values: sensitive_data_scanner_group

default: sensitive_data_scanner_group

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

standard_pattern

\n
\n

object

\n

A standard pattern.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Data containing the standard pattern id.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the standard pattern.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Sensitive Data Scanner standard pattern type. \nAllowed enum values: sensitive_data_scanner_standard_pattern

default: sensitive_data_scanner_standard_pattern

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Sensitive Data Scanner rule type. \nAllowed enum values: sensitive_data_scanner_rule

default: sensitive_data_scanner_rule

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

meta [required]

\n
\n

object

\n

Meta payload containing information about the API.

\n
\n
\n
\n
\n
\n

version

\n
\n

int64

\n

Version of the API (optional).

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data related to the update of a rule.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the Sensitive Data Scanner rule.

\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the rule.

\n
\n \n
\n
\n
\n
\n
\n

excluded_namespaces

\n
\n

[string]

\n

Attributes excluded from the scan. If namespaces is provided, it has to be a sub-path of the namespaces array.

\n
\n \n
\n
\n
\n
\n
\n

included_keyword_configuration

\n
\n

object

\n

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

\n
\n
\n
\n
\n
\n

character_count [required]

\n
\n

int64

\n

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

\n
\n \n
\n
\n
\n
\n
\n

keywords [required]

\n
\n

[string]

\n

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

\n
\n \n
\n
\n
\n
\n
\n

use_recommended_keywords

\n
\n

boolean

\n

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

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

is_enabled

\n
\n

boolean

\n

Whether or not the rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the rule.

\n
\n \n
\n
\n
\n
\n
\n

namespaces

\n
\n

[string]

\n

Attributes included in the scan. If namespaces is empty or missing, all attributes except excluded_namespaces are scanned.\nIf both are missing the whole event is scanned.

\n
\n \n
\n
\n
\n
\n
\n

pattern

\n
\n

string

\n

Not included if there is a relationship to a standard pattern.

\n
\n \n
\n
\n
\n
\n
\n

priority

\n
\n

int64

\n

Integer from 1 (high) to 5 (low) indicating rule issue severity.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

List of tags.

\n
\n \n
\n
\n
\n
\n
\n

text_replacement

\n
\n

object

\n

Object describing how the scanned event will be replaced.

\n
\n
\n
\n
\n
\n

number_of_chars

\n
\n

int64

\n

Required if type == 'partial_replacement_from_beginning'\nor 'partial_replacement_from_end'. It must be > 0.

\n
\n \n
\n
\n
\n
\n
\n

replacement_string

\n
\n

string

\n

Required if type == 'replacement_string'.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Type of the replacement text. None means no replacement.\nhash means the data will be stubbed. replacement_string means that\none can chose a text to replace the data. partial_replacement_from_beginning\nallows a user to partially replace the data from the beginning, and\npartial_replacement_from_end on the other hand, allows to replace data from\nthe end. \nAllowed enum values: none,hash,replacement_string,partial_replacement_from_beginning,partial_replacement_from_end

default: none

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the rule.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of a scanning rule.

\n
\n
\n
\n
\n
\n

group

\n
\n

object

\n

A scanning group data.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

A scanning group.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the group.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Sensitive Data Scanner group type. \nAllowed enum values: sensitive_data_scanner_group

default: sensitive_data_scanner_group

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

standard_pattern

\n
\n

object

\n

A standard pattern.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Data containing the standard pattern id.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the standard pattern.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Sensitive Data Scanner standard pattern type. \nAllowed enum values: sensitive_data_scanner_standard_pattern

default: sensitive_data_scanner_standard_pattern

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Sensitive Data Scanner rule type. \nAllowed enum values: sensitive_data_scanner_rule

default: sensitive_data_scanner_rule

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

meta [required]

\n
\n

object

\n

Meta payload containing information about the API.

\n
\n
\n
\n
\n
\n

version

\n
\n

int64

\n

Version of the API (optional).

\n
\n \n
\n
\n
\n
" } }, "ListStandardPatterns": { diff --git a/data/api/v2/full_spec.yaml b/data/api/v2/full_spec.yaml index 3df7326366dd2..52782bf44a527 100644 --- a/data/api/v2/full_spec.yaml +++ b/data/api/v2/full_spec.yaml @@ -22084,6 +22084,13 @@ components: items: type: string type: array + use_recommended_keywords: + description: '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, then the specified keywords and + character_count will be applied.' + type: boolean required: - keywords - character_count diff --git a/data/api/v2/full_spec_deref.json b/data/api/v2/full_spec_deref.json index bb9fc233df637..ccc097b991e2b 100644 --- a/data/api/v2/full_spec_deref.json +++ b/data/api/v2/full_spec_deref.json @@ -132923,6 +132923,10 @@ "type": "string" }, "type": "array" + }, + "use_recommended_keywords": { + "description": "Should the rule use the underlying standard pattern keyword configuration. If set to true, the rule must be tied\nto a standard pattern. If set to false, then the specified keywords and character_count will be applied.", + "type": "boolean" } }, "required": [ @@ -133158,6 +133162,10 @@ "type": "string" }, "type": "array" + }, + "use_recommended_keywords": { + "description": "Should the rule use the underlying standard pattern keyword configuration. If set to true, the rule must be tied\nto a standard pattern. If set to false, then the specified keywords and character_count will be applied.", + "type": "boolean" } }, "required": [ @@ -133506,6 +133514,10 @@ "type": "string" }, "type": "array" + }, + "use_recommended_keywords": { + "description": "Should the rule use the underlying standard pattern keyword configuration. If set to true, the rule must be tied\nto a standard pattern. If set to false, then the specified keywords and character_count will be applied.", + "type": "boolean" } }, "required": [ @@ -133922,6 +133934,10 @@ "type": "string" }, "type": "array" + }, + "use_recommended_keywords": { + "description": "Should the rule use the underlying standard pattern keyword configuration. If set to true, the rule must be tied\nto a standard pattern. If set to false, then the specified keywords and character_count will be applied.", + "type": "boolean" } }, "required": [ @@ -135508,6 +135524,10 @@ "type": "string" }, "type": "array" + }, + "use_recommended_keywords": { + "description": "Should the rule use the underlying standard pattern keyword configuration. If set to true, the rule must be tied\nto a standard pattern. If set to false, then the specified keywords and character_count will be applied.", + "type": "boolean" } }, "required": [ @@ -135748,6 +135768,10 @@ "type": "string" }, "type": "array" + }, + "use_recommended_keywords": { + "description": "Should the rule use the underlying standard pattern keyword configuration. If set to true, the rule must be tied\nto a standard pattern. If set to false, then the specified keywords and character_count will be applied.", + "type": "boolean" } }, "required": [ @@ -135871,6 +135895,10 @@ "type": "string" }, "type": "array" + }, + "use_recommended_keywords": { + "description": "Should the rule use the underlying standard pattern keyword configuration. If set to true, the rule must be tied\nto a standard pattern. If set to false, then the specified keywords and character_count will be applied.", + "type": "boolean" } }, "required": [ @@ -136079,6 +136107,10 @@ "type": "string" }, "type": "array" + }, + "use_recommended_keywords": { + "description": "Should the rule use the underlying standard pattern keyword configuration. If set to true, the rule must be tied\nto a standard pattern. If set to false, then the specified keywords and character_count will be applied.", + "type": "boolean" } }, "required": [ @@ -136377,6 +136409,10 @@ "type": "string" }, "type": "array" + }, + "use_recommended_keywords": { + "description": "Should the rule use the underlying standard pattern keyword configuration. If set to true, the rule must be tied\nto a standard pattern. If set to false, then the specified keywords and character_count will be applied.", + "type": "boolean" } }, "required": [ @@ -136643,6 +136679,10 @@ "type": "string" }, "type": "array" + }, + "use_recommended_keywords": { + "description": "Should the rule use the underlying standard pattern keyword configuration. If set to true, the rule must be tied\nto a standard pattern. If set to false, then the specified keywords and character_count will be applied.", + "type": "boolean" } }, "required": [ @@ -136859,6 +136899,10 @@ "type": "string" }, "type": "array" + }, + "use_recommended_keywords": { + "description": "Should the rule use the underlying standard pattern keyword configuration. If set to true, the rule must be tied\nto a standard pattern. If set to false, then the specified keywords and character_count will be applied.", + "type": "boolean" } }, "required": [ @@ -137066,6 +137110,10 @@ "type": "string" }, "type": "array" + }, + "use_recommended_keywords": { + "description": "Should the rule use the underlying standard pattern keyword configuration. If set to true, the rule must be tied\nto a standard pattern. If set to false, then the specified keywords and character_count will be applied.", + "type": "boolean" } }, "required": [ @@ -295552,6 +295600,10 @@ "type": "string" }, "type": "array" + }, + "use_recommended_keywords": { + "description": "Should the rule use the underlying standard pattern keyword configuration. If set to true, the rule must be tied\nto a standard pattern. If set to false, then the specified keywords and character_count will be applied.", + "type": "boolean" } }, "required": [ @@ -297297,6 +297349,10 @@ "type": "string" }, "type": "array" + }, + "use_recommended_keywords": { + "description": "Should the rule use the underlying standard pattern keyword configuration. If set to true, the rule must be tied\nto a standard pattern. If set to false, then the specified keywords and character_count will be applied.", + "type": "boolean" } }, "required": [ @@ -297533,6 +297589,10 @@ "type": "string" }, "type": "array" + }, + "use_recommended_keywords": { + "description": "Should the rule use the underlying standard pattern keyword configuration. If set to true, the rule must be tied\nto a standard pattern. If set to false, then the specified keywords and character_count will be applied.", + "type": "boolean" } }, "required": [ @@ -298101,6 +298161,10 @@ "type": "string" }, "type": "array" + }, + "use_recommended_keywords": { + "description": "Should the rule use the underlying standard pattern keyword configuration. If set to true, the rule must be tied\nto a standard pattern. If set to false, then the specified keywords and character_count will be applied.", + "type": "boolean" } }, "required": [ diff --git a/static/resources/json/full_spec_v2.json b/static/resources/json/full_spec_v2.json index bb9fc233df637..ccc097b991e2b 100644 --- a/static/resources/json/full_spec_v2.json +++ b/static/resources/json/full_spec_v2.json @@ -132923,6 +132923,10 @@ "type": "string" }, "type": "array" + }, + "use_recommended_keywords": { + "description": "Should the rule use the underlying standard pattern keyword configuration. If set to true, the rule must be tied\nto a standard pattern. If set to false, then the specified keywords and character_count will be applied.", + "type": "boolean" } }, "required": [ @@ -133158,6 +133162,10 @@ "type": "string" }, "type": "array" + }, + "use_recommended_keywords": { + "description": "Should the rule use the underlying standard pattern keyword configuration. If set to true, the rule must be tied\nto a standard pattern. If set to false, then the specified keywords and character_count will be applied.", + "type": "boolean" } }, "required": [ @@ -133506,6 +133514,10 @@ "type": "string" }, "type": "array" + }, + "use_recommended_keywords": { + "description": "Should the rule use the underlying standard pattern keyword configuration. If set to true, the rule must be tied\nto a standard pattern. If set to false, then the specified keywords and character_count will be applied.", + "type": "boolean" } }, "required": [ @@ -133922,6 +133934,10 @@ "type": "string" }, "type": "array" + }, + "use_recommended_keywords": { + "description": "Should the rule use the underlying standard pattern keyword configuration. If set to true, the rule must be tied\nto a standard pattern. If set to false, then the specified keywords and character_count will be applied.", + "type": "boolean" } }, "required": [ @@ -135508,6 +135524,10 @@ "type": "string" }, "type": "array" + }, + "use_recommended_keywords": { + "description": "Should the rule use the underlying standard pattern keyword configuration. If set to true, the rule must be tied\nto a standard pattern. If set to false, then the specified keywords and character_count will be applied.", + "type": "boolean" } }, "required": [ @@ -135748,6 +135768,10 @@ "type": "string" }, "type": "array" + }, + "use_recommended_keywords": { + "description": "Should the rule use the underlying standard pattern keyword configuration. If set to true, the rule must be tied\nto a standard pattern. If set to false, then the specified keywords and character_count will be applied.", + "type": "boolean" } }, "required": [ @@ -135871,6 +135895,10 @@ "type": "string" }, "type": "array" + }, + "use_recommended_keywords": { + "description": "Should the rule use the underlying standard pattern keyword configuration. If set to true, the rule must be tied\nto a standard pattern. If set to false, then the specified keywords and character_count will be applied.", + "type": "boolean" } }, "required": [ @@ -136079,6 +136107,10 @@ "type": "string" }, "type": "array" + }, + "use_recommended_keywords": { + "description": "Should the rule use the underlying standard pattern keyword configuration. If set to true, the rule must be tied\nto a standard pattern. If set to false, then the specified keywords and character_count will be applied.", + "type": "boolean" } }, "required": [ @@ -136377,6 +136409,10 @@ "type": "string" }, "type": "array" + }, + "use_recommended_keywords": { + "description": "Should the rule use the underlying standard pattern keyword configuration. If set to true, the rule must be tied\nto a standard pattern. If set to false, then the specified keywords and character_count will be applied.", + "type": "boolean" } }, "required": [ @@ -136643,6 +136679,10 @@ "type": "string" }, "type": "array" + }, + "use_recommended_keywords": { + "description": "Should the rule use the underlying standard pattern keyword configuration. If set to true, the rule must be tied\nto a standard pattern. If set to false, then the specified keywords and character_count will be applied.", + "type": "boolean" } }, "required": [ @@ -136859,6 +136899,10 @@ "type": "string" }, "type": "array" + }, + "use_recommended_keywords": { + "description": "Should the rule use the underlying standard pattern keyword configuration. If set to true, the rule must be tied\nto a standard pattern. If set to false, then the specified keywords and character_count will be applied.", + "type": "boolean" } }, "required": [ @@ -137066,6 +137110,10 @@ "type": "string" }, "type": "array" + }, + "use_recommended_keywords": { + "description": "Should the rule use the underlying standard pattern keyword configuration. If set to true, the rule must be tied\nto a standard pattern. If set to false, then the specified keywords and character_count will be applied.", + "type": "boolean" } }, "required": [ @@ -295552,6 +295600,10 @@ "type": "string" }, "type": "array" + }, + "use_recommended_keywords": { + "description": "Should the rule use the underlying standard pattern keyword configuration. If set to true, the rule must be tied\nto a standard pattern. If set to false, then the specified keywords and character_count will be applied.", + "type": "boolean" } }, "required": [ @@ -297297,6 +297349,10 @@ "type": "string" }, "type": "array" + }, + "use_recommended_keywords": { + "description": "Should the rule use the underlying standard pattern keyword configuration. If set to true, the rule must be tied\nto a standard pattern. If set to false, then the specified keywords and character_count will be applied.", + "type": "boolean" } }, "required": [ @@ -297533,6 +297589,10 @@ "type": "string" }, "type": "array" + }, + "use_recommended_keywords": { + "description": "Should the rule use the underlying standard pattern keyword configuration. If set to true, the rule must be tied\nto a standard pattern. If set to false, then the specified keywords and character_count will be applied.", + "type": "boolean" } }, "required": [ @@ -298101,6 +298161,10 @@ "type": "string" }, "type": "array" + }, + "use_recommended_keywords": { + "description": "Should the rule use the underlying standard pattern keyword configuration. If set to true, the rule must be tied\nto a standard pattern. If set to false, then the specified keywords and character_count will be applied.", + "type": "boolean" } }, "required": [