Skip to main content
Version: 3.0

Redact Algorithm

The Redact algorithm redacts strings using the supplied label. By default, the label is repeated so that the masked string is as close to the length original string as possible without exceeding it. The separator string is used to connect multiple copies of the label string.

Algorithm Characteristics​

  • Algorithm: Redact
  • Masking Technique Redaction
  • Supported Types: String
  • Referential Integrity: false (but not useful due to extensive mapping conflicts)
  • Conflict-free: false
  • Realistic Data: false
  • Reversible: false

Properties​

  • label { string; optional; default: "<REDACTED>" }
    The string used to replace the original data value.
    Example: "label": "[REDACTED]"

  • repeat { boolean; optional; default: true }
    If true, then the label is repeated as many times as possible and still be less than or equal to the original string. Example: "label": "[REDACTED]"

  • separator { string; optional; default: "" }
    A string used to connect the multiple copies of the label when the repeat property is true. Example: "separator": "-"

Example JSON configuration​

{
    "name": "ExampleQwertyRedactMasker",
    "description": "Redacts the original string with the repeated string \"QWERTY\" connected by the string "+".",
    "algorithm": "Redact",
    "label": "QWERTY",
    "separator": "+"
}

Default Maskers based on the Redact Algorithm​

  1. RedactMasker