RegexPattern

string

Regex to match to locate the value.

Example

RegexStrategy

object

Strategy using regex pattern to locate content for sanitization.

* Additional properties are NOT allowed.
regexstring(regex)required

Regex to match to locate the value.

Example:\d{4}-\d{4}-\d{4}-\d{4}

Example

BodySanitizationStrategy

Strategy for body content sanitization.

One Of
json_pathstringrequired

JSONPath expression to locate the value.

Example:$.user.email

Example

BodySanitizationRule

object
namestring

Optional identifier for this rule

Example:user-id

strategyOne Of
required

Strategy for body content sanitization.

JsonPathStrategyobject

Strategy using JSONPath expression to locate content for sanitization.

* Additional properties are NOT allowed.
Show Child Parameters
scopearray[string]required

Where the rule applies

Allowed values:requestresponse

Default:request, response

actionstringrequired
  • mask: Replace with “******”

Allowed values:mask

Default:mask

Example

UserDefinedRules

object

User-defined payload sanitization rules

headersarray[object]

Rules for sanitizing HTTP headers

Show Child Parameters
bodyarray[object]

Rules for sanitizing request/response body content

Show Child Parameters
Example