Data Privacy API

Reference for Data Privacy API

DataPrivacyAPI - anonymize(String input)

Anonymizes input string by applying Data Pattern Anonymization technique using active data patterns configured in Data Discovery plugin.

Table 1. Parameters

Name	Type	Description
input	String	Input String input to anonymized.

Table 2. Returns

Type	Description
String	Serialized JSON string. success Returns true if anonymization was successful inputChanged Returns true if anonymized value is different from input. error Returns error code if an error has occured output If success is true, contains anonymized string.

Code Example

var privacyApi = new SNC.DataPrivacyApi();
var input = 'SSN: 123-45-6789';
var jsonString = privacyApi.anonymize(input);  // activate necessary data patterns first in discovery plugin
var output = JSON.parse(jsonString);

if (output.success) {
   gs.info('anonymized string: ' + output.output);
} else {
  gs.info('anonymization failed: ' + output.error);
}

Table 3. Configuration

Name	Configuration Mode	Description
DataPrivacyApi.anonymize input size	sys_property: data_privacy.api.input.size	System property to define the maximum input size supported by DataPrivacyApi.anonymize calls. , . Default value is 4000 Range is an Integer value between 0-10000
Cache usage by Data Privacy API	sys_property: data_privacy.api.use.cache	System property to define whether DataPrivacyApi should cache the configurations. Default value is true Range is Boolean
Timeout for anonymization API	DataPrivacyApi.setAnonymizeTimeout(long timeoutMillis)	API call to define the maximum time in milliseconds to complete the DataPrivacyAPI.anonymize calls. Default value is 20000(ms) Range is an Integer value between 0-50000 (ms)