Mask

Parameters

integration

relationship - required

Integration to apply the mask to.

servicerequest

relationship - optional

Service request to apply the mask to. Only used for types of Response.

sequence

integer - required

Order in which to apply the masks for a given input or response.

type

string - required

[Input, Response] - Specifies which inputs to mask. If type is Response, the service request field must be specified.

field

code - optional

Field to apply mask to. Field has the current context of the associated input, response or the current iterable provided by apply_to_each.

Fields can either use dot-notation or bracket notation to access nested elements

#dot notation
a.n
#bracket notation
["a"]

apply_if

boolean - optional

code field that requires a boolean output.

apply_to_each

iterable - optional

code field that should specify an iterable. apply_to_each resolves prior to apply_if. Once an apply_to_each is applied, the field now has the context of the iterable.

abort_if_not_applied_x_times

integer - required

Forces integration to abort if the mask is not applied at least this many times. If set to 0, this field will be not be applied. By default this is set to zero.

notes

Documentation field.

Usage

Masked Parameters hide the incoming response data or input data to prevent sensitive information from being displayed within internal processes.

SSN Masking
123-45-6789 -> XXXXXXXXX

Example:

Input Payload

{
    "people": [
        {
            "name": "Person 1",
            "age": 42,
            "private_info": "mask this"
        },
        {
            "name": "Person 2",
            "age": 22,
            "private_info": "mask this",
            "key:12": {
                "special": true
            }
        }
    ],
    "top:level:colon": true
}

The following masks the top:level:colon, private_info, and special fields special , in that respecitive order.

Field	abort_if_not_applied	type	apply_to_each	apply_if
["top:level:colon"]	1	INPUT
private_info	2	INPUT	people
["key:12"].special	1	INPUT	people	["key:12"]

Example exported JSON for the above masks:

1KB

mask_sample_integration.json