Redact | Node.js SDK

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

Redact

constructor(token: PangeaToken, config: PangeaConfig, options: RedactOptions): RedactService

Creates a new RedactService with the given Pangea API token and configuration.

required parameters

tokenPangeaToken

Pangea API token.

configPangeaConfig

Configuration.

optionsRedactOptions

Response Object

RedactService

const config = new PangeaConfig({ domain: "pangea_domain" });
const redact = new RedactService("pangea_token", config);

Redact

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

Redact sensitive information from provided text.

required parameters

text

string

The text data to redact

optionsTextOptions

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
• redaction_method_overrides {RedactionMethodOverrides} - A set of redaction method overrides for any enabled rule. These methods override the config declared methods

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

optionsStructuredOptions

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
• redaction_method_overrides {RedactionMethodOverrides} - A set of redaction method overrides for any enabled rule. These methods override the config declared methods

Response Object

StructuredResult

Promise<PangeaResponse<StructuredResult>>

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

Unredact

unredact(request: UnredactRequest): Promise<PangeaResponse<UnredactResult<O>>>

Decrypt or unredact fpe redactions.

required parameters

requestUnredactRequest

Unredact request data

• redacted_data - Data to unredact
• fpe_context {string} - FPE context used to decrypt and unredact data

Response Object

O

Promise<PangeaResponse<UnredactResult<O>>>

Enum FPEAlphabet

FPEAlphabet

ALPHANUMERIC = "alphanumeric"

ALPHANUMERICLOWER = "alphanumericlower"

NUMERIC = "numeric"

Enum MaskingType

MaskingType

MASK = "mask"

UNMASK = "unmask"

Enum RedactType

RedactType

DETECT_ONLY = "detect_only"

FPE = "fpe"

HASH = "hash"

MASK = "mask"

PARTIAL_MASKING = "partial_masking"

REPLACEMENT = "replacement"

Interface Options

Options

optional parameters

debug

boolean

llm_request

boolean

Is this redact call going to be used in an LLM request?

redaction_method_overridesRedactionMethodOverrides

return_result

boolean

rules

Array<string>

rulesets

Array<string>

vault_parametersVaultParameters

Interface PartialMasking

PartialMasking

optional parameters

chars_to_ignore

Array<string>

masked_from_left

number

masked_from_right

number

masking_char

Array<string>

masking_typeMaskingType

unmasked_from_left

number

unmasked_from_right

number

Interface RedactionMethodOverrides

RedactionMethodOverrides

required parameters

redaction_typeRedactType

optional parameters

fpe_alphabetFPEAlphabet

hash

object

partial_maskingPartialMasking

redaction_value

string

Interface StructuredOptions

StructuredOptions

optional parameters

debug

boolean

format

string

jsonp

Array<string>

llm_request

boolean

Is this redact call going to be used in an LLM request?

redaction_method_overridesRedactionMethodOverrides

return_result

boolean

rules

Array<string>

rulesets

Array<string>

vault_parametersVaultParameters

Interface StructuredParams

StructuredParams

required parameters

dataObject

optional parameters

debug

boolean

format

string

jsonp

Array<string>

llm_request

boolean

Is this redact call going to be used in an LLM request?

redaction_method_overridesRedactionMethodOverrides

return_result

boolean

rules

Array<string>

rulesets

Array<string>

vault_parametersVaultParameters

Interface StructuredResult

StructuredResult

required parameters

count

number

optional parameters

redacted_data

object

Interface TextOptions

TextOptions

optional parameters

debug

boolean

llm_request

boolean

Is this redact call going to be used in an LLM request?

redaction_method_overridesRedactionMethodOverrides

return_result

boolean

rules

Array<string>

rulesets

Array<string>

vault_parametersVaultParameters

Interface TextParams

TextParams

required parameters

text

string

optional parameters

debug

boolean

llm_request

boolean

Is this redact call going to be used in an LLM request?

redaction_method_overridesRedactionMethodOverrides

return_result

boolean

rules

Array<string>

rulesets

Array<string>

vault_parametersVaultParameters

Interface TextResult

TextResult

required parameters

count

number

optional parameters

redacted_text

string

Interface UnredactRequest

UnredactRequest

required parameters

redacted_dataO

optional parameters

fpe_context

string

Interface UnredactResult

UnredactResult

required parameters

dataO

Interface VaultParameters

VaultParameters

optional parameters

fpe_key_id

string

A vault key ID of an exportable key used to redact with FPE instead of using the service config default.

salt_secret_id

string

A vault secret ID of a secret used to salt a hash instead of using the service config default.