Redact | Node.js SDK

The Pangea Redact API helps developers limit the sprawl of sensitive information by performing redaction using defined rules.

Redact

redact(text: string, options: TextOptions): Promise<PangeaResponse<TextResult>>

Redact sensitive information from provided text.

required parameters

text

string

The text data to redact

optionsRedact.TextOptions

Supported options:

• debug {Boolean} - Setting this value to true will provide a detailed analysis of the redacted data and the rules that caused redaction
• rules {String[]} - An array of redact rule short names
• rulesets {String[]} - An array of redact ruleset short names
• return_result {Boolean} - Setting this value to false will omit the redacted result only returning count

Response Object

TextResult

Promise<PangeaResponse<TextResult>>

const response = await redact.redact(
  "Jenny Jenny... 555-867-5309"
);

Redact structured

redactStructured(data: object, options: StructuredOptions): Promise<PangeaResponse<StructuredResult>>

Redact sensitive information from structured data (e.g., JSON).

required parameters

data

object

Structured data to redact

optionsRedact.StructuredOptions

Supported options:

• debug {Boolean} - Setting this value to true will provide a detailed analysis of the redacted data and the rules that caused redaction
• rules {String[]} - An array of redact rule short names
• rulesets {String[]} - An array of redact ruleset short names
• jsonp {String[]} - JSON path(s) used to identify the specific JSON fields to redact in the structured data. Note: If jsonp parameter is used, the data parameter must be in JSON format.
• format {String} - The format of the structured data to redact. Default: "json"
• return_result {Boolean} - Setting this value to false will omit the redacted result only returning count

Response Object

StructuredResult

Promise<PangeaResponse<StructuredResult>>

const response = await redact.redactStructured({
  "phone": "555-867-5309"
});

Interface Options

Options

optional parameters

debug

boolean

return_result

boolean

rules

Array<string>

rulesets

Array<string>

Interface StructuredOptions

StructuredOptions

optional parameters

debug

boolean

format

string

jsonp

Array<string>

return_result

boolean

rules

Array<string>

rulesets

Array<string>

Interface StructuredParams

StructuredParams

required parameters

data

optional parameters

debug

boolean

format

string

jsonp

Array<string>

return_result

boolean

rules

Array<string>

rulesets

Array<string>

Interface StructuredResult

StructuredResult

required parameters

count

number

optional parameters

redacted_data

object

Interface TextOptions

TextOptions

optional parameters

debug

boolean

return_result

boolean

rules

Array<string>

rulesets

Array<string>

Interface TextParams

TextParams

required parameters

text

string

optional parameters

debug

boolean

return_result

boolean

rules

Array<string>

rulesets

Array<string>

Interface TextResult

TextResult

required parameters

count

number

optional parameters

redacted_text

string